Help:Contribute/fr: Difference between revisions

From KDE TechBase
(Created page with "=== Les premières choses d'abord ===")
No edit summary
 
(38 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>


This page contains information about editing the KDE TechBase wiki, including what content belongs where and helpful tools specific to this wiki. Even if you are familiar with wikis, you should read [[#Organisation|the section on organisation]] to see what content should be put where on this wiki.
Cette page contient des informations concernant la manière de modifier le wiki TechBase de KDE, y compris l'emplacement des contenus ainsi que des outils spécifiques adaptés à ce wiki. Même si vous êtes familier avec les wikis, vous pouvez relire [[#Organisation|la section sur l'organisation]] pour savoir où placer votre contenu sur ce wiki.


== Avant de commencer ==
== Avant de commencer ==
Line 7: Line 7:
=== Les premières choses d'abord ===
=== Les premières choses d'abord ===


* To contribute to TechBase you must register an account with the [https://identity.kde.org KDE Identity service], then activate it on [https://phabricator.kde.org Phabricator] by logging in there, and then you can click the [[Special:PhabricatorLogin/redirect|Login with Phabricator]] link on the sidebar to log in.
* Pour contribuer sur TechBase vous devez déclarer un compte avec le [https://identity.kde.org service KDE Identity], puis l'activer sur [https://phabricator.kde.org Phabricator] en vous y connectant, puis en cliquant sur le lien [[Special:PhabricatorLogin/redirect|Se connecter avec Phabricator]]  (Login with Phabricator) de la barre latérale pour ouvrir une session.


* Be aware that you must agree to your contributions to this wiki being released under the licenses listed at [[KDE TechBase:Copyrights]]. These licenses mean that what you write might be copied to other sites, for example.
* Notez bien que vous devez accepter que vos contributions à ce wiki soient placées sous les licences listées sur [[KDE TechBase:Copyrights]]. Ces licences signifient que ce que vous produisez peut être par exemple, recopié vers d'autres sites.


* Use the [https://www.mediawiki.org/wiki/Help:Talk_pages Talk pages] to communicate with other contributors or get help. Normally someone will get back to you within a day.
* Utilisez les [https://www.mediawiki.org/wiki/Help:Talk_pages pages de discussion] (Talk pages) pour communiquer avec les autres contributeurs ou pour demander de l'aide. Normalement quelqu'un vous répondra dans la journée.


===Relevance===
=== Que trouve-t-on ici ? ===


This wiki is for documentation for developers wanting to use or extend KDE products (e.g. via APIs), or:
Ce wiki concerne la documentation des développeurs voulant utiliser ou étendre les produits KDE (via les API) , ainsi que :


* overview information for libraries, including the advantages of using them
* les informations générales sur les bibliothèques, y compris les avantages en les utilisant
* tutorials and examples for using libraries
* les tutoriels et les exemples d'utilication des bibliothèques
* tutorials, examples and documentation for writing plugins and other extensions to libraries and applications
* les tutoriels, les exemples et la documentation pour écrire des plugins et d'autres extensions aux bibliothèques et aux applications
* IPC/RPC interfaces for software, like DBus interfaces
* les interfaces IPC/RPC pour le logiciel, comme les interfaces de DBus




End-user documentation belongs on [https://userbase.kde.org UserBase], and things directed at contributors, teams and the KDE Community in general belong on [https://community.kde.org the community wiki].
La documentation de l'utilisateur final est à placer dans le wiki [https://userbase.kde.org UserBase]. Les sujets relatifs aux contributeurs, aux équipes et à la communauté KDE en général sont dans [https://community.kde.org le wiki de la communauté].


Examples of things that '''don't''' belong on TechBase include:
Exemples de ce qu'il '''ne faut pas mettre''' sur le wiki TechBase :


* documentation on how to use an application
* la documentation sur la manière d'utiliser une application
* code style policies
* les règles d'écriture du code
* information for new contributors
* les informations pour les nouveaux contributeurs
* team coordination (TODO lists, meeting notes, etc)
* la coordination de l'équipe (listes TODO à  faire, les notes des réunions, etc...)
* notes on the internal architecture of a piece of software (but the architecture of a library's API does belong)
* les notes sur l'architecture interne d'un morceau de logiciel (mais on peut mettre ici l'architecture de l'API d'une bibliothèque)


More on this on the [https://community.kde.org/Guidelines_and_HOWTOs/Documentation_in_wikis guidelines on community.kde.org]
Vous pouvez lire les [https://community.kde.org/Guidelines_and_HOWTOs/Documentation_in_wikis instructions sur community.kde.org]


==Organisation==
== Organisation ==


{{TODO|need to document the structure}}
{{TODO/fr|besoin de documenter la structure}}


==Formatting==
== La mise en page ==


* The main MediaWiki site has [http://www.mediawiki.org/wiki/Help:Formatting a Wiki syntax guide]
* La page d'accueil du site MediaWiki comporte un [http://www.mediawiki.org/wiki/Help:Formatting guide de la syntaxe Wiki]
* UserBase has some [https://userbase.kde.org/Toolbox lists of formatting] that can be a useful reference, including templates that are specific to the KDE wikis.
* UserBase possède plusieurs [https://userbase.kde.org/Toolbox listes de formats] qui peuvent servir de référence, y compris les modèles spécifiques aux wikis KDE.
* Much of what applies to Wikipedia (except the templates) also applies here, including [http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup] and their [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet cheatsheet].
* Pratiquement tout ce qui couvre Wikipedia (sauf les modèles) s'applique également ici, y compris [http://en.wikipedia.org/wiki/Help:Wiki_markup le balisage Wiki] (Wiki markup) et le [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet résumé signalétique] (Wikitext Cheatsheet).


==Wiki Maintenance==
== Maintenance du Wiki ==


Maintaining a clean and useful wiki involves making sure content is up to date, there are no broken links, and all pages can be found (they are linked to from somewhere). The following special pages can help find issues that need fixing:
Maintenir un wiki propre et utile implique de s'assurer que le contenu est à jour, que tous les liens sont encore actifs, et que toutes les pages peuvent êtres accédées (c'est à dire que chacune est appelée de quelque part). Les pages spéciales suivantes peuvent vous aider à trouver les problèmes à résoudre :


; Issues which should be fixed as soon as possible
; Problèmes à résoudre en priorité
:[[Special:Lonelypages]]
:[[Special:Lonelypages|pages orphelines]]
:[[Special:BrokenRedirects]]
:[[Special:BrokenRedirects|redirections cassées]]
:[[Special:DoubleRedirects]]
:[[Special:DoubleRedirects|doubles redirections]]


; Issues which should be fixed in time
; Problèmes à résoudre ultérieurement
:[[Special:Wantedpages]]
:[[Special:Wantedpages|pages les plus demandées]]
:[[Special:Wantedcategories]]
:[[Special:Wantedcategories|catégories les plus demandées]]


You can also add a page to the [[:Category:Needs Attention|Needs Attention]] to flag it for later work by adding <nowiki>[[Category:Needs Attention]]</nowiki> to the page. Using [[Template:TODO]] will also add a page to this category.
En ajoutant <nowiki>[[Category:Needs Attention]]</nowiki> à la page, vous pouvez ajouter cette page à la catégorie [[:Category:Needs Attention|'requiert votre attention']] (Needs Attention) pour la marquer en tant que travail à faire plus tard. En utilisant [[Template:TODO]] vous ajoutez aussi cette page à la catégorie.


===Deleting pages===
=== Supprimer des pages ===


Most users cannot delete pages on the Wiki - this is because once a page is gone, you cannot get it back. If you think a page should be deleted, mark it with [[Template:Proposed_deletion]] at the top:
La plupart des utilisateurs ne peuvent pas supprimer les pages du Wiki - ceci est dû au fait que une fois que la page a été supprimée, vous ne pouvez pas la restituer. Si vous pensez qu'une page doit être supprimée, marquez la en insérant le modèle  [[Template:Proposed_deletion]] tout au début en indiquant, en anglais dans 'reason=', le motif de la supression :


{{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}}
{{Input|1=<nowiki>{{Proposed_deletion|reason=this page contains only spam}}</nowiki>}}

Latest revision as of 12:34, 18 May 2019

Other languages:

Cette page contient des informations concernant la manière de modifier le wiki TechBase de KDE, y compris l'emplacement des contenus ainsi que des outils spécifiques adaptés à ce wiki. Même si vous êtes familier avec les wikis, vous pouvez relire la section sur l'organisation pour savoir où placer votre contenu sur ce wiki.

Avant de commencer

Les premières choses d'abord

  • Notez bien que vous devez accepter que vos contributions à ce wiki soient placées sous les licences listées sur KDE TechBase:Copyrights. Ces licences signifient que ce que vous produisez peut être par exemple, recopié vers d'autres sites.
  • Utilisez les pages de discussion (Talk pages) pour communiquer avec les autres contributeurs ou pour demander de l'aide. Normalement quelqu'un vous répondra dans la journée.

Que trouve-t-on ici ?

Ce wiki concerne la documentation des développeurs voulant utiliser ou étendre les produits KDE (via les API) , ainsi que :

  • les informations générales sur les bibliothèques, y compris les avantages en les utilisant
  • les tutoriels et les exemples d'utilication des bibliothèques
  • les tutoriels, les exemples et la documentation pour écrire des plugins et d'autres extensions aux bibliothèques et aux applications
  • les interfaces IPC/RPC pour le logiciel, comme les interfaces de DBus


La documentation de l'utilisateur final est à placer dans le wiki UserBase. Les sujets relatifs aux contributeurs, aux équipes et à la communauté KDE en général sont dans le wiki de la communauté.

Exemples de ce qu'il ne faut pas mettre sur le wiki TechBase  :

  • la documentation sur la manière d'utiliser une application
  • les règles d'écriture du code
  • les informations pour les nouveaux contributeurs
  • la coordination de l'équipe (listes TODO à faire, les notes des réunions, etc...)
  • les notes sur l'architecture interne d'un morceau de logiciel (mais on peut mettre ici l'architecture de l'API d'une bibliothèque)

Vous pouvez lire les instructions sur community.kde.org

Organisation

noframe
noframe
 
À faire :
besoin de documenter la structure

La mise en page

Maintenance du Wiki

Maintenir un wiki propre et utile implique de s'assurer que le contenu est à jour, que tous les liens sont encore actifs, et que toutes les pages peuvent êtres accédées (c'est à dire que chacune est appelée de quelque part). Les pages spéciales suivantes peuvent vous aider à trouver les problèmes à résoudre :

Problèmes à résoudre en priorité
pages orphelines
redirections cassées
doubles redirections
Problèmes à résoudre ultérieurement
pages les plus demandées
catégories les plus demandées

En ajoutant [[Category:Needs Attention]] à la page, vous pouvez ajouter cette page à la catégorie 'requiert votre attention' (Needs Attention) pour la marquer en tant que travail à faire plus tard. En utilisant Template:TODO vous ajoutez aussi cette page à la catégorie.

Supprimer des pages

La plupart des utilisateurs ne peuvent pas supprimer les pages du Wiki - ceci est dû au fait que une fois que la page a été supprimée, vous ne pouvez pas la restituer. Si vous pensez qu'une page doit être supprimée, marquez la en insérant le modèle Template:Proposed_deletion tout au début en indiquant, en anglais dans 'reason=', le motif de la supression :

{{Proposed_deletion|reason=this page contains only spam}}