db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From John Embretsen <John.Embret...@Sun.COM>
Subject Re: Explanation of documentation file names (was :Re: How to commit documentation patches?)
Date Tue, 15 Aug 2006 08:59:59 GMT
Kristian Waagan wrote:

> There seems to be some prefixes:
>  * 'c', 'r' and 't'.
>    Not quite sure what these are.

These are explained here:

http://db.apache.org/derby/manuals/dita.html#DITA+file+names

"All DITA topics are classified as either concepts, tasks, or reference 
material. Thus, every file begins with either a "c", "t", or "r". In 
addition, the letters that appear immediately after this first one 
provide a shorthand id for the manual. For example, the Getting Started 
with Derby manual uses "gs", so a reference topic DITA file in that 
manual will start with "rgs"."

>  * 'dev', 'tools', 'tuning', 'ref'
>    These indicate which manual the file belongs to.
> 
> And, the great mystery, what do all the digits mean?
> Are they generated by a (deprecated) tool, are they random?
> For instance, 'rrefexcept71493.dita'.

On the same web page, I found:

"Subsequent letters in the file name may provide hints at the topic's 
section within the manual, as well as numbers distinguishing it from 
other DITA files."

It seems that the numbers are random, but perhaps someone with DITA- or 
relevant historical knowledge has more details...


-- 
John

Mime
View raw message