Introduction
|
[P]
[N]
[T]
[C]
[F]
[1] |
Le projet PT est un outil, basé sur le préprocesseur C (cpp),
qui permet de rédiger de la documentation
(ou tout autre document texte) sous divers formats
à partir d'un fichier texte brut en ‘langage’ PT
(PT signifie ‘Plain Text’).
Le ‘langage’ PT est comparable au langage LaTeX.
Cependant, il est particulierement simple d'emploi
et, de par sa nature, très souple, personnalisable et évolutif.
Il ne requiert que de faibles connaissances informatiques.
Actuellement, PT permet de créer des pages internet (HTML),
des fichiers d'aide windows, des documents TeX ou LaTeX,
des fichiers d'aide Info,
des libraires de filtres graphiques
(Filter Factory Library .FFL).
De plus, le projet PT contient un
ensemble d'outils de bases très simples (les filtres)
qui permet à l'utilisateur plus expérimenté,
d'intégrer une documentation PT au sein d'un fichier de code
ou
de réaliser des générations automatiques
pour tout type de fichiers textes formatés.
La grande qualité du projet PT est sa fléxibilité d'utilisation.
PT est l'outil idéal pour créer une mise en page personnelle.
Contrairement aux utilitaires classiques de conversion de fichiers,
PT permet un résultat sur mesure.
Par ailleurs, PT développe un mécanisme et des outils de base
(simples mais très souples)
qui peuvent être employés pour de multiples autres applications.
L'objectif initial du projet PT a été la traduction en langage
HTML de documentations rédigées à l'aide du logiciel RTFGen qui
emploi un langage et un mécanisme très similaire à celui de PT.
Le second objectif est de permettre l'intégration et l'extraction de documentations très
structurées à l'intérieur des fichiers sources en divers langages.
Dans un cadre plus large,
le projet PT est élaboré dans le but de répondre à plusieurs problèmes:
-
Développer des documentations
de manière sémantique
(SGML et LaTeX partage cette même approche)
et indépendamment du
langage de mise en pages du document.
-
Rédiger en langage HTML
(qui ne possède pas de macro-instructions)
des pages selon un même modèle (id. un ensemble de "pattern")
aisèment paramétrable et redéfinissable.
-
Intégrer dans un même document le code et sa documentation
(dans le même esprit que WEB de Donald Knuth).
-
Permettre le développement du code en langage objet
indépendamment du langage de programmation.
-
La version 1 de PT permet de créer, à partir d'un seul fichier source,
un page internet (HTML),
un fichier d'aide windows, un document TeX ou LaTeX ou
un fichier d'aide Info.
La phase de compilation emploie cpp à une seule reprise (mode mono-passe).
La version 1 de PT est le fruit d'une semaine de travail seulement
(documentation comprise).
Le résultat fut tellement enthousiasmant,
compte tenu du faible investissement nécessité,
qu'il a été décidé de pousser le développement du projet PT plus avant.
-
La version 2 de PT et les versions ultérieures emploient
cpp à trois reprises pour la compilation (mode multi-passe).
Ceci permet la génération des fichiers auxiliaires de la même
manière que LaTeX et le découpage du document final en
plusieurs fichiers.
La version 2 de PT apporte ainsi de nombreuses améliorations
au format HTML: frame, table des matières, browser (barre d'outils), etc.
-
La version 3 est un effort pour généraliser, paramétrer les outils introduits par la version 2
et constituer une véritable bibliothèque de base pour les développements futurs.
La version 3 a également introduit le filtre cpp2pt.
-
La version 4 de PT est en réalité une simple évolution de la version 3.
Elle possède une option supplémentaire qui permet de prendre en compte la langue dans
laquelle le document est rédigé.
La version 4 de PT sera prochainement distribuée.
Documentations:
-
rédaction d'une version anglaise de la documentation.
-
rédaction d'un `tutorial'
-
rédaction d'un `FAQ'
-
rédaction de `conseil de rédaction'
Développements:
-
gestion de l'inclusion de fichiers auxilliaixes externes. Ajout de __XPATH et de __NAMESPACE.
-
rédaction de INDEX.MAC: création automatique d'index.
-
rédaction de WEB.MAC
-
rédaction de CODE.MAC
Outils FreeWare apparentés à PT
|
[T] |
Les processeurs de macros:
M4 et GPP sont des outils beaucoup plus puissant que cpp.
Mais il sont également plus difficile à maîtriser et leur usage est beaucoup
plus confidentiel.
C'est pourquoi cpp a été choisi.
De plus, l'emploi récursif de cpp palie une bonne partie des ses insuffisances.
Outils de mise en page hypertexte:
-
RTFGen est un logiciel Windows freeware qui permet
de générer des aides fichiers d'aide Windows.
De la même manière que PT,
RTFGen fonctionne à partir d'un fichier en texte brut et possède
un macro-processeur interne très proche de cpp.
-
cpp2html,
java2html:
These are a simple program that, given a source C/C++ or java file,
produce an html source with syntax highlighting.
-
lxr
The main goal of the project is to create
a versatile cross-referencing tool for relatively large code repositories.
Manipulation de fichiers:
-
Gnu Perl
est un outil puissant mais ardu de manipulation de fichiers.
Il en existe une version sous Windows:
Cygwin-B20.
Téléchargement et installation
|
[T] |
Win 32:
-
Télécharger puis décompresser le fichier pt1wb.zip (PT version 1)
(exécutables et documentation)
dans le répertoire de votre choix.
-
Le preprocesseur du langage C (cpp) est indispensable.
Si vous possédez pas le fichier cpp.exe,
téléchargez le : cpp.zip (194K).
Attention: cette distribution non officielle est extraite de
la distribution DJGPP (version 2.6.0).
-
L'utilitaire make est également disponible
en tant que composant de la distribution DJGPP.
-
Si vous disposez de la commande make,
paramètrez les premières lignes du fichier makefile.def.
Il est recommandé d'ajouter ce fichier à votre fichier
makefile par défaut.
-
Sous Dos, les fichiers de batch .BAT
ont été concus pour palier l'absence de la commande make.
Paramètrer, de la même manière, les premières lignes de ces fichiers.
-
Si vous disposez de Emacs, installer le
fichier ptmode.el (cf. Edition des fichiers .PT).
-
Vous pouvez également
enregistrer le type de fichiers .PT
en utilisant l'icone pt.ico et
lui affecter des associations (avec Emacs pour l'édition par exemple).
Unix:
-
Télécharger puis décompresser le fichier pt1xs.zip (PT version 1)
(sources et documentation)
dans un emplacement de votre choix.
-
Paramètrer les premières lignes du fichier makefile.def
en fonction de l'emplacement choisi.
Il est recommandé d'ajouter ce fichier à votre fichier
makefile par défaut.
-
Si vous disposez de Emacs, installer le
fichier ptmode.el (cf. Edition des fichiers .PT).