[Bf-docboard] less graphics
Stefano Selleri
bf-docboard@blender.org
Thu, 2 Jan 2003 12:44:14 +0100
>
> I would propose to agree on some naming conventions for the IDs. I did
> use something like:
>
> fig:afigure
> chap:achapter
>
Yup,
I tried to give a standard in the StyleGuide...
Was
Labels are a delicate matter inasmuch they must be unique throughout all the
Blender Documentation Project to allow for cross references from one chapter
to another etc.
It is thus higly adviceable to stick to a given standard:
For Core documentation
PID.CID.[F|T|E|D|L].AID.userdefined
For Tutorials
TID.AID.userdefined
Where
a.. PID is a two letter Pubblication Identifier;
b.. CID is a three letter Chapter identifier;
c.. [F|T|E|D|L] is a letter defining the Type of object labelled, that is:
a.. Figure;
b.. Table;
c.. Equation;
d.. Document Data (i.e. a Section, subsection, paragraph etc);
e.. Listate;
d.. AID is a three letter author identifier;
e.. userdefined are (up to) ten letters up to the author to define;
f.. TID is a three letter tutorialidentifier;
PID and CID are provided by the DocBoard.
TID and AID are to be agreed between the author and the DocBoard in a
preliminary phase.
The userdefined is completely up to the author, who is responsible for
keeping the whole label unique.
Stefano