sty2dtx - En ligne dans le Cloud

PROGRAMME:

Nom

sty2dtx -- Convertit un fichier LaTeX .sty en un fichier .dtx documenté

VERSION

Version: v2.3

DROIT D'AUTEUR

Copyright (c) 2010-2012 Martin Scharrer[email protected]>

Ce programme est un logiciel libre : vous pouvez le redistribuer et/ou le modifier selon les termes de
la licence publique générale GNU telle que publiée par la Free Software Foundation, soit
la version 3 de la licence ou (à votre choix) toute version ultérieure.

Ce programme est distribué dans l'espoir qu'il sera utile, mais SANS AUCUNE GARANTIE ;
sans même la garantie implicite de QUALITÉ MARCHANDE ou D'ADAPTATION À UN USAGE PARTICULIER.
Voir la licence publique générale GNU pour plus de détails.

Vous devriez avoir reçu une copie de la licence publique générale GNU avec ce programme.
Sinon, voirhttp://www.gnu.org/licenses/>.

DESCRIPTION

Convertit un fichier .sty (package LaTeX) au format .dtx (source LaTeX documentée), en
entourant les définitions de macro avec des environnements « macro » et « macrocode ». Le nom de la macro
est automatiquement inséré comme argument de l'environnement 'macro'. Lignes de code à l'extérieur
les définitions de macro ne sont encapsulées que dans des environnements « macrocode ». Les lignes vides sont supprimées.
Le script n'est pas considéré comme infaillible et précis à 100%, mais plutôt comme un bon début pour
convertir des fichiers de style non documentés en fichiers .dtx.

Basic Utilisation
perl sty2dtx.pl fichier d'entrée [fichier d'entrée ...] fichier de sortie

or

perl sty2dtx.pl < fichier.sty > fichier.dtx

Appareils Définitions
Les définitions de macro suivantes sont détectées lorsqu'elles sont au début d'une ligne (peuvent être
préfixé par \global, \long, \protected et/ou \outer) :

\def \edef \gdef \xdef
\nouvellecommande{\nom} \nouvellecommande*{\nom}
\nouvellecommande\nom \nouvellecommande*\nom
\renewcommand{\nom} \renewcommand*{\nom}
\renewcommand\nom \renewcommand*\nom
\providecommand{\nom} \providecommand*{\nom}
\providecommand\nom \providecommand*\nom
\@nomdef{\nom} \@nomdef\nom

Les définitions d'environnement suivantes sont détectées lorsqu'elles se trouvent au début d'une ligne :

\newenvironment{nom} \renewenvironemnt{nom} \provideenvironment{nom}

La définition de la macro et de l'environnement doit se terminer sur la même ligne ou par un '"}"' sur
le sien sur une ligne.

UTILISATION

sty2dtx [ ] [-- = ...] [--] [ ] [ ]

Documents officiels
· peut être '"-"' pour STDIN ou STDOUT, qui est la valeur par défaut si aucun fichier n'est fourni

· plusieurs fichiers d'entrée sont fusionnés en un seul fichier de sortie

Variables
Les variables peuvent être définies en utilisant

-- =

or

--

et sera utilisé pour les substitutions dans le fichier modèle.

Commun variables:

auteur, e-mail, mainteneur, année (pour le droit d'auteur),
version, date, description (du package/de la classe),
type (soit 'package' default ou 'class'),
base de fichiers (définie automatiquement à partir du nom du fichier de sortie ou d'entrée),

Options
-h Imprimer ce texte d'aide
-H Imprimer l'aide étendue
-V Version imprimée et copyright
-v Soyez verbeux
-o sortie Utiliser le fichier donné comme sortie
-O Écraser le(s) fichier(s) de sortie déjà existants
-B Utiliser le nom de base du fichier d'entrée unique pour le fichier de sortie
-I Créez également un fichier .ins (install)
-c Utilisez uniquement la section de code (comme v1.0)
-r Supprimez les environnements 'macro', 'macrocode', etc. existants.
-R Ne supprimez pas les environnements 'macro', 'macrocode', etc. existants.
-i ins-fichier Créer un fichier .ins avec le nom donné
-t modèle Utilisez ce fichier comme modèle au lieu de celui par défaut
-T modèle Utilisez ce fichier comme modèle pour le fichier .ins
-e filet Exporter le modèle .dtx par défaut dans un fichier et quitter
-E filet Exporter le modèle .ins par défaut dans un fichier et quitter
-D Utiliser la date actuelle comme date de fichier
-F filet Lire plus d'options et de variables à partir du fichier.
-N Ne pas lire le fichier de configuration par défaut ; doit être la première option

Config fichiers
Un fichier de configuration par défaut nommé 'sty2dtx.cfg' ou '.sty2dtx.cfg' est recherché dans le
répertoire courant, le répertoire home des utilisateurs et le répertoire de ce script, dans ce
ordre. Le premier trouvé est chargé. Si aucun n'est trouvé, l'arbre 'texmf' est recherché pour un
fichier de configuration 'sty2dtx.cfg'. Comme pour les fichiers -F, le fichier de configuration doit contenir une option ou
variable par ligne. Les lignes commençant par '"%"' ou '"#"' sont ignorées.

Exemples

Produisez 'file.dtx' à partir de 'file.sty' :

sty2dtx.pl < fichier.sty > fichier.dtx

or

sty2dtx.pl fichier.sty fichier.dtx

or

sty2dtx.pl -B fichier.sty

Produisez 'file.dtx' et 'file.ins' à partir de 'file.sty' :

sty2dtx.pl -I fichier.sty fichier.dtx

or

sty2dtx.pl fichier.sty -i fichier.sty fichier.dtx

or

sty2dtx.pl -IB fichier.sty

Définir des valeurs de variables personnalisées :

sty2dtx.pl --author Moi --email [email protected] monpkg.sty monpkg.dtx

Produire un fichier DTX pour une classe :

sty2dtx.pl --type classe mycls.sty mycls.dtx

Utilisez sty2dtx en ligne en utilisant les services onworks.net