Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit 67ea0c2

Browse files
forresstpetebacondarwin
forresst
authored andcommitted
docs(README_fr_FR): update with info about latest refactorings
Translation in french Closes #62
1 parent 9b001c5 commit 67ea0c2

File tree

1 file changed

+69
-18
lines changed

1 file changed

+69
-18
lines changed

README_fr_FR.md

+69-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dgeni Packages
22

3-
Ce dépôt contient une collection de packages de dgeni qui peuvent être utilisés par dgeni, le générateur
3+
Ce dépôt contient une collection de packages de Dgeni qui peuvent être utilisés par Dgeni, le générateur
44
de documentation, pour créer une documentation à partir du code source.
55

66

@@ -14,6 +14,7 @@ Actuellement, il y a les packages suivants :
1414
* ngdoc - La partie spécifique d'angular.js, avec la définition des balises, des processeurs et des templates.
1515
Celui-ci charge les packages de jsdoc et nunjucks pour vous.
1616
* examples - Processeurs pour supporter les exemples exécutables qui figurent sur les docs du site d'angular.js.
17+
* dgeni - support pour la documentation des packages de Dgeni
1718

1819
## Le package `base`
1920

@@ -22,11 +23,13 @@ Actuellement, il y a les packages suivants :
2223
* `debugDumpProcessor` - extrait l'état courant du tableau docs dans un fichier (désactivé par défaut)
2324
* `readFilesProcessor` - utilisé pour charger les documents depuis les fichiers. Ce processeur peut-être configuré pour utiliser
2425
un ensemble de **lecteur de fichier**. Il y a des lecteurs de fichiers (file-readers) dans les packages `jsdoc` et `ngdoc`.
26+
* `computePathsProcessor` - Détermine le `path` et le `outputPath` des documents en utilisant des templates ou des fonctions
27+
d'aide, sur la base du `docType`.
2528
* `renderDocsProcessor` - rendre les documents dans une propriété (`doc.renderedContent`) en utilisant
2629
un `templateEngine` (moteur de template), qui doit être fourni séparément - voir le package `nunjucks`.
2730
* `unescapeCommentsProcessor` - reformatte les marqueurs de commentaires pour ne pas casser le style des commentaires de jsdoc,
2831
par exemple `*/`
29-
* `writeFilesProcessor` - écrit les docs sur le disque
32+
* `writeFilesProcessor` - écrit les docs (pour ceux ont un `outputPath`) sur le disque
3033

3134
### Services
3235

@@ -79,8 +82,6 @@ pour rendre les documents en texte, tel que le HTML ou le JS, basé sur des temp
7982

8083
* `codeNameProcessor` - détermine le nom du document selon le code qui suit dans le document
8184
dans le fichier source.
82-
* `computePathProcessor` - détermine le chemin du document, utilisé pour écrire le fichier et pour naviguer
83-
vers le document dans une application web.
8485
* `parseTagsProcessor` - utilise un `tagParser` pour analyser les balises de jsdoc dans le contenu du document.
8586
* `extractTagsProcessor` - utilise un `tagExtractor` pour extraire l'information depuis les balises analysées.
8687
* `inlineTagsProcessor` - recherche les docs pour les balises [`inline`](http://usejsdoc.org/about-inline-tags.html) qui ont besoin d'avoir de l'injection de contenu
@@ -92,10 +93,10 @@ Le package `jsdoc` contient des définitions pour un certain nombre de balise st
9293
`animations`, `constructor`, `class`, `classdesc`, `global`, `namespace`, `method`, `type` et
9394
`kind`.
9495

95-
### Services
96+
### Services (Transformations de balise)
9697

97-
Ce package fournit un certain nombre de services tagTransform qui sont utilisés dans les définitions de balise pour transformer
98-
la valeur de la balise depuis le string dans le commentaire en quelque chose de plus significatif dans le doc.
98+
Ce package fournit un certain nombre de services **Transform** qui sont utilisés dans les **définitions de balise** pour transformer
99+
la valeur de la balise depuis le string du commentaire en quelque chose de plus significatif dans le doc.
99100

100101
* `extractNameTransform` - extrait un nom à partir d'une balise
101102
* `extractTypeTransform` - extrait un type à partir d'une balise
@@ -108,6 +109,11 @@ la valeur de la balise depuis le string dans le commentaire en quelque chose de
108109
**Ce package ne fournit pas de templates, ni un `templateEngine` pour rendre les templates (utilisez le
109110
package `nunjucks` pour faire cela).**
110111

112+
### Définitions des balises
113+
114+
Ce package fournit une implémentation minimale des balises du projet JSDoc. Elles extraient le nom et
115+
le type depuis la description de la balise trouvée, mais elles n'implémentent pas la totalité des fonctionnalités des balises JSDoc.
116+
111117
## Le package `ngdoc`
112118

113119
Le package `ngdoc` dépend des packages `jsdoc` et `nunjucks`.
@@ -144,25 +150,34 @@ Génère des documents pour chaque groupe de composants (par type) dans un modul
144150
* `computeIdProcessor` -
145151
Détermine la propriété id du doc sur la base des balises et d'autres méta-données
146152

147-
* `computePathProcessor` -
148-
Détermine path et outputPath pour les docs qui n'ont pas déjà
149-
150153
* `filterNgdocsProcessor` -
151154
Pour AngularJS, nous sommes seulement intéressés aux documents qui contiennent les balises @ngdoc. Ce processeur
152155
supprime les docs qui ne contiennent pas cette balise.
153156

154157
* `collectPartialNames` -
155-
Ajoute tous les docs à partialNameMap
158+
Ajoute tous les docs à `partialNameMap`
159+
160+
161+
### Définitions des balises
162+
163+
Ce package modifie et ajoute de nouvelles définitions de balises en plus de celles fournies par le package `jsdoc`.
164+
165+
166+
### Définitions des balises Inline
167+
168+
* `link` - Traite les balises Inline de lien (sous la forme {@link une/uri Un Titre}), en les remplaçant par
169+
des ancres HTML
156170

157171

158172
### Services
159173

160-
* `getLinkInfo()`
161-
* `getPartialNames()`
162-
* `gettypeClass()`
163-
* `moduleMap`
164-
* `parseCodeName()`
165-
* `patialNameMap`
174+
* `getLinkInfo()` - Récupère les informations du lien depuis un document qui correspond à l'url donné
175+
* `getPartialNames()` - Récupère une liste de tous les noms de code de partiel qui peuvent être utilisés à partir d'un ensemble
176+
donné
177+
* `gettypeClass()` - Récupère un string de classe CSS pour un string de type donné
178+
* `moduleMap` - Une collection de modules correspondant au nom du module
179+
* `parseCodeName()` - Découpe le nom de code en plusieurs morceaux
180+
* `patialNameMap` - Une map de nom de partiel pour les docs
166181

167182

168183
### Templates
@@ -181,10 +196,39 @@ templateEngine.config.tags = {
181196
};
182197
```
183198

199+
### Filtres de rendu
200+
201+
* `code` - Rend un span de text comme du code
202+
* `link` - Rend un lien HTML
203+
* `typeClass` - Rend une classe CSS pour un type donné
204+
205+
### Balises de rendu
206+
207+
* `code` - Rend un bloc de code
208+
209+
184210
## Le package `examples`
185211

186212
Ce package est un mix qui fournit des fonctionnalités pour travailler avec des exemples dans les docs.
187213

214+
À l'intérieur de vos documents, vous pouvez baliser example de la manière suivante :
215+
216+
```
217+
Du texte avant l'exemple
218+
219+
<example name="example-name">
220+
<file name="index.html">
221+
<div>Le HTML principal de l'exemple</div>
222+
</file>
223+
<file name="app.js">
224+
// Du code JavaScript à inclure dans l'exemple
225+
</file>
226+
</example>
227+
228+
Du texte après l'exemple
229+
```
230+
231+
188232
### Processeurs
189233

190234
* `parseExamplesProcessor` -
@@ -193,8 +237,15 @@ Analyse les balises `<example>` depuis le contenu et les ajoute au service `exam
193237
Ajoute les nouveaux docs à la collection de docs pour chaque exemple dans le service `examples` qui sera rendue
194238
comme des fichiers qui peuvent être exécutés dans le navigateur, par exemple en direct des démos ou pour
195239
des tests de e2e.
240+
* `generateProtractorTests` - Génère les fichiers de test de protractor depuis les tests e2e dans les exemples
241+
242+
### Définitions des balises Inline
243+
244+
* `runnableExample` - Injecte l'exemple exécutable spécifié dans la doc
245+
196246

197247
### Services
198248

199-
* examples - une map contenant chaque exemple par le nom
249+
* `exampleMap` - une map contenant chaque exemple par un id. Cet id est généré de façon unique à partir
250+
du nom de l'exemple
200251

0 commit comments

Comments
 (0)