[tei-council] some formatting thoughts -- reference documentation

Sebastian Rahtz sebastian.rahtz at oucs.ox.ac.uk
Sun Oct 7 07:15:27 EDT 2007


Going back to some stuff Syd wrote a while back:
> * Most importantly (and Julia gets credit for convincing me of this),
>   the reference documentation pages need a "how to read this page"
>   guide.
It seems pretty clear that none of James, Dot or I are going to get this
done in the next 2 weeks. Can we therefore ask you to look at this
whole area and implement it (with help from Julia maybe), Syd?
If not, let's abandon the idea for 1.0. 

Not sure what others feel, but I am fairly clear that after 1st November,
we should freeze the formatting except to fix real bugs, and not continue
to tinker with it. It can have a redesign if and when we produce 1.1


> * If we're going to go with the javascript alphabet-box, we should do
>   so for classes & macros too, no?
>   
done for classes. the classes are also split in two, for attributes and 
models.
I have left macros alone, since there are so few
> * Should we have an appendix that holds all the info that is
>   generated by <moduleSpec> as a gray box mid-prose now? It would
>   list the modules, and for each module all the classes, elements,
>   datatypes, and other macros defined in that module.
>   
this is possible, if desired. James and Dot, say whether or not you want it,
and I'll implement it.

As you can probably tell, I want to start locking things down in the P5 
release
from now onwards....

-- 
Sebastian Rahtz      

Information Manager, Oxford University Computing Services
13 Banbury Road, Oxford OX2 6NN. Phone +44 1865 283431



More information about the tei-council mailing list