Structure du Wiki Apache OpenOffice français
 |
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. |
Contents
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 :
- 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.
- /FR : La branche française, également appelée plus bas simplement FR.
- /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)
- Concises: Courtes et descriptives. Le plus précis possible sans redondance.
- 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 :
- Les manuels de référence ou guides, des ouvrages couvrant un domaine et pouvant atteindre plusieurs centaines de pages.
- Les How-tos ou mini-guides couvrant un domaine plus précis, d'un contenu généralement compris entre une et trente pages.
- 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 :
- Le guide d'administration
- Le guide de programmation Basic
- Le guide pour Writer v3
- Le guide HSQLDB devrait être déplacé ici : FR/Documentation/HSQLDB_Guide, pour l'homogénéité.
- Les fonctions listées par catégories pour Calc.
- Ajoutez un oubli...
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 :
- FR/How_Tos (au lieu de FR/Documentation/How_Tos)
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. 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
- Category:FR
- Les pages du Wiki francophone d'Apache OpenOffice. C'est notre catégorie principale.
- Pour l'instant Category:Documentation/FR, mais Category:FR/Documentation ou même Category:FR/Doc conviendrait mieux
- La catégorie pour regrouper toute la documentation francophone. Elle même contenant plusieurs catégories, ci dessous proposées :
- 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. Exemple pour Draw :
- Category:FR/How_Tos/Draw ou Category:FR/Doc/How_Tos/Draw ou Category:FR/Documentation/How_Tos/Draw
- Deux excellents exemples en français, et il est toujours possible de créer ou d'utiliser une page pointant sur les autres documents accessibles par téléchargement.
Autres catégories :
- Category:FR/Doc/Calc ou Category:FR/Documentation/Calc
- Pour regrouper toute la documentation francophone sur Calc. Guide, How-Tos ou FAQ
Catégories existantes :
- Category:Documentation/BASIC_Guide
- Ne sera pas renommée pour préserver les liens interwikis.
- Category:Documentation/AdministrationGuide
- Ne sera pas renommée pour préserver les liens interwikis.
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 :
