siesta-dev-announce team mailing list archive

[Nick Papior <nickpapior@xxxxxxxxx>]

Dear all,

PS. Please, all subscribe to the mailing list (the mailing list allows
attachments!)
You may do this via:
https://launchpad.net/people/+me/+editmailinglists
Then select the tab:
"Siesta development announcements" and edit to "Preferred address". Then
press "Update subscriptions".

A recent branch with updated documentation has just been merged:

Since r542.

This branch introduces new mechanics and documentation tools for
the siesta.tex file.

The new usage will do a lot of automatic things for you.
For instance will every fdf-flag be a link to the definition of the
fdf-flag in the manual. (in-document hyper-links)

And PLEASE, use this conversion table:

  {\rm #1} => \textrm{#1}
  {\it #1} => \emph{#1}
  {\it #1} => \textit{#1} (only if you really want italics!!!)
  {\bf #1} => \textbf{#1}
  {\tt #1} => \texttt{#1}

Please note that \rm, \it, \bf, \tt are deprecated in LaTeX and
their use are highly discouraged!

1. Every entry has it's own block.
 To add an entry I have added 3 different blocks:

 a) for logical (default false) variables:
 \begin{fdflogicalF}{Diag!MRRR}
   Here is the description of flag \fdf{Diag!MRRR}.
 \end{fdflogicalF}

 b) for logical (default true) variables:
 \begin{fdflogicalT}{Diag!Use2D}
   Here is the description of flag \fdf{Diag!Use2D}.
 \end{fdflogicalF}

 and third and last

 c) for any type of variable:
 \begin{fdfentry}{NumberOfEigenStates}[integer]<\nonvalue{all orbitals}>
  Here is the description of \fdf{NumberOfEigenStates}.
 \end{fdfentry}

Remark that fdflogicalF/T are shorthands for:

  \begin{fdfentry}{flag}[logical]<\nonvalue{\fdffalse|\fdftrue}>

and

  \begin{fdfentry}{flag}[logical]<\nonvalue{\fdftrue|\fdffalse}>

  Note the "!" in the flag names. All "!" are converted to "." but they
are used in the indexing to sub-index them. Hence the MRRR flag will be
located under Diag |- MRRR.

2. In the manual one may refer to any fdf flag using:
  \fdf{flag} (no more {\bf ...}, or \textbf{...}. Then there will be a
link in the pdf to the corresponding
  entry, and it will automatically added to the index (for cross-
referencing).

  In case you do not want to make a cross-ref, use the starred variant:
    \fdf*{true}

  Note that \fdftrue/\fdffalse are equivalent to
\fdf*{true}/\fdf*{false}.
3. All fdf-examples should be delimited in this environment:

  \begin{fdfexample}
    <content>
  \end{fdfexample}

  All shell examples should be delimited in this environment:

  \begin{shellexample}
    <content>
  \end{shellexample}

4. To inline shell commands or progams (such as utilities) we prefer
   if you use these commands:

    \shell{make}

   or for a utility program:

    \program{Util/Bands/gnubands}

5. All files should be defined using this syntax:

    \file{DMHS.nc}

  or (for systemlabel files)
    \sysfile{DM}

  where the latter refers to the siesta.DM file.
  All these files will be indexed in their own index.

6. Sometimes it will be nice to make an index without adding
   to the text (regular \index command).

   To refer to fdf-flags one should use the:

     \fdfindex{flag}

I haven't fully explained all details of the documentation procedure.
But all necessary tools should be there.
If you have any doubts of the use, you may see in the transiesta section
where, nearly all functionality is present.

I will attach the example of the resulting manual on the mailing list
(go here:
https://lists.launchpad.net/siesta-dev-announce/)

Kind regards Nick
-- 
This message was sent from Launchpad by
Nick Papior (https://launchpad.net/~nickpapior)
to each member of the Siesta development announcements team using the
"Contact this team" link on the Siesta development announcements team page
(https://launchpad.net/~siesta-dev-announce).
For more information see
https://help.launchpad.net/YourAccount/ContactingPeople