The Language Enablement framework uses labels to automate various processes. This document describes available labels, and how they should be used.
The i18n WG also tracks discussions of interest, or discussions brought to their attention by other WGs. This tracking is enabled by applying the i18n-tracker label to an issue in the other WG repo, and creating a tracker issue in the i18n-activity repo. Instructions for handling that are found on another page, under the heading Keeping tracker issues up to date.
Question
The question label should be attached to every GitHub issue that asks a question of the expert community about how a script works.
Gap
The gap label indicates that the issue contains content for a gap-analysis document. The first comment field in the document contains the actual content that will be pulled into the document when it is viewed or published.
When using this label, you need to also use the following:
- a doc: label
- an i: label
- a p: label
Doc: labels
doc: labels indicate which gap-analysis document a gap issue will be pulled into. It is only used with the gap label. Some repositories contain more than one gap-analysis document, so this is essential information.
Other repositories may only contain a single gap-analysis document, but they will still need one of these labels so that the overal process remains standard and scripting is kept simple. It also provides some insurance against the possibility of another gap-analysis document being added to the repo at a later date.
P: labels
The p: label indicates the priority of a gap-analysis issue. It is only used with the gap label. It is likely to change according to the current status of the issue.
There are 4 possible values, each with a different colour: p:ok, p:basic, p:advanced, and p:broken.
X: labels
The x: label indicates browser engines or W3C technologies affected by a particular gap-analysis issue. It is only used with the gap label. These labels should be applied to all gap labelled issues if the technology doesn't resolve the gap. This provides a simple way of filtering the issues in the LE pipeline by technology.
I: labels
If you use a gap label, you must also use one of these labels. They indicate the section into which the gap-analysis content will be put. The values correspond to sections in the Language Enablement Index, which are the same as those in the gap-analysis documents.
However, it is also recommended that you use these labels with all other technical issues. That makes it possible to filter on a particular type of feature all the issues in the repo.
The values are as follows. The label is shown, followed by the current title of the sections in the LE Index and the LReq pages (which may change over time).
Text direction
i:vertical_text Vertical text
i:bidi_text Bidirectional text
Glyph shaping & positioning
i:fonts #fonts, Fonts & font styles
i:glyphs Context-based shaping & positioning
i:cursive Cursive text
i:letterforms Letterform slopes, weights, & italics.
i:transforms Transforming characters
Typographic units
i:encoding Characters & encoding
i:segmentation Grapheme/word segmentation & selection
Punctuation & inline features
i:punctuation_etc Phrase & section boundaries
i:quotations Quotations & citations
i:emphasis Emphasis & highlighting
i:abbrev Abbreviation, ellipsis, & repetition
i:inline_notes Inline notes & annotations
i:text_decoration Other inline features
i:data_formats Data formats & numbers
Line & paragraph layout
i:line_breaking Line breaking
i:hyphenation Hyphenation (this should always be in addition to i:line_breaking!)
i:justification Text alignment & justification
i:spacing Text spacing
i:baselines Baselines, line height, etc.
i:lists Lists, counters, etc.
i:initials Styling initials
Page & book layout
i:page_layout General page layout & progression
i:grids Grids & tables.
i:footnotes_etc Footnotes, endnotes, etc.
i:headers_footers Page headers, footers, etc.
i:interaction Forms & user interaction
l: labels
These l: labels indicate the language(s) that are relevant to the issue thread. They can be used to filter the issues for a particular language.
A repository that only works on a single language may not use this label.
It's recommended to add this label to all technical discussions.
Useful-discussion
The useful-discussion label can be added to a technical discussion that contains useful information, pictures, example, etc. It is especially useful if not all that information will find its way into a document, since the Language Enablement Index points to useful discussion threads.