TOC for techniques doc

Chaps,

I thought it would be useful to make a very rough and ready attack at
the table of contents we might expect to see for our techniques
document(s).  I think it will be useful to help us attack from the top
down as well as the bottom up.  It will also serve as a roadmap, for us
to measure progress. I'll transfer this to an HTML document when I get a
moment, and we can regularly update it to show our current thinking.  To
make my life easier, I assumed that the audience was 'authors' in the
HTML spec sense.


One issue I'm throwing around in my head is whether or not we should
have separate HTML and CSS docs.  Someone writing HTML docs might
appreciate a fairly tight coupling of the two.  Of course, CSS is not
only used for HTML, so it makes sense to keep things separate too, I
guess.  Perhaps the knowledge should reside in two separate documents,
but we could have an 'overlay' as a navigation aid that unifies the two
in the case of HTML - and perhaps others would unify CSS with other
things like XML or XSL.

Here are two separate toc's.  They are intended to serve only as a stake
in the ground.



========================================
HTML TOC
========================================

[HTML doc is about structure & content - presentation aspects should be
referred to CSS doc]

Document structure & metadata
	Creating an internationalised page header
	Using link elements
	International layout considerations

Navigation
	Navigating to the right localised web site
	Implementing international contact pages
	
Character sets & encodings
	Choosing an encoding
	Specifying the character encoding
	Referring to specific characters
	Dealing with undisplayable characters

Language declarations
	Specifying the language of the whole page
	Labelling text in a different language
	Specifying the language of pages linked to from the current page
	Specifying language codes

Text markup
	Emphasis
	Acronyms & abbreviations
	Quotations
	Ruby

Implementing bidirectional text
	Setting directionality for an entire document
	Changing the directional properties of a part of the text
	Overriding the Unicode bidirectional algorithm
	Using mirrored characters
	Directional bias in graphics

Lists
	Language specific bullets

Tables
	Mirroring tables in bidirectional text

Links
	Including encoding and language information in links
	Keyboard access to links

Objects
	Determining the runtime locale for an object
	Dealing with embedded objects with different encodings

Images
	Creating culturally appropriate graphics
	Using text in graphics
	Using colour
	Dealing with directional bias in graphics
	Supplying graphics to the localisation group

Multimedia
	Animation
	Voice
	Music
	Creating culturally appropriate multimedia objects

Forms
	Keyboard access to forms
	Creating culturally appropriate forms
	Graphical buttons
	Dealing with character sets & encodings

Keyboard shortcuts

Writing source text
	Text fragmentation and re-use
	Ordering text
	Writing clear, understandable text
	Using metaphors, examples and humour
	Using abbreviations & acronyms
	Applying visual style conventions
	Use of PRE text
	
Handling elements that vary by locale
	Numbers, dates, time, currency, measurements, addresses,
telephone numbers,  personal names, paper sizes...

Supplying data for localisation


[There's a bunch of things that could also be said about client-side
scripting - should we say  them here?]





========================================
CSS TOC
========================================


[CSS is about presentation - structure and content information should be
in HTML doc]

Document structure & metadata
	International layout considerations
	Specifying the encoding of a css stylesheet

Language variants
	Specifying styles based on language
	Specifying language codes

Fonts & line height
	Font embedding & selection
	Font characteristics
	Font matching
	Setting font size
	Setting line height & inter-line spacing

Implementing bidirectional text & layout
	Setting directionality for an entire document
	Changing the directional properties of a part of the text
	Overriding the Unicode bidirectional algorithm
	Using mirrored characters

Implementing vertical text

Lists
	Language specific bullets
	Ordering text

Tables
	Mirroring tables in bidirectional text

International aspects of CSS styling
	Font specification
	Font decoration
	Writing mode and text direction
	Text alignment and justification
	Indentation
	Line breaking
	White space control and text overflow
	Text spacing
	Text decoration
	Document grids
	Capitalization
	Text-combine
	Line stacking
	Baseline alignment
	[i'm definitely not happy with this section - should be much
more organised by task]

Ruby

========================================

Builds welcome!
RI



============
Richard Ishida
W3C

tel: +44 1753 480 292
http://www.w3.org/International/
http://www.w3.org/People/Ishida/

Received on Wednesday, 8 January 2003 12:46:12 UTC