[latexrefman-commits] [SCM] latexrefman updated: r915 - trunk

[jimhefferon at gnu.org.ua]

Author: jimhefferon
Date: 2021-05-26 21:52:51 +0000 (Wed, 26 May 2021)
New Revision: 915

Modified:
   trunk/TODO
   trunk/writing.html
Log:
put s few notes into writing.html

Modified: trunk/TODO
===================================================================
--- trunk/TODO	2021-05-26 19:38:00 UTC (rev 914)
+++ trunk/TODO	2021-05-26 21:52:51 UTC (rev 915)
@@ -3,98 +3,3 @@
 A list of things to be done.  Please date each and give your initials.
 
 =====================================
-2021-May-24 JH (from VB)
-
- at c xx TODO, align on the French version which is far more complete and
- at c accurate.
- at c xx French version below:
- at ignore
- at c @node Jobname
- at c 
- at c Quand vous exécutez @code{@command{pdflatex} @var{options}
- at c @var{argument}}, si @var{argument} ne commence pas par une contr'oblique
- at c alors @TeX{} considère que c'est le nom du fichier racine à lire en
- at c entrée. Le nom du fichier racine, sans l'extension @file{.tex} si elle
- at c est donnée, définit alors le @dfn{nom d'ouvrage}, celui-ci est utilisé pour
- at c nommer le fichier journal et le fichier de sortie.
- at c 
- at c Autrement, si @var{argument} commence par une contr'oblique, il attend
- at c la première instruction @code{\input} et le nom du fichier en entrée
- at c devient le nom d'ouvrage.
- at c 
- at c Au sein du document, la variable @code{\jobname} se développe dans le
- at c nom d'ouvrage, avec la particularité que tous les caractères sont de
- at c catcode 11 (lettre). Ainsi, si vous voulez utilisez le nom d'ouvrage
- at c comme une condition, la solution la plus simple est d'utiliser une macro
- at c de text du paquetage @file{xtring} dans sa variante étoilée pour être
- at c insensible au catcode. Dans le texte suivant par exemple, la note en bas
- at c de page « dont la Respublica Bananensis Francorum. » n'est présente que
- at c si le nom de tâche commence par @file{moi-meme}.
- at c 
- at c @example
- at c Si une démocratie est juste un régime où les citoyens votent alors
- at c toutes les républiques bananières\IfBeginWith*@{\jobname@}@{moi-meme@}%
- at c @{\footnote@{dont la Respublica Bananensis Francorum.@}@}@{@} sont des
- at c démocraties.
- at c @end example
- at c 
- at c Cela ne fonctionnerait pas si la version non étoilée de
- at c @code{\IfBeginWith} était utilisée, parce que le @code{-} dans
- at c @samp{moi-meme} a un catcode 12, alors que dans @code{\jobname}, s'il
- at c s'y trouve, il a nécessairement un catcode 11.
- at c 
- at c Dans certains cas il peut être utile de fixer le nom de tâche à une
- at c autre valeur que celle par défaut, l'option @code{--jobname} permet de
- at c faire cela, elle l'emporte sur le premier @code{\input} et spécifie
- at c directement le nom.  @xref{Command line input}, pour un exemple d'usage,
- at c où l'on génère deux fichiers @file{etudiants.pdf} et
- at c @file{professeurs.pdf} à partir d'un même code source @file{principal.tex}.
- at c 
- at c En l'absence d'option @code{--jobname}, la valeur initiale de
- at c @code{\jobname} est @code{texput}, de sorte que si la compilation
- at c s'arrête avant le premier @code{\input}, le journal produit sera nommé
- at c @file{texput.log}. Par exemple la commande suivante :
- at c 
- at c @example
- at c pdflatex "\nonstopmode\errmessage@{\string\jobname\space vaut \jobname@}"
- at c @end example
- at c 
- at c produira un journal @file{textput.log} contenant le message d'erreur
- at c @samp{! \jobname vaut texput.}.
- at c 
- at c Attention, le nom de tâche est également forcé à @file{texput} si le
- at c premier @code{\input} est indirectement appelé par @code{\documentclass}
- at c ou @code{\RequirePackage}. Ainsi l'exemple suivant produira un fichier
- at c nommé @file{texput.pdf} avec une version raisonnablement récente de
- at c @LaTeX{}Â :
- at c 
- at c @example
- at c pdflatex "\documentclass@{minimal@}\begin@{document@}Bonjour !\end@{document@}"
- at c @end example
- at c 
- at c mais avec une version plus ancienne le fichier de sortie se serait nommé
- at c @file{minimal.pdf}, parce que le premier @code{\input} appelé
- at c indirectement par @code{\documentclass} aurait été traité de la même
- at c façon que s'il chargeait le fichier source racine.
- at c 
- at c Voici un autre exemple de cela, ici on reprend l'exemple donné dans
- at c @ref{Command line input} où l'on passe sur la ligne de commande l'option
- at c @code{draft} au paquetage @file{graphicx}. Mais au lieu de le faire avec
- at c @code{\PassOptionToPackage}, on le fait avec @code{\RequirePackage}, ce
- at c qui a également pour effet que le paquetage @file{graphicx} sera chargé
- at c en premier, si ce n'était pas déjà le cas.
- at c 
- at c @c credit Herbert Voss: https://tex.stackexchange.com/a/17236/121234
- at c @example
- at c pdflatex --jobname=aa "\RequirePackage[draft]@{graphicx@}\input@{aa.tex@}"
- at c @end example
- at c 
- at c L'option @code{--jobname=aa} est nécessaire, car elle garantit que le
- at c fichier de sortie se nommera bien @file{aa.pdf}, et non
- at c @file{texput.pdf} avec une version récente de @LaTeX{}, ni
- at c @file{graphicx.pdf} avec une version plus ancienne.
- at end ignore
-
-
-
-

Modified: trunk/writing.html
===================================================================
--- trunk/writing.html	2021-05-26 19:38:00 UTC (rev 914)
+++ trunk/writing.html	2021-05-26 21:52:51 UTC (rev 915)
@@ -173,7 +173,7 @@
   Here are a few guidelines:
   (1) Test all your examples, no matter how small.
   (2) Use best practices, both coding and typographic practices,
-  such as including the <code>\,</code> space in <\code>$\int x\, dx$</code>.
+  such as including the <code>\,</code> space in <code>$\int x\, dx$</code>.
   (3) Keep it brief but make it interesting, or at least sensible.
   If you are illustrating a formula then use an actual formula.
   For text, use an example from an actual document if reasonable but
@@ -222,6 +222,29 @@
   want write access to the repository then let us know on the mailing list.
   We'll see about an account.</p>
 
+
+<h3>Coding conventions</h3>
+
+<p>Here are a few conventions for working inside the <code>texi</code> file.
+  </p>
+
+<ul>
+  <li><span class="listitem">Tags</span>
+    Use <code>@code{..}</code> for code,
+    <code>@file{..}</code> for file names,
+    <code>@samp{..}</code> for examples.
+    Don't forget that curly braces inside examples need to be escaped
+    with at-signs: <code>@code{\macro@{arg@}</code>.</li>
+  <li><span class="listitem">ChangeLog</span>
+    Update this file when you make larger changes, such as opening
+    a new node.</li>
+  <li><span class="listitem">Input formatting</span>
+    Put two lines before a new node.
+    When you are all done writing, use <code>Ctrl-Q</code> to format
+    blocks of text to a uniform width.</li>
+  </ul>
+
+
 <hr/>
 <div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div>
 </body>