Olivier Ramare on Fri, 05 Jul 2002 14:12:49 +0000

[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]

[gpdoc] A uniform style.


  About syntax in this dear usersch3.tex ....
I've tried to understand how entries are written
and how they should be written. To get a documented
standard way for --yes !!-- external contributors !

What exists :

-- \subsecidx{max} indicates a function.
       -- name written,
       -- entry in the index,
       -- section number here.
-- \idx{or} indicates a function.
       -- name written,
       -- entry in the index.
-- \sidx{or} is to put only an entry in the index under
   this name but not print the argument ("or" here).
-- \kbdsidx{} ?? not used ? no use ?
-- \syn{gmax} indicates a library counterpart.
-- \synt{direuler} is what ??
-- \kbd(numtoperm) indicates a function when used inside
   the text. But what about \kbd{long} and \kbd{GEN} ??
   change them to something else ? "\type(long)" ?
   What about \kbd{issquare}$(x,\{\&e\})$
          and \kbd{lex([1,3], [1,3,-1])} ?
-- $\teb{gmin}(x,y)$ ?? a function that should be classed
   in the same place ...
   A function which appears for the first time
   and is thus refered here but with no independant section ?
-- \tet{permtonum} is ??
-- \teb{ggprecision} is what ??
-- $\tev{nf}$ is the usual name of a variable.
-- examples of session are currently between \bprog and @eprog.

What can/should be added :

-- an macro for "See also dirmul". Which would convert
   into an html link easily.

Ordering :

-- As is now ? explanations-and-examples, see-also place,

  So if anyone has a better understanding of the existing structure
of this chapter 3 ... and even could answer to the above questions ?