|
| 1 | +Autolinker Config File |
| 2 | +====================== |
| 3 | + |
| 4 | +This is the autolinker config file, |
| 5 | +which provides the base defaults for where to link certain terms to. |
| 6 | +You can override these defaults on a per-spec basis by adding a "Link Defaults" metadata entry to your spec, |
| 7 | +or on a per-link basis by specifying `for` and/or `spec` attributes on the link. |
| 8 | +(See the [documentation](https://github.com/tabatkins/css-preprocessor/blob/master/docs/definitions-autolinks.md) for more details.) |
| 9 | + |
| 10 | +As you can see, this config file is also a valid Markdown file. |
| 11 | +It hijacks certain Markdown constructs for its own purposes. |
| 12 | + |
| 13 | +Any second-level heading (written either with a leading/trailing `##` or a line of dashes on the following line) |
| 14 | +must be the versioned shortname of a spec. |
| 15 | + |
| 16 | +Inside each section, bulleted lists give the terms that should default to linking to the given spec. |
| 17 | +This uses the same automatic type detection as the `for=''` attribute on autolinks: |
| 18 | +`<foo>` is a type, `@foo` is an at-rule, `@foo/bar` is a descriptor (the 'bar' descriptor for @foo), and a plain word is a property. |
| 19 | + |
| 20 | +To give default definition targets for any other type of definition, |
| 21 | +you can provide a third-level heading (written with a leading/trailing `###`) |
| 22 | +containing the name of a definition type. |
| 23 | +The terms in the bulleted lists in these subsections do not use auto-detection. |
| 24 | + |
| 25 | +For types that require `for=''` attributes on their definitions, |
| 26 | +you must also provide this information in their heading. |
| 27 | +Just follow the type name with "for foo", |
| 28 | +like `### value for width` or `### method for CSSKeyframeRule`. |
| 29 | + |
| 30 | +Any other Markdown besides these constructs |
| 31 | +(second and third-level headings, bulleted lists) |
| 32 | +will be ignored, and can be used for documentation purposes, |
| 33 | +as this introduction is doing. |
| 34 | + |
| 35 | +Some final notes: |
| 36 | + |
| 37 | +1. There is no need to add everything to this file. This file only needs to be augmented when a definition appears in multiple specs, and there's a single generally correct place that *all* specs should link to. |
| 38 | +2. Please keep the specs in alphabetical order, so it's easier to add to. |
| 39 | +3. If you're augmenting this to fix the spec you're working on, you need to first commit this file to the repo, then update the preprocessor with `preprocess --update` so it picks up the new config file. |
| 40 | + |
| 41 | +css21 |
| 42 | +----- |
| 43 | +* width |
| 44 | +* height |
| 45 | +* line-height |
| 46 | + |
| 47 | +css-align-3 |
| 48 | +----------- |
| 49 | +* align-self |
| 50 | +* align-content |
| 51 | +* align-items |
| 52 | +* justify-self |
| 53 | +* justify-content |
| 54 | +* justify-items |
| 55 | + |
| 56 | +css-backgrounds-4 |
| 57 | +----------------- |
| 58 | +* border-top-width |
| 59 | +* border-left-width |
| 60 | +* border-right-width |
| 61 | +* border-bottom-width |
| 62 | + |
| 63 | +css-break-3 |
| 64 | +----------- |
| 65 | +* break-before |
| 66 | +* orphans |
| 67 | + |
| 68 | +css-color-3 |
| 69 | +----------- |
| 70 | +* <color> |
| 71 | + |
| 72 | +css-content-3 |
| 73 | +------------- |
| 74 | +* content |
| 75 | + |
| 76 | +css-fonts-3 |
| 77 | +----------- |
| 78 | +* font |
| 79 | +* font-family |
| 80 | +* font-size |
| 81 | +* font-style |
| 82 | +* font-variant |
| 83 | +* font-weight |
| 84 | + |
| 85 | +css-images-3 |
| 86 | +------------ |
| 87 | +* <image> |
| 88 | + |
| 89 | +css-lists-3 |
| 90 | +----------- |
| 91 | +* list-style |
| 92 | +* list-style-image |
| 93 | +* list-style-position |
| 94 | +* list-style-type |
| 95 | + |
| 96 | +css-syntax-3 |
| 97 | +------------ |
| 98 | +* <integer> |
| 99 | + |
| 100 | +css-text-3 |
| 101 | +---------- |
| 102 | +* text-align |
| 103 | + |
| 104 | +css-values-3 |
| 105 | +------------ |
| 106 | +* <url> |
| 107 | +* <string> |
| 108 | +* <integer> |
| 109 | +* <number> |
| 110 | +* <percentage> |
| 111 | +* <length> |
| 112 | +* <angle> |
| 113 | +* <resolution> |
| 114 | + |
| 115 | +css-writing-modes-3 |
| 116 | +------------------- |
| 117 | +* direction |
| 118 | +* unicode-bidi |
| 119 | + |
| 120 | + |
| 121 | +Specialized Data |
| 122 | +================ |
| 123 | + |
| 124 | +Below this section are some specialized data sections that use the same constructs as the above, |
| 125 | +but mean something slightly different. |
| 126 | +Each one has slightly different rules. |
| 127 | + |
| 128 | +Ignored Specs |
| 129 | +------------- |
| 130 | + |
| 131 | +List in this section specs which should be removed from lists when there's a conflict - |
| 132 | +they'll only be linked to when you specify it explicitly, |
| 133 | +or they're the sole definition of the term. |
| 134 | + |
| 135 | +* css-box-3 |
| 136 | +* css-text-4 |
| 137 | +* css-inline-3 |
| 138 | +* css-page-4 |
| 139 | +* css-template-1 |
| 140 | +* css1 |
| 141 | + |
| 142 | +CSS 2.1 Replacements |
| 143 | +-------------------- |
| 144 | + |
| 145 | +List in here specs which are fully replacing 2.1 - |
| 146 | +if there's a conflict, and one of these specs are in the list, |
| 147 | +2.1 will be removed from the list. |
| 148 | +Just list the earliest version of each module that fully replaces 2.1. |
| 149 | + |
| 150 | +* css-backgrounds-3 |
| 151 | +* css-break-3 |
| 152 | +* css-color-3 |
| 153 | +* css-display-3 |
| 154 | +* css-fonts-3 |
| 155 | +* css-images-3 |
| 156 | +* css-lists-3 |
| 157 | +* css-overflow-3 |
| 158 | +* css-position-3 |
| 159 | +* css-syntax-3 |
| 160 | +* css-text-3 |
| 161 | +* css-text-decor-3 |
| 162 | +* css-ui-3 |
| 163 | +* css-writing-modes-3 |
0 commit comments