|
| 1 | +************** |
| 2 | +Global structure |
| 3 | +*************** |
| 4 | +* Each .src document should contain head, body, title, and link tags |
| 5 | + to the next .src file to be printed. |
| 6 | + |
| 7 | + |
| 8 | +* The TOC and Indexes will be generated by the magic scripts of ALH. |
| 9 | + |
| 10 | +* It's ok to use <TABLE>. |
| 11 | + |
| 12 | +* It's ok to include GIF files in the spec. |
| 13 | + |
| 14 | +************ |
| 15 | +To suppress page numbers in generated PS: |
| 16 | +************ |
| 17 | + |
| 18 | +(1) Use Arnaud's patched html2ps |
| 19 | +(2) Add class="noxref" to your link. |
| 20 | + |
| 21 | +************ |
| 22 | +TABLE OF CONTENTS |
| 23 | +************ |
| 24 | +The toc will be generated from H? markup. Headers should not |
| 25 | +contain anchors unless those anchors follow a ":". For |
| 26 | +example the following is ok: |
| 27 | + |
| 28 | +<h3>Margin properties: <a href="...">, <a href="...></h3> |
| 29 | + |
| 30 | +And "Margin properties" will be replaced by an anchor whose content |
| 31 | +is "Margin properties" and a heading number. |
| 32 | + |
| 33 | +************ |
| 34 | +Properties |
| 35 | +************ |
| 36 | +The following line in the source file: |
| 37 | + |
| 38 | + <!-- #include src=properties/propname.srb --> |
| 39 | + |
| 40 | +(1) Will generate a property definition based on the definition |
| 41 | + in properties/properties.db and the output of bin/pextr. |
| 42 | + [Analogous for descriptors]. |
| 43 | + |
| 44 | +(2) Will generate an entry in the properties index [TO BE DONE]. |
| 45 | + |
| 46 | + |
| 47 | +Note: To get the property name in the TOC, it must be put in a |
| 48 | + header. |
| 49 | + |
| 50 | + |
| 51 | +* To mark up a property instance so that it will generate |
| 52 | + a link to its definition, write: |
| 53 | + |
| 54 | + <span class="propinst-propname">'propname'</span> |
| 55 | + |
| 56 | +* You cannot put any <span>s inside the <span> around the property |
| 57 | + instance. |
| 58 | + |
| 59 | +* html2ps will normally indicate the generated link by inserting a |
| 60 | + page number after it. To suppress that, add "noxref": |
| 61 | + |
| 62 | + <span class="propinst-propname noxref">'propname'</span> |
| 63 | + |
| 64 | + (The way this works is that the addlinks script copies the "noxref" |
| 65 | + to the <a> tag it generates, and html2ps looks at that <a> tag.) |
| 66 | + |
| 67 | + |
| 68 | +************ |
| 69 | +Value types |
| 70 | +************ |
| 71 | +There are three types of value types: |
| 72 | +(1) Key words |
| 73 | +(2) Basic |
| 74 | +(3) Other |
| 75 | + |
| 76 | +Each Value specification in a property definition will include |
| 77 | +some combination of these three. |
| 78 | + |
| 79 | + - Basic values will be delimited by single < marks. (E.g., <length>) |
| 80 | + and will link to their definitions in syndata.src |
| 81 | + |
| 82 | + - Other values will be defined below the property definition. They |
| 83 | + will be indicated by single < marks *and* |
| 84 | + by <em>. They will link to their definitions. |
| 85 | + |
| 86 | +MarkUp all value definitions with: |
| 87 | + |
| 88 | + <span class="index-def" title="value, definition of"> |
| 89 | + <a name="value-def-value" class="value-def"><b>value</b></a> |
| 90 | + </span> |
| 91 | + |
| 92 | +* You cannot put any <span>s |
| 93 | + inside the <span> around the value definition. |
| 94 | + |
| 95 | +Note that the name attribute is first. |
| 96 | + |
| 97 | +MarkUp all value instances with: |
| 98 | + |
| 99 | + <span class="index-inst" title="value"> |
| 100 | + <span class="value-inst-value">value</span> |
| 101 | + </span> |
| 102 | + |
| 103 | +* You cannot put any <span>s |
| 104 | + inside the <span> around the value instance. |
| 105 | + |
| 106 | +The "value" in the text may be marked up (e.g., <value>) |
| 107 | + |
| 108 | +This will generate the same thing with an A element around the inner |
| 109 | +span: |
| 110 | + |
| 111 | + <a href="..." class="value-inst"> |
| 112 | + <span class="value-inst-value">value</span> |
| 113 | + </a> |
| 114 | + |
| 115 | +* html2ps will normally indicate the generated link by inserting a |
| 116 | + page number after it. To suppress that, add "noxref": |
| 117 | + |
| 118 | + <span class="value-inst-value noxref">value</span> |
| 119 | + |
| 120 | +************ |
| 121 | +Indexes |
| 122 | +************ |
| 123 | +* Index markup appears within a <span> element or a <dfn> element. |
| 124 | +* Definitions are marked up with class="index-def" |
| 125 | + [Decided in NYC] The content of index definitions should be |
| 126 | + marked within <em>..</em> |
| 127 | +* Non-definitions are marked up with class="index-inst". |
| 128 | +* The title attribute determines the index keys: |
| 129 | + |
| 130 | + a) title="keyword" produces in the index: |
| 131 | + |
| 132 | + ... |
| 133 | + keyword, n |
| 134 | + ... |
| 135 | + |
| 136 | + where n refers to the nth appearance of that keyword |
| 137 | + in the index. If keyword is a definition, n will be |
| 138 | + rendered specially |
| 139 | + |
| 140 | + b) title="keyword::subkey" produces in the index: |
| 141 | + |
| 142 | + ... |
| 143 | + keyword |
| 144 | + subkey, n |
| 145 | + ... |
| 146 | + |
| 147 | + c) title="keyword1|keyword2" puts both keywords in the index. |
| 148 | + |
| 149 | + |
| 150 | + * You may have as many alternate entries in a span as you want, |
| 151 | + separating all of them with a "|". |
| 152 | + |
| 153 | + * You may only have one level of subkey (i.e., a::b::c is illegal). |
| 154 | + |
| 155 | +For example: |
| 156 | + |
| 157 | + <span class="index-def" title="mydef">mydef text</span> |
| 158 | + <span class="index-def" title="mydef::subpart">mydef text</span> |
| 159 | + <span class="index-def" |
| 160 | + title="mydef::subpart|subpart of mydef">mydef text</span> |
| 161 | + |
| 162 | +* If the title attribute is not set, the span content goes in the |
| 163 | + index (alphabetized) and links to the marked-up source. This |
| 164 | + practice is supported, but discouraged since markup may appear |
| 165 | + in the content. |
| 166 | + |
| 167 | +* This markup is converted into an anchor during processing. However, |
| 168 | + the processor looks to see whether an anchor has already been |
| 169 | + defined within the span and reuses it if it has. Thus, |
| 170 | + |
| 171 | + <span class="index-def" title="mydef"><a name="foo">..</a></span> |
| 172 | + |
| 173 | + will work, as will any markup that generates an anchor |
| 174 | + with "name" set. (the index is processed after the other stuff). |
| 175 | + |
| 176 | +* You may not, however, embed index markup. You don't need to, |
| 177 | + however, since the "|" mechanism allows any number of index |
| 178 | + keys at the same place. |
| 179 | + |
| 180 | +* [TODO] In the printed version, the links are printed as page |
| 181 | +numbers. |
| 182 | + |
| 183 | + |
| 184 | +************ |
| 185 | +Examples |
| 186 | +************ |
| 187 | + |
| 188 | +* In accordance with the HTML spec, use uppercase for |
| 189 | + HTML element names and lowercase for HTML attribute names. |
| 190 | + |
| 191 | +* Markup CSS examples with the classes "example", |
| 192 | +"deprecated-example", "illegal-example". |
| 193 | + |
| 194 | +* Markup HTML examples with the classes "html-example", |
| 195 | +"deprecated-html-example", "illegal-html-example". |
| 196 | + |
| 197 | +* Markup XML examples with the classes "xml-example", |
| 198 | +"deprecated-xml-example", "illegal-xml-example". |
| 199 | + |
| 200 | + |
| 201 | +<div class="example"><P> |
| 202 | +<pre> |
| 203 | +... |
| 204 | +</pre> |
| 205 | +</div> |
| 206 | + |
| 207 | + |
| 208 | +<div class="deprecated-example"><P> |
| 209 | +<span class="example-title">DEPRECATED EXAMPLE:</span><br> |
| 210 | +<pre> |
| 211 | +... |
| 212 | +</pre> |
| 213 | +</div> |
| 214 | + |
| 215 | +<div class="illegal-example"><P> |
| 216 | +<span class="example-title">ILLEGAL EXAMPLE:</span><br> |
| 217 | +<pre> |
| 218 | +... |
| 219 | +</pre> |
| 220 | +</div> |
| 221 | + |
| 222 | +<div class="note"><P> |
| 223 | +<em><strong>Note.</strong> ...</em> |
| 224 | +</div> |
| 225 | + |
| 226 | +* Indentation of examples? [HAKON TODO] |
| 227 | + |
| 228 | +********** |
| 229 | +References |
| 230 | +********** |
| 231 | +* References. *All* references to WWW pages, books, etc. will appear in |
| 232 | +a single file: refs.src. Each reference entry will contain |
| 233 | +an anchor whose name has the prefix "ref-". If the reference is to a |
| 234 | +document online, the URL of the document will be displayed as well |
| 235 | +as linked to (for printing). |
| 236 | + |
| 237 | +References in refs.src should either be marked normative |
| 238 | +or informative and should be specified in the proper section. |
| 239 | + |
| 240 | +A normative reference is marked as class="normref": |
| 241 | + |
| 242 | +<dt><strong><a name="ref-FLEX" class="normref">[FLEX]</a></strong> |
| 243 | +<dd>"Flex: The Lexical Scanner Generator", Version 2.3.7, ISBN 1882114213. |
| 244 | + |
| 245 | +An informative reference is marked as class="informref". |
| 246 | + |
| 247 | +Please put the "name" attribute before the "class" attribute. |
| 248 | + |
| 249 | +All references within the rest of the specification will point to |
| 250 | +the appropriate entry in references.src. These links should have the |
| 251 | +following syntax: |
| 252 | + |
| 253 | + [[SYMBOL]] |
| 254 | +or |
| 255 | + [[-SYMBOL]] |
| 256 | + |
| 257 | +The latter forces the reference to be informative ('informref'). |
| 258 | +This will automatically be expanded to something like: |
| 259 | + |
| 260 | + <a rel="biblioentry" |
| 261 | + href="<path>/ref/references.html#ref-SYMBOL" |
| 262 | + class="informref" |
| 263 | + </a>[SYMBOL]</a> |
| 264 | + |
| 265 | +Note the appearance of class="normref" | class="informref" |
| 266 | +at the end of the anchor start tag. It is possible to |
| 267 | +have an informative link to a normative reference, but you |
| 268 | +should not have a normative link to an informative reference. |
| 269 | + |
| 270 | +You can check to see that links to refs.src are ok with respect |
| 271 | +to normref/informref by running "make checkrefs". |
| 272 | + |
| 273 | +********** |
| 274 | +Document HEAD |
| 275 | +********** |
| 276 | + |
| 277 | +<!DOCTYPE HTML SYSTEM "http://www.w3.org/TR/WD-html40/sgml/HTML4.dtd"> |
| 278 | +<html lang="en"> |
| 279 | +<!-- $Id: CONVENTIONS,v 1.15 1998-05-05 18:01:10 bbos Exp $ --> |
| 280 | +<HEAD> |
| 281 | +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| 282 | +<TITLE>CSS2 Specification</TITLE> |
| 283 | +<!-- *Don't* put next, prev, and stylesheet links, they are automatic --> |
| 284 | +</HEAD> |
| 285 | +<BODY> |
| 286 | +<H1 align="center">CSS2 Specification</H1> |
| 287 | +</BODY> |
| 288 | +</HTML> |
| 289 | + |
| 290 | +********** |
| 291 | +Images |
| 292 | +********** |
| 293 | +Style guidelines from From Bert: |
| 294 | + |
| 295 | + *Choose one font (Helvetica or Helvetica Narrow) |
| 296 | + *Choose three colors (black, white, red) |
| 297 | + *Choose two line thicknesses (1px, 3px) |
| 298 | + *Choose two line styles (solid, dotted) |
| 299 | + *Choose two image sizes (large: as wide as the page, and small: half as |
| 300 | + wide) |
| 301 | + |
| 302 | + *If one of us turns out to be a good cartoonist, we can liven up the |
| 303 | + pictures a bit with one human or animal figure per picture, and maybe |
| 304 | + even one or two free-hand curves, but better not force ourselves |
| 305 | + here. |
| 306 | + |
| 307 | + *Images should be centered (in a <P>) |
| 308 | + |
| 309 | + |
| 310 | +From Chris: |
| 311 | + |
| 312 | + Ian wrote: |
| 313 | + > As I begin to think about replacing ASCII art with |
| 314 | + > images, I would like to raise the following issue: what |
| 315 | + > tools/formats do we use for these images? |
| 316 | + |
| 317 | + Whatever tools are handy and do the job correctly. As to formats, |
| 318 | + bitmapped images should be available in PNG and GIF for paletted images |
| 319 | + and JPEG for suitable 24bit images; we should also retain a lossless master |
| 320 | + image (24bit PNG). If the artwork was generated from a vector format, the |
| 321 | + vector master should also be retained. |
0 commit comments