Mercurial > hg > Papers > 2010 > jsst-shinya

comparison presen/structure-ref.html @ 15:b3b5bcbba089

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add slide: presen/index.html
author Ryoma SHINYA <shinya@firefly.cr.ie.u-ryukyu.ac.jp>
date Sat, 11 Sep 2010 23:46:30 +0900
parents
children
comparison
equal deleted inserted replaced
14:bd07b27b2b97 15:b3b5bcbba089
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
2 "http://www.w3.org/TR/REC-html40/loose.dtd">
3 <html>
4 <head>
5 <title>S5 1.1 Reference</title>
6
7 <style type="text/css" media="all">
8
9 h3 {margin-top: 3em; padding: 0.33em 0.2em 0.1em;
10 border: 1px solid gray; border-width: 1px 0;}
11
12 p code, dd code {color: #333; background: #EEE; padding: 0 0.33em;}
13 pre, code {font: 1em Courier, monospace; letter-spacing: -0.05em;}
14 pre {padding: 0.33em 1em; font-weight: bold; color: #500;}
15 pre.example {color: #333; font-weight: normal;}
16
17
18 pre i, dt i {font-weight: normal; color: #AAA;}
19 p i {color: #666;}
20 p {margin: 1em;}
21
22 dl {margin: 1em 1em 1.5em 2em;}
23 dt {margin-top: 1.5em; font: 1em Courier, monospace;
24 letter-spacing: -0.05em; white-space: pre;}
25 dd {margin: 0.5em 0 0 2.5em;}
26 dl dl {margin: 0.5em 1em 1em 0.5em;}
27 dl dl dt {margin-top: 0.75em;}
28 dl dl dd {margin: 0.25em 0 0 1.5em;}
29
30 pre > span,
31 .optional {color: #337; font-weight: normal;}
32 .recommended {color: #000; font-weight: bold;}
33 .required {color: #500; font-weight: bold;}
34 .generated {color: #666; font-style: italic;}
35
36 dt[class] {border-left: 1em solid; padding-left: 0.66em;}
37 dt.required {border-color: #500; color: #500;}
38 dt.optional {border-color: #77B;}
39 dt.recommended {border-color: gray;}
40 dt.generated {border-color: #CCC;}
41 dt.generated + dd {color: #999;}
42 dt.required + dd:before {content: "Required. "; font-weight: bold;
43 color: #500;}
44 dt.optional + dd:before {content: "Optional. "; font-style: italic;
45 color: #333;}
46 dt.recommended + dd:before {content: "Recommended. ";
47 color: #000; font-weight: bold;}
48 dt.generated + dd:before {content: "[generated] ";
49 color: #666;}
50
51 hr {margin-top: 5em;}
52
53 </style>
54 </head>
55 <body id="www-meyerweb-com" class="tools">
56
57
58
59
60 <h2>S5 1.1 Reference</h2>
61
62 <p>
63 This document provides a full reference to the S5 presentation file format. The following conventions are used:
64 </p>
65
66 <ul>
67 <li>Content <span class="required">styled in this manner</span> indicates something that is required by the S5 1.1 format.</li>
68 <li>Content <span class="recommended">styled in this manner</span> indicates something that is recommended in the S5 1.1 format.</li>
69 <li>Content <span class="optional">styled in this manner</span> indicates something that is optional in the S5 1.1 format.</li>
70 <li>Content <span class="generated">styled in this manner</span> indicates something that is generated by the S5 1.1 JavaScript. These are not provided in the code listings.</li>
71 </ul>
72
73 <p>
74 S5 1.1 is compatible with the <a href="http://my.opera.com/community/dev/operashow/documentation/doc_fileformat.html">Opera Show Format 1.0</a> (hereafter OSF 1.0). It is also capable of conforming to the <a href="http://microformats.org/wiki/xoxo">XOXO microformat</a>.
75 </p>
76 <p>
77 A complete example file can be found at the end of this document.
78 </p>
79
80
81 <h3>Document Skeleton</h3>
82 <pre>
83 &lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
84 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"&gt;
85 &lt;html xmlns="http://www.w3.org/1999/xhtml"&gt;
86
87 &lt;head&gt; &lt;/head&gt;
88
89 &lt;body&gt;
90 &lt;div class="layout"&gt; &lt;/div&gt;
91 &lt;div class="presentation"&gt; &lt;/div&gt;
92 &lt;/body&gt;
93
94 &lt;/html&gt;
95 </pre>
96
97 <p>
98 This is the basic top-level skeleton for an article file. Most of these top-level elements all have descendent elements, which are explained by the rest of this document.
99 </p>
100
101 <dl>
102
103 <dt class="required">&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
104 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"&gt;</dt>
105 <dd>The document type used for S5 slide shows. XHTML 1.0 Strict was chosen to allow compatibility with OSF 1.0.</dd>
106
107 <dt class="required">&lt;html xmlns="http://www.w3.org/1999/xhtml"&gt; &lt;/html&gt;</dt>
108 <dd>The root element of the document, which contains pretty much everything else. Required by the DOCTYPE.</dd>
109
110 <dt class="required">&lt;head&gt; &lt;/head&gt;</dt>
111 <dd>This element contains the header information for the presentation, such as title of the presentation, metadata about the presentation's author, links to style sheets and scripts, and so on.</dd>
112
113 <dt class="required">&lt;body&gt; &lt;/body&gt;</dt>
114 <dd>The actual body of the presentation, containing all of the content and components that will be displayed to the viewer. Not required by the DOCTYPE, but required for S5 compliance.</dd>
115
116 <dt class="required">&lt;div class="layout"&gt; &lt;/div&gt;</dt>
117 <dd>This element contains all of the bits of layout that appear on every slide, including the header and footer and the navigation controls.</dd>
118
119 <dt class="required">&lt;div class="presentation"&gt; &lt;/div&gt;</dt>
120 <dd>A container for all of the individual slides.</dd>
121
122 </dl>
123
124
125 <h3><code>head</code> &mdash; The Document's Metadata</h3>
126 <pre>
127 &lt;head&gt;
128 &lt;title&gt;<i>[slide show title]</i>&lt;/title&gt;
129 &lt;meta name="version" content="S5 1.1" /&gt;
130 <span class="optional">&lt;meta name="generator" content="<i>[generating program]</i>" /&gt;
131 &lt;meta name="presdate" content="<i>[presentation date]</i>" /&gt;
132 &lt;meta name="author" content="<i>[author's name]</i>" /&gt;
133 &lt;meta name="company" content="<i>[author's employer]</i>" /&gt;
134 &lt;meta http-equiv="Content-Type" content="<i>[content-type]</i>" /&gt;
135 &lt;meta name="defaultView" content="<i>[value]</i>" /&gt;
136 &lt;meta name="controlVis" content="<i>[value]</i>" /&gt;</span>
137 &lt;link rel="stylesheet" href="v11b1/slides.css" type="text/css" media="projection" id="slideProj" /&gt;
138 &lt;link rel="stylesheet" href="v11b1/outline.css" type="text/css" media="screen" id="outlineStyle" /&gt;
139 &lt;link rel="stylesheet" href="v11b1/print.css" type="text/css" media="print" id="slidePrint" /&gt;
140 &lt;link rel="stylesheet" href="v11b1/opera.css" type="text/css" media="projection" id="operaFix" /&gt;
141 &lt;script src="ui/slides.js" type="text/javascript"&gt;&lt;/script&gt;
142 &lt;/head&gt;
143 </pre>
144
145 <p>
146 intro
147 </p>
148
149 <dl>
150
151 <dt class="required">&lt;title&gt;<i>[slide show title]</i>&lt;/title&gt;</dt>
152 <dd>Contains the title of the presentation.</dd>
153
154 <dt class="required">&lt;meta name="version" content="S5 1.1" /&gt;</dt>
155 <dd>Provides the exact markup format being used for the presentation file. Copied from OSF 1.0.</dd>
156
157 <dt class="optional">&lt;meta name="generator" content="<i>[generating program]</i>" /&gt;</dt>
158 <dd>Indicates the tool that was used to create the presentation file. If a tool was used, this element is <strong>required</strong>. If the presentation was authored by hand, the value can be set to the author's name or the text editor they used; otherwise, the element can be omitted. Copied from OSF 1.0.</dd>
159
160 <dt class="optional">&lt;meta name="presdate" content="<i>[presentation date]</i>" /&gt;</dt>
161 <dd>The date on which the presentation was (or is to be) delivered. Copied from OSF 1.0.</dd>
162
163 <dt class="optional">&lt;meta name="author" content="<i>[author's name]</i>" /&gt;</dt>
164 <dd>The name of the presentation's primary author. There is currently no ability to designate secondary authors. Copied from OSF 1.0.</dd>
165
166 <dt class="optional">&lt;meta name="company" content="<i>[author's employer]</i>" /&gt;</dt>
167 <dd>The company for which the primary presenter works. This could be more broadly construed to be the author's primary affiliation, whether or not it is a corporate entity. Copied from OSF 1.0.</dd>
168
169 <dt class="optional">&lt;meta http-equiv="Content-Type" content="<i>[content-type]</i>" /&gt;</dt>
170 <dd>Indicates the presentation file's content type. One possible value is <code>application/xhtml+xml;charset=utf-8</code>.</dd>
171
172 <dt class="optional">&lt;meta name="defaultView" content="<i>[value]</i>" /&gt;</dt>
173 <dd>Sets the initial view for the presentation using one of two values: <code>slideshow</code> and <code>outline</code>. The default value is <code>slideshow</code>.</dd>
174
175 <dt class="optional">&lt;meta name="controlVis" content="<i>[value]</i>" /&gt;</dt>
176 <dd>Sets the default presentation of the controls to be either <code>visible</code> or <code>hidden</code>. The default value is <code>visible</code>.</dd>
177
178 <dt class="required">&lt;link rel="stylesheet" href="ui/slides.css" type="text/css" media="projection" id="slideProj" /&gt;</dt>
179 <dd>This links to the CSS that drives the visual presentation of the slide show. The referenced file consists of three <code>@import</code> directives that point to still other style sheets; see the <a href="filemap.html">file map</a> for more details.</dd>
180
181 <dt class="required">&lt;link rel="stylesheet" href="ui/outline.css" type="text/css" media="print" id="outlineStyle" /&gt;</dt>
182 <dd>This links to the style sheet used to present the outline view of the slide show.</dd>
183
184 <dt class="required">&lt;link rel="stylesheet" href="ui/print.css" type="text/css" media="print" id="slidePrint" /&gt;</dt>
185 <dd>This links to the print-medium style sheet, which contains directives that format the presentation for printing.</dd>
186
187 <dt class="required">&lt;link rel="stylesheet" href="ui/opera.css" type="text/css" media="projection" id="operaFix" /&gt;</dt>
188 <dd>This links to the style sheet that allows Opera to run the slide show through Opera Show.</dd>
189
190 <dt class="required">&lt;script src="ui/slides.js" type="text/javascript"&gt;&lt;/script&gt;</dt>
191 <dd>This references the JavaScript file that make the slide show work.</dd>
192
193 </dl>
194
195
196 <h3>Layout Information</h3>
197
198 <pre>
199 &lt;div class="layout"&gt;
200
201 &lt;div id="controls"&gt;&lt;/div&gt;
202 &lt;div id="currentSlide"&gt;&lt;/div&gt;
203 &lt;div id="header"&gt;<i>[any header content]</i>&lt;/div&gt;
204 &lt;div id="footer"&gt;<i>[any footer content]</i>&lt;/div&gt;
205 <span class="optional">&lt;div class="topleft"&gt;<i>[top left layout bit]</i>&lt;/div&gt;
206 &lt;div class="topright"&gt;<i>[top right layout bit]</i>&lt;/div&gt;
207 &lt;div class="bottomleft"&gt;<i>[bottom left layout bit]</i>&lt;/div&gt;
208 &lt;div class="bottomright"&gt;<i>[bottom right layout bit]</i>&lt;/div&gt;</span>
209
210 &lt;/div&gt;
211 </pre>
212
213 <dl>
214
215 <dt class="required">&lt;div id="controls"&gt;&lt;/div&gt;</dt>
216 <dd>
217 This is the structural hook into which the slide navigation controls are filled in by the JavaScript. This includes the popup navigation menu, the forward/backward links, and the "style toggle" link. If no controls are desired, leave the markup in place and suppress its display via CSS, although doing so is <strong>strongly</strong> discouraged. It is strongly recommended that this element be left unfilled, since any content in the XHTML file will be overwritten by the JavaScript.
218 The markup generated by the JavaScript includes a few elements:
219
220 <dl>
221 <dt class="generated">&lt;form id="controlForm"&gt; &lt;/form&gt;</dt>
222 <dd>
223 This element encloses all the of the slide controls. Within it are two <tt>div</tt> elements, each of which contains the actual controls.
224
225 <dl>
226 <dt class="generated">&lt;div id="navLinks"&gt; &lt;/div&gt;</dt>
227 <dd>
228
229 <dl>
230 <dt class="generated">&lt;a id="toggle"&gt;&amp;#216;&lt;/a&gt;</dt>
231 <dd>The link used to switch the slide styles off and on.</dd>
232 <dt class="generated">&lt;a id="prev"&gt;&amp;laquo;&lt;/a&gt;</dt>
233 <dd>The link used to move to the previous slide.</dd>
234 <dt class="generated">&lt;a id="next"&gt;&amp;raquo;&lt;/a&gt;</dt>
235 <dd>The link used to move to the next slide.</dd>
236 </dl>
237
238 </dd>
239 <dt class="generated">&lt;div id="navList"&gt; &lt;/div&gt;</dt>
240 <dd>
241
242 <dl>
243 <dt class="generated">&lt;select id="jumplist"&gt;&lt;/select&gt;</dt>
244 <dd>The foundation of the slide navigation list. The JavaScript generates a number of <tt>option</tt> elements within this <tt>select</tt>.</dd>
245 </dl>
246
247 </dd>
248 </dl>
249
250 </dd>
251
252 <dt class="required">&lt;div id="currentSlide"&gt;&lt;/div&gt;</dt>
253 <dd>This is the structural hook into which the current progress indicator (e.g., "5 / 21") is filled in by the JavaScript. If no progress information is desired, leave the markup in place and suppress its display via CSS. It is strongly recommended that this element be left unfilled, since any content in the XHTML file will be overwritten by the JavaScript.
254 The markup generated by the JavaScript includes three elements:
255
256 <dl>
257 <dt class="generated">&lt;span id="csHere"&gt;<i>[current slide number]</i>&lt;/span&gt;</dt>
258 <dd>The number of the slide currently being displayed.</dd>
259 <dt class="generated">&lt;span id="csSep"&gt;<i>/</i>&lt;/span&gt;</dt>
260 <dd>The separator character between the current slide number and the total slides number; the character currently is a forward slash. A future version of S5 may allow this to be changed by a means other than editing the JavaScript file.</dd>
261 <dt class="generated">&lt;span id="csTotal"&gt;<i>[total slides]</i>&lt;/span&gt;</dt>
262 <dd>The total number of slides in the slide show. This count does not include the first slide in the presentation, which is numbered zero.</dd>
263 </dl>
264
265 </dd>
266
267 <dt class="required">&lt;div id="header"&gt;<i>[any header content]</i>&lt;/div&gt;</dt>
268 <dd>Any header content or effects are placed inside this element. Even if the header has no content, it should remain as an unfilled element.</dd>
269
270 <dt class="required">&lt;div id="footer"&gt; &lt;/div&gt;</dt>
271 <dd>
272 Any footer content or visual effects are placed inside this element.
273 </dd>
274
275 </dl></dd>
276
277 <dt class="optional">&lt;div class="topleft"&gt;<i>[top left layout bit]</i>&lt;/div&gt;
278 &lt;div class="topright"&gt;<i>[top right layout bit]</i>&lt;/div&gt;
279 &lt;div class="bottomleft"&gt;<i>[bottom left layout bit]</i>&lt;/div&gt;
280 &lt;div class="bottomright"&gt;<i>[bottom right layout bit]</i>&lt;/div&gt;</dt>
281 <dd>These elements have a <tt>class</tt> attribute containing a value indicating their layout position, such as <code>&lt;div class="topleft"&gt;</code>. They may also be given an optional <tt>id</tt> attribute that refers to the relevant <tt>meta</tt> element, so editors can determine what information was positioned and use this to their advantage in the editing UI. Copied from OSF 1.0.</dd>
282
283 </dl>
284
285
286 <h3>The Slides</h3>
287
288 <pre>
289 &lt;div class="presentation"&gt;
290
291 &lt;div class="slide"&gt;
292 <span class="recommended">&lt;h1&gt;<i>[slide title]</i>&lt;/h1&gt;</span>
293 <span class="optional">&lt;div class="slidecontent"&gt;</span>
294 <i>[slide content]</i>
295 <span class="optional">&lt;/div&gt;</span>
296 <span class="optional">&lt;div class="handout"&gt;
297 <i>[extra content not displayed in slide show]</i>
298 &lt;/div&gt;</span>
299 &lt;/div&gt;
300
301 &lt;/div&gt;
302 </pre>
303
304 <dl>
305
306 <dt class="required">&lt;div class="slide"&gt; &lt;/div&gt;</dt>
307 <dd>
308 The presentation section of the file contains one or more slides. The contents of each slide are obviously up to the author of the presentation. This element contains a number of descendants.
309
310 <dl>
311
312 <dt class="recommended">&lt;h1&gt;<i>[slide title]</i>&lt;/h1&gt;</dt>
313 <dd>The contents of this element give the title of the individual slide. These contents are collected by the JavaScript and used to build the slide show's navigation menu. If the slide is untitled, it is recommended that an unfilled <tt>h1</tt> element be left in place.</dd>
314
315 <dt class="optional">&lt;div class="slidecontent"&gt; &lt;/div&gt;</dt>
316 <dd>The contents of the slide can optionally be wrapped in this <tt>div</tt>, although a slide can have content without having it placed inside this <tt>div</tt>. Note that while use of this element is optional, having actual content for a slide is highly recommended. The content of the slide can be any valid XHTML markup and content. A common slide would contain an unordered list of five or so talking points.</dd>
317
318 <dt class="optional">&lt;div class="handout"&gt; &lt;/div&gt;</dt>
319 <dd>This is used to enclose any extra information that should be included in the printed version of the presentation, but should not appear in the slide show. The contents can be any valid XHTML markup and content, and there is no restriction on length. As an example, a presentation on CSS might place examples of CSS techniques in one of these <tt>handout</tt> sections.</dd>
320
321 </dl>
322
323 </dd>
324
325 </dl>
326
327
328
329 <h3>Complete Example</h3>
330
331 <pre>
332 &lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
333 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"&gt;
334 &lt;html xmlns="http://www.w3.org/1999/xhtml"&gt;
335 &lt;head&gt;
336 &lt;title&gt;<i>[slide show title]</i>&lt;/title&gt;
337 &lt;meta name="version" content="S5 1.1" /&gt;
338 <span class="optional">&lt;meta name="generator" content="<i>[generating program]</i>" /&gt;
339 &lt;meta name="presdate" content="<i>[presentation date]</i>" /&gt;
340 &lt;meta name="author" content="<i>[author's name]</i>" /&gt;
341 &lt;meta name="company" content="<i>[author's employer]</i>" /&gt;
342 &lt;meta http-equiv="Content-Type" content="<i>[content-type]</i>" /&gt;
343 &lt;meta name="defaultView" content="<i>[value]</i>" /&gt;
344 &lt;meta name="controlVis" content="<i>[value]</i>" /&gt;</span>
345 &lt;link rel="stylesheet" href="v11b1/slides.css" type="text/css" media="projection" id="slideProj" /&gt;
346 &lt;link rel="stylesheet" href="v11b1/outline.css" type="text/css" media="screen" id="outlineStyle" /&gt;
347 &lt;link rel="stylesheet" href="v11b1/print.css" type="text/css" media="print" id="slidePrint" /&gt;
348 &lt;link rel="stylesheet" href="v11b1/opera.css" type="text/css" media="projection" id="operaFix" /&gt;
349 &lt;script src="ui/slides.js" type="text/javascript"&gt;&lt;/script&gt;
350 &lt;/head&gt;
351 &lt;body&gt;
352
353 &lt;div class="layout"&gt;
354
355 &lt;div id="controls"&gt;&lt;/div&gt;
356 &lt;div id="currentSlide"&gt;&lt;/div&gt;
357 &lt;div id="header"&gt;<i>[any header content]</i>&lt;/div&gt;
358 &lt;div id="footer"&gt;<i>[any footer content]</i>&lt;/div&gt;
359 <span class="optional">&lt;div class="topleft"&gt;<i>[top left layout bit]</i>&lt;/div&gt;
360 &lt;div class="topright"&gt;<i>[top right layout bit]</i>&lt;/div&gt;
361 &lt;div class="bottomleft"&gt;<i>[bottom left layout bit]</i>&lt;/div&gt;
362 &lt;div class="bottomright"&gt;<i>[bottom right layout bit]</i>&lt;/div&gt;</span>
363
364 &lt;/div&gt;
365 &lt;div class="presentation"&gt;
366
367 &lt;div class="slide"&gt;
368 <span class="optional">&lt;h1&gt;<i>[slide show title]</i>&lt;/h1&gt;
369 &lt;h2&gt;<i>[slide show subtitle]</i>&lt;/h2&gt;
370 &lt;h3&gt;<i>[author's name]</i>&lt;/h3&gt;
371 &lt;h4&gt;<i>[author's employer]</i>&lt;/h4&gt;</span>
372 &lt;/div&gt;
373
374 &lt;div class="slide"&gt;
375 <span class="recommended">&lt;h1&gt;<i>[slide title]</i>&lt;/h1&gt;</span>
376 <span class="optional">&lt;div class="slidecontent"&gt;</span>
377 <i>[slide content]</i>
378 <span class="optional">&lt;/div&gt;</span>
379 <span class="optional">&lt;div class="handout"&gt;
380 <i>[extra content not displayed in slide show]</i>
381 &lt;/div&gt;</span>
382 &lt;/div&gt;
383
384 &lt;/div&gt;
385
386 &lt;/body&gt;
387 &lt;/html&gt;
388 </pre>
389
390
391
392
393
394 </body>
395 </html>