Difference between revisions of "User:Dominique Pautrel/Structure Wiki FR"

From Apache OpenOffice Wiki
Jump to: navigation, search
m (Guides)
m (Catégories)
Line 69: Line 69:
 
C'est d'ailleurs un bon réflexe pour conserver simplement une vue globale, en ordre alphabétique, de toutes les pages françaises. Ce comportement est similaire au résultat d'une recherche depuis un dossier de votre disque dur, excepté le fait que le "dossier" en question est en fait une catégorie Wiki.
 
C'est d'ailleurs un bon réflexe pour conserver simplement une vue globale, en ordre alphabétique, de toutes les pages françaises. Ce comportement est similaire au résultat d'une recherche depuis un dossier de votre disque dur, excepté le fait que le "dossier" en question est en fait une catégorie Wiki.
  
 +
Il est d'ailleurs possible de définir un paramètre de tri supplémentaire avec le caractère "pipe" <nowiki>("|")</nowiki> qui définit la position à laquelle la page apparait, alphabétiquement, à l'intérieur de la catégorie. A titre d'exemple, pour le guide HSQLDB qui apparait à la lettre H dans la catégorie FR :
 +
<pre>[[Category:FR|HSQLDB]]</pre>
 
Aujourd'hui, beaucoup de pages sont encore non référencées car sinon cette catégorie serait beaucoup plus étoffée... ;-)
 
Aujourd'hui, beaucoup de pages sont encore non référencées car sinon cette catégorie serait beaucoup plus étoffée... ;-)
 
}}
 
}}
Line 75: Line 77:
 
Toutefois, cette catégorie Documentation n'étant pas dédiée qu'aux francophones, notre page sera donc également visible de nos amis anglo-saxons. Selon la teneur et la portée du document, c'est bienvenue ou peu souhaitable. C'est pour cela qu'il existe une catégorie [[:Category:FR/Documentation|FR/Documentation]]  
 
Toutefois, cette catégorie Documentation n'étant pas dédiée qu'aux francophones, notre page sera donc également visible de nos amis anglo-saxons. Selon la teneur et la portée du document, c'est bienvenue ou peu souhaitable. C'est pour cela qu'il existe une catégorie [[:Category:FR/Documentation|FR/Documentation]]  
 
{{Documentation/Note|
 
{{Documentation/Note|
# En fait c'est actuellement [[:Category:Documentation/FR|Documentation/FR]], mais je pense vraiment qu'il serait bon d'uniformiser l'entrée des trois caractères "/FR" systématiquement immédiatement à suivre l'adresse #1 : [[Main_Page|http://wiki.services.openoffice.org/wiki]], de façon que toutes les pages françaises de portée francophone uniquement soient des sous-pages de notre accueil [[FR|http://wiki.services.openoffice.org/wiki/FR]]<br>
+
# En fait c'est actuellement [[:Category:Documentation/FR|Documentation/FR]], mais je pense vraiment qu'il serait bon d'uniformiser l'entrée des trois caractères "/FR" systématiquement immédiatement à suivre l'adresse #1 : [[Main_Page|http://wiki.services.openoffice.org/wiki]], de façon que toutes les pages françaises de portée francophone uniquement soient des sous-pages de notre accueil [[FR|http://wiki.services.openoffice.org/wiki/FR]]. Enfin au moins pour les pages à venir...
Enfin au moins le définir clairement pour les pages à venir. :-D
+
# Vous pouvez aussi n'afficher que les pages répondant aux deux catégories. Voir à ce propos les [[#Requ.C3.AAtes|requêtes]].
# Vous pouvez aussi n'afficher que les pages répondant aux deux catégories. Voir à ce propos les requêtes.
+
 
}}
 
}}
 
==Exemples de catégories==
 
==Exemples de catégories==

Revision as of 15:52, 26 April 2009

Documentation caution.png

S'il vous plait ne créez pas de liens durables vers cette page. Elle est destinée à être un brouillon et, suite à un couper/coller, supprimée. Il n'y aura donc pas de redirection suite à cela. En revanche complétez, clarifiez, discutez ici-même, ou même déplaçons la avant tout de suite, ou intégrons la à, si vous lui voyez sa place avec certitude... ;-)

L'objet de ce document est d'établir ensemble une structure univoque... S'il doit aboutir... il ne sera plus que le reflet de l'architecture existante.


Template:Documentation/Note

Préambule

Cette page focalise sur les noms des pages dans le Wiki d'Apache OpenOffice, et est incidemment destinée à vous aider à contribuer facilement à la documentation...

Faites attention de bien mémoriser les trois chaînes de caractères ci-dessous (qui sont autant de liens) pour la suite du propos :

  1. http://wiki.services.openoffice.org/wiki : L'adresse de base, donc dans la langue native du projet, en anglais. La page parente de toutes les autres.
  2. /FR : La branche française, également appelée plus bas simplement FR.
  3. /FR/Documentation : La page "racine" de la documentation en français.

Ainsi que le fait que dans ce document, il sera employé régulièrement le conditionnel. Ceci parce que les choix de structure évoluent et que bien des pages existantes ne répondent pas (ou plus ou pas encore) aux critères énoncés ci-dessous... ce n'est pas un problème... mais ce n'est pas toujours simple non plus. Si d'autre part vous voyez des adresses apparaître en rouge comme ceci, c'est ou que le débat n'est pas clos et qu'aucune décision n'a encore été prise, ou que cette page, qui en héberge cependant d'autres, n'existe pas car non jugée nécessaire...

Règles de base pour les nouvelles adresses

(en toute logique)

  1. Concises: Courtes et descriptives. Le plus précis possible sans redondance.
  2. En français: Dès lors visible depuis Google ou autres moteurs de recherches.

Différences dues à la localisation

Il y en aura toujours et probablement même pour les traductions "synchronisées" par des liens interwikis, principalement par le fait que les moteurs de recherche sont efficaces sur les noms de pages, et les traductions effectuées ne seraient sinon pas bien visibles depuis Google pour le public visé, par exemple...

Développement

Le Wiki a initialement été conçu par les développeurs pour eux-même. Veuillez vous reporter à l'adresse #1 pour plus de détails.

Documentation

Grossièrement, on pourrait scinder la documentation existante en trois parties :

  1. Les manuels de référence ou guides, des ouvrages couvrant un domaine et pouvant atteindre plusieurs centaines de pages.
  2. Les How-tos ou mini-guides couvrant un domaine plus précis, d'un contenu généralement compris entre une et trente pages.
  3. La FAQ ou les questions fréquemment posées, une question précise, une réponse concise.

Guides

Il n'y en a pas énormément disponibles sur le Wiki en français. Mais en revanche il contiennent nombre de sous-liens et l'adresse de base gagne à être courte, sans redondance :

Quelques guides en français :

A noter que les deux premiers cités ont été réalisés en accord avec les liens inter-wikis automatiques. L'unique différence réside dans les adresses des pages, chez nous augmentées des trois caractères "/FR" directement après l'adresse de base. Ceci permet de "synchroniser" les langues, un modèle simple assurant la liaison automatique entre chaque page.

Mais ceci enlèverait la recherche en français dans les moteurs de recherche. Je m'exprime au conditionnel car je n'ai pas trouvé d'exemple probant de ce défaut, partant du principe que les mots-clés de ma recherche sont ceux présents dans le titre affiché par la commande DISPLAYTITLE. Mais j'ai également observé que, si la réponse arrive bien en première ligne dans Google, elle s'effectue sur les mots dans la page, et non la commande DISPLAYTITLE. Ce dernier constat implique au rédacteur de reprendre les mots traduits dans le corps de la page, en plus de la commande DISPLAYTITLE, pour qu'une recherche en français soit efficiente.

Par exemple, quelques recherches efficaces dans le guide d'administration via Google :

Si vous trouvez une recherche inefficace malgré que les termes recherchés soient inclus dans la commande DISPLAYTITLE, merci de l'ajouter ici-même afin de discuter ce constat :

How-Tos

Ceux-ci sont déjà plus nombreux :

FAQ

Elles sont souvent impressionnantes :

  • FR/FAQ. A noter que les anglais en on fait une sous-page de Documentation, soit Documentation/FAQ. (c'est logique, il peut exister d'autres FAQ, mais c'est plus long et probablement inutile dans le cas d'une localisation).

Catégories

Les catégories peuvent-être considérées comme autant de mots-clefs. Prenons pour exemple une page (française) affublée de la catégorie FR :
[[Category:FR]]
S'affiche en bas de page un bandeau avec le lien vers la (page) catégorie FR, et notre présente page apparait dès lors dans cette page particulière qu'est une catégorie, à coté de toutes les autres pages (françaises) pareillement catégorisées.

Template:Documentation/Note

Reprenons notre page FR du début et assignons lui une autre catégorie, par exemple Documentation :
[[Category:Documentation]]
Le bandeau en bas de page contient bien maintenant les deux catégories.

Toutefois, cette catégorie Documentation n'étant pas dédiée qu'aux francophones, notre page sera donc également visible de nos amis anglo-saxons. Selon la teneur et la portée du document, c'est bienvenue ou peu souhaitable. C'est pour cela qu'il existe une catégorie FR/Documentation Template:Documentation/Note

Exemples de catégories

Template:Documentation/Note

Category:FR
Les pages du Wiki francophone d'Apache OpenOffice. C'est notre catégorie principale.
Category:FR/Documentation ou même Category:FR/Doc, mais pour l'instant Category:Documentation/FR
La catégorie pour regrouper toute la documentation francophone. Elle même contenant plusieurs catégories...
Category:FR/FAQ ou Category:FR/Doc/FAQ ou Category:FR/Documentation/FAQ
La FAQ francophone. Contenant des sous-catégories, par exemple:
Category:FR/FAQ/Writer ou Category:FR/Doc/FAQ/Writer ou Category:FR/Documentation/FAQ/Writer
FAQ francophone de Writer
Category:FR/How_Tos ou Category:FR/Doc/How_Tos ou Category:FR/Documentation/How_Tos
La catégorie principale de tous les mini-guides.
Category:FR/FAQ/Math
FAQ francophone de l'éditeur de formules

Requêtes

Vous pouvez afficher des listes dynamiques de page où des catégories ont été affectées :

Par exemple, entrez :

<DPL>
  category=Documentation
  category=FR
</DPL>

Pour obtenir la liste des pages contenant à la fois les catégories "Documentation" et "FR" :

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

Autres essais : (si vous avez des exemples fonctionnels, faites disparaitre l'erreur ci dessous "%DPL-1.7.4-WARNING: No results!" ;-)

<DPL>
  ' Recherches infructueuses : location=FR ; special=parameter ; lang=FR ; category=category
</DPL>

Le résultat risque d'être :

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

Quelques listes ainsi générées :

269 pages dans la catégorie Documentation. Il y a 112 pages dans la catégorie FR.

How-Tos

Les différentes catégories de How-Tos :
Presentations: "Documentation/How_Tos/Impress" Installation: "Documentation/How_Tos/Installation"
Impress.png
Edit.png
Le Texte: "Documentation/How_Tos/Writer" Tableur: "Documentation/How_Tos/Calc"
Writer.png
Calc.png
Bases de données: "Documentation/How_Tos/Database" Dessin: Documentation/How_Tos/Draw"
Base.png
Draw.png
Formules: "Documentation/How_Tos/Math" Macros et API: "Documentation/How_Tos/Macro"
Math.png

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

Macro.png

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

FAQ

Les longues listes des FAQ :
Presentations: "Documentation/FAQ/Impress" Installation: "Documentation/FAQ/Installation"
Impress.png
Edit.png
Le Texte: "Documentation/FAQ/Writer" Tableur: "Documentation/FAQ/Calc"
Writer.png
Calc.png
Bases de données: "Documentation/FAQ/Base" Dessin: Documentation/FAQ/Draw"
Base.png

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

Draw.png
Formules: "Documentation/FAQ/Math" Macros et API: "Documentation/FAQ/Basic"
Math.png

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

Macro.png

Extension:DynamicPageList (DPL), version 2.3.0 : Warning: No results.

Modèles

Personal tools