New documentation

Dominik Waßenhoven <[email protected]> Sat, 29 Apr 2006 18:37:27 +0200
Newsgroups gmane.comp.tex.bibtex.jurabib.devel
Message-ID <[email protected]>
Hello all,

I'm new to the jurabib developer team, and as the position that Jens 
gave me for the sourceforge.net project indicates ("Doc Writer"), I 
would like to contribute by re-writing the jurabib documentation.

We all know that the documentation needs (maybe more than) a 
face-lifting, because it is an accumulation of worthwile information, 
but has lost its stringent structure. Thus, I want to give a first 
outline of a new structure for the documentation, which is derived from 
the original one. Any suggestions are appreciated!

1) Introduction
2) Installation
3) The styles
    (i.e. the different bst files: jurabib, jureco, jox, jurunsrt, and
    maybe the jurabib.mbs)
    not a detailed description, maybe just a bibtex entry with the four
    different outputs in standard configuration
4) Additional BibTeX entry types and fields
    i.e. @periodical,@www,@commented ...
    shortauthor,shorttitle,titleaddon,booktitleaddon ...
5) Package Options
   5.1) Citation formatting
   5.2) Bibliography formatting
6) The Commands
7) Customization
8) The Configuration file
9) Across the boundaries

Of course you can also suggest a completely different structure...

Also, any suggestions for handling the files in the SVN repository are 
appreciated. I think the now existing documentation should stay in the 
repository as long as the new one is not nearly completed, but it would 
be easier to write the new documentation from scratch; so I thought of 
two possibilities:

a) jbendoc.tex and jbgerdoc.tex stay as they are, and the new 
documentation files get new names (though I had no good ideas until now, 
at least none with only 8 characters...)

b) The now existing files will be renamed to jbendoc.old and 
jbgerdoc.old, and the new ones get the names jbendoc.tex and 
jbgerdoc.tex (which could lead to confusion).

Let me know what you think of it.

Kind Regards,
Dominik.-



 
Yahoo! Groups Links

<*> To visit your group on the web, go to:
    http://groups.yahoo.com/group/jurabib-developer/

<*> To unsubscribe from this group, send an email to:
    [email protected]

<*> Your use of Yahoo! Groups is subject to:
    http://docs.yahoo.com/info/terms/