Difference between revisions of "FPDoc Editor/fr"
Paulatreides (talk | contribs) (→Usage) |
Paulatreides (talk | contribs) |
||
| Line 18: | Line 18: | ||
4. Placer et déplacer le curseur . Après avoir placé le curseur sur l'éditeur de source, vous noterez que la légende de la fiche de LazDoc change. La légende montre l'élément de source choisi et le nom de fichier du fichier de documentation . En choisissant la page appropriée dans LazDoc vous pouvez éditer une étiquette spécifique de documentation . Naturellement il est également possible d'employer LazDoc seulement comme un visionneur . | 4. Placer et déplacer le curseur . Après avoir placé le curseur sur l'éditeur de source, vous noterez que la légende de la fiche de LazDoc change. La légende montre l'élément de source choisi et le nom de fichier du fichier de documentation . En choisissant la page appropriée dans LazDoc vous pouvez éditer une étiquette spécifique de documentation . Naturellement il est également possible d'employer LazDoc seulement comme un visionneur . | ||
| − | == | + | == Futurs plans == |
| − | + | La liste de choses à faire contient actuellement les articles suivants, dans aucun ordre particulier : | |
| − | * | + | * Faire que LazDoc créer de nouveaux éléments dans la documentation |
| − | * | + | * Faire que LazDoc créer de nouveaux fichiers de documentation |
| − | * | + | * Ajouter les étiquettes de documentation « topic » à LazDoc |
| − | * | + | * Ajouter plus d'éléments de source à être interprété par LazDoc en employant les codetools existants (maintenant procedure/function/constructor/destructor sont supportés ) |
| − | * | + | * Ajouter LazDoc aux paramètres de l'ide (showing and position in IDE) |
| − | * | + | * Employer l'IPC pour la communication |
| − | * | + | * Faire que LazDoc fonctionne on keydown in sourceeditor (broken) |
| − | * | + | * Faire que LazDoc soit un éditeur WYSIWYG, comparable à un éditeur editor richtext. |
| − | * | + | * Ajouter un visualisateur HTML; LazDoc produira la documentation automatiquement |
== DONE == | == DONE == | ||
Revision as of 16:31, 24 June 2007
Introduction
LazDoc est un éditeur/visionneur intégré pour Lazarus. Les articles décrits ici et utilisant LazDoc lui-même exige de vous d'être au courant de FPDoc. Pour plus d'information voir : manuel de documentation d'outil de Free Pascal
Où trouver LazDoc ??
LazDoc est intégré dans l'IDE de Lazarus. Il peut être trouvé sous le menu de Voir .
Utilisation
L'utilisation de LazDoc est très simple .
1. Fixer le chemin de recherche de LazDoc dans la boite de dialogue Projet | Options du projet..., sous l'onglet LazDoc.
2. Ouvrir ou sélectionner un fichier pour lequel la documentation existe.
3. Ouvrir l'éditeur LazDoc.Vous pouvez le trouver sous le menu Voir.
4. Placer et déplacer le curseur . Après avoir placé le curseur sur l'éditeur de source, vous noterez que la légende de la fiche de LazDoc change. La légende montre l'élément de source choisi et le nom de fichier du fichier de documentation . En choisissant la page appropriée dans LazDoc vous pouvez éditer une étiquette spécifique de documentation . Naturellement il est également possible d'employer LazDoc seulement comme un visionneur .
Futurs plans
La liste de choses à faire contient actuellement les articles suivants, dans aucun ordre particulier :
- Faire que LazDoc créer de nouveaux éléments dans la documentation
- Faire que LazDoc créer de nouveaux fichiers de documentation
- Ajouter les étiquettes de documentation « topic » à LazDoc
- Ajouter plus d'éléments de source à être interprété par LazDoc en employant les codetools existants (maintenant procedure/function/constructor/destructor sont supportés )
- Ajouter LazDoc aux paramètres de l'ide (showing and position in IDE)
- Employer l'IPC pour la communication
- Faire que LazDoc fonctionne on keydown in sourceeditor (broken)
- Faire que LazDoc soit un éditeur WYSIWYG, comparable à un éditeur editor richtext.
- Ajouter un visualisateur HTML; LazDoc produira la documentation automatiquement
DONE
- Adding a small toolbar makes it possible to use the available makeup tags.
- Add documentation tags "seealso" to LazDoc
- Make it work for fpc sources (rtl files already exist)
- Add settings to environment menu
- Make it work on project files also
- Propose to expand documentation tags with: "todo" and "notes" (no need for that, as there are alternatives)
- Reduce overhead even further
- Find inherited entries. For example TControl.Align of TButton.Align.
- Optimization: inherited Entries are parsed on idle.
- Optimization: xml files are cached, and only parsed once or if they changed on disk
