From 1e28f7758f2dcade85900217605b01b3b2b07490 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Lang Date: Fri, 17 Aug 2007 15:53:39 +0000 Subject: [PATCH] Added wiki syntax to online help. git-svn-id: http://redmine.rubyforge.org/svn/trunk@655 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- config/help.yml | 7 +- doc/docbook/en/redmine-userdoc-en.xml | 141 +++++++++++++++++++++++++ doc/docbook/fr/redmine-userdoc-fr.xml | 142 ++++++++++++++++++++++++++ public/manual/en/ch02.html | 2 +- public/manual/en/ch02s09.html | 2 +- public/manual/en/ch02s10.html | 2 +- public/manual/en/ch02s11.html | 3 + public/manual/en/ch03.html | 2 +- public/manual/en/ch03s01.html | 2 +- public/manual/en/ch03s02.html | 2 +- public/manual/en/ch03s03.html | 2 +- public/manual/en/ch03s04.html | 2 +- public/manual/en/html.css | 6 ++ public/manual/en/index.html | 2 +- public/manual/fr/ch02.html | 2 +- public/manual/fr/ch02s09.html | 2 +- public/manual/fr/ch02s10.html | 2 +- public/manual/fr/ch02s11.html | 2 +- public/manual/fr/ch03.html | 2 +- public/manual/fr/ch03s01.html | 2 +- public/manual/fr/ch03s02.html | 2 +- public/manual/fr/ch03s03.html | 2 +- public/manual/fr/ch03s04.html | 2 +- public/manual/fr/html.css | 6 ++ public/manual/fr/index.html | 2 +- 25 files changed, 321 insertions(+), 22 deletions(-) create mode 100644 public/manual/en/ch02s11.html diff --git a/config/help.yml b/config/help.yml index 0315aad24..80559cbd7 100644 --- a/config/help.yml +++ b/config/help.yml @@ -57,13 +57,13 @@ pages: list_issues: ch02s03.html add_news: ch02s06.html list_news: ch02s06.html - add_file: ch02s08.html - list_files: ch02s08.html + add_file: ch02s11.html + list_files: ch02s11.html changelog: ch02s05.html issues: index: ch02s03.html documents: - index: ch02s07.html + index: ch02s09.html news: index: ch02s06.html versions: @@ -80,4 +80,5 @@ pages: lost_password: ch03s03.html register: ch03s04.html wiki: + index: ch02s10.html syntax: wiki_syntax.html \ No newline at end of file diff --git a/doc/docbook/en/redmine-userdoc-en.xml b/doc/docbook/en/redmine-userdoc-en.xml index d3093114d..44f9c5f2a 100644 --- a/doc/docbook/en/redmine-userdoc-en.xml +++ b/doc/docbook/en/redmine-userdoc-en.xml @@ -907,6 +907,147 @@ versions). +
+ Wiki + + + +
+ Wiki syntax + + + +
+ Formatting + + + + + + *bold* + + + + _italic_ + + + + +underline+ + + + + -strike- + + + + ??inline quote?? + + + + @code@ + + + + h1. page title + + + + h2. level 2 title + + + + h3. level 3 title + + + + +
+ +
+ Links + + + + + + External link : http://www.redmine.org + + + + External link with specific text : + "Redmine":http://www.redmine.org + + + + Link to an other wiki page (can be a page from an other + project wiki) : + + + + [[Page name]] + + + + [[Page name|Title]] + + + + [[Project:]] + + + + [[Project:|Title]] + + + + [[Project:Page name]] + + + + [[Project:Page name|Title]] + + + + + + + + Link to an issue : #52 + + + + Link to a changeset : r52 + + +
+ +
+ Embedded images + + + + + + External image : + !http://foo.bar/my_image.jpg! + + + + Image attached to the wiki page : + !my_image.jpg! + + + + Right floating image : + !>my_image.jpg! + + + + +
+
+
+
Files diff --git a/doc/docbook/fr/redmine-userdoc-fr.xml b/doc/docbook/fr/redmine-userdoc-fr.xml index 966f1446f..4b5dd09d3 100644 --- a/doc/docbook/fr/redmine-userdoc-fr.xml +++ b/doc/docbook/fr/redmine-userdoc-fr.xml @@ -1011,6 +1011,148 @@ révisions ou versions successives).
+
+ Wiki + + + +
+ Syntaxe wiki + + + +
+ Mise en forme + + + + + + *gras* + + + + _italique_ + + + + +souligné+ + + + + -rayé- + + + + ??citation?? + + + + @code@ + + + + h1. titre de la page + + + + h2. titre de niveau 2 + + + + h3. titre de niveau 3 + + + + +
+ +
+ Liens + + + + + + Lien externe : http://www.redmine.org + + + + Lien externe avec texte spécifique : + "Redmine":http://www.redmine.org + + + + Lien vers une page wiki (éventuellement d'un autre projet) + : + + + + [[Nom de page]] + + + + [[Nom de page|Titre]] + + + + [[Projet:]] + + + + [[Projet:|Titre]] + + + + [[Projet:Nom de page]] + + + + [[Projet:Nom de page|Titre]] + + + + + + + + Lien vers une demande : #52 + + + + Lien vers une révision du dépôt (commit) : + r52 + + +
+ +
+ Images + + + + + + Image externe : + !http://foo.bar/mon_image.jpg! + + + + Image attachée à la page wiki : + !mon_image.jpg! + + + + Image flotante à droite : + !>mon_image.jpg! + + + + +
+
+
+
Fichiers diff --git a/public/manual/en/ch02.html b/public/manual/en/ch02.html index 34af72676..ceba59301 100644 --- a/public/manual/en/ch02.html +++ b/public/manual/en/ch02.html @@ -1,3 +1,3 @@ - Chapter 2. Projectsredmine \ No newline at end of file + Chapter 2. Projectsredmine \ No newline at end of file diff --git a/public/manual/en/ch02s09.html b/public/manual/en/ch02s09.html index 2bf83d94a..c47e70967 100644 --- a/public/manual/en/ch02s09.html +++ b/public/manual/en/ch02s09.html @@ -1,3 +1,3 @@ - 9. Documentsredmine

9. Documents

Documents are grouped by categories (see Value Lists). A document can contain several files (for example: revisions or successive versions).

\ No newline at end of file + 9. Documentsredmine

9. Documents

Documents are grouped by categories (see Value Lists). A document can contain several files (for example: revisions or successive versions).

\ No newline at end of file diff --git a/public/manual/en/ch02s10.html b/public/manual/en/ch02s10.html index 8ab33bf7f..862db2301 100644 --- a/public/manual/en/ch02s10.html +++ b/public/manual/en/ch02s10.html @@ -1,3 +1,3 @@ - 10. Filesredmine

10. Files

This module allows you to display various folders (sources, binaires, ...) for each version of the application.

\ No newline at end of file + 10. Wikiredmine

10. Wiki

10.1. Wiki syntax

10.1.1. Formatting

  • *bold*

  • _italic_

  • +underline+

  • -strike-

  • ??inline quote??

  • @code@

  • h1. page title

  • h2. level 2 title

  • h3. level 3 title

10.1.2. Links

  • External link : http://www.redmine.org

  • External link with specific text : "Redmine":http://www.redmine.org

  • Link to an other wiki page (can be a page from an other project wiki) :

    • [[Page name]]

    • [[Page name|Title]]

    • [[Project:]]

    • [[Project:|Title]]

    • [[Project:Page name]]

    • [[Project:Page name|Title]]

  • Link to an issue : #52

  • Link to a changeset : r52

10.1.3. Embedded images

  • External image : !http://foo.bar/my_image.jpg!

  • Image attached to the wiki page : !my_image.jpg!

  • Right floating image : !>my_image.jpg!

\ No newline at end of file diff --git a/public/manual/en/ch02s11.html b/public/manual/en/ch02s11.html new file mode 100644 index 000000000..86bce49c8 --- /dev/null +++ b/public/manual/en/ch02s11.html @@ -0,0 +1,3 @@ + + + 11. Filesredmine

11. Files

This module allows you to display various folders (sources, binaires, ...) for each version of the application.

\ No newline at end of file diff --git a/public/manual/en/ch03.html b/public/manual/en/ch03.html index aeb4e89fe..b2e0d2179 100644 --- a/public/manual/en/ch03.html +++ b/public/manual/en/ch03.html @@ -1,3 +1,3 @@ - Chapter 3. User accountsredmine \ No newline at end of file + Chapter 3. User accountsredmine \ No newline at end of file diff --git a/public/manual/en/ch03s01.html b/public/manual/en/ch03s01.html index 36cc576ec..4b136be32 100644 --- a/public/manual/en/ch03s01.html +++ b/public/manual/en/ch03s01.html @@ -1,3 +1,3 @@ - 1. My accountredmine

1. My account

1.1. Information

This screen allows you to modify your account: lastname, firstname, email address, language.

If Mail notifications is unchecked, no email will be sent to you.

1.2. Password

To change your password, type your old password and your new password (twice). Password length must be between 4 and 12 characters.

If your account uses an external authentication (LDAP), you can't change your password in redMine.

\ No newline at end of file + 1. My accountredmine

1. My account

1.1. Information

This screen allows you to modify your account: lastname, firstname, email address, language.

If Mail notifications is unchecked, no email will be sent to you.

1.2. Password

To change your password, type your old password and your new password (twice). Password length must be between 4 and 12 characters.

If your account uses an external authentication (LDAP), you can't change your password in redMine.

\ No newline at end of file diff --git a/public/manual/en/ch03s02.html b/public/manual/en/ch03s02.html index 9170837c6..09a1f5216 100644 --- a/public/manual/en/ch03s02.html +++ b/public/manual/en/ch03s02.html @@ -1,3 +1,3 @@ - 2. My pageredmine

2. My page

This page allows you to display various information about your projects.

To personalize your page, click on Personalize this page. Then you can choose which information to display and where it is displayed.

\ No newline at end of file + 2. My pageredmine

2. My page

This page allows you to display various information about your projects.

To personalize your page, click on Personalize this page. Then you can choose which information to display and where it is displayed.

\ No newline at end of file diff --git a/public/manual/en/ch03s03.html b/public/manual/en/ch03s03.html index e7840caa7..c05f727fe 100644 --- a/public/manual/en/ch03s03.html +++ b/public/manual/en/ch03s03.html @@ -1,3 +1,3 @@ - 3. Password lostredmine

3. Password lost

If you loose your forget, a procedure allows you to choose a new one.

On the login screen, click on Lost password. Type your email address and submit the form. An email is then sent to you. It contains a link that allows you to change your password.

If your account uses an external authentication (LDAP), this procedure isn't be available.

\ No newline at end of file + 3. Password lostredmine

3. Password lost

If you loose your forget, a procedure allows you to choose a new one.

On the login screen, click on Lost password. Type your email address and submit the form. An email is then sent to you. It contains a link that allows you to change your password.

If your account uses an external authentication (LDAP), this procedure isn't be available.

\ No newline at end of file diff --git a/public/manual/en/ch03s04.html b/public/manual/en/ch03s04.html index 6c4cf0b15..0b1e1375b 100644 --- a/public/manual/en/ch03s04.html +++ b/public/manual/en/ch03s04.html @@ -1,3 +1,3 @@ - 4. Registerredmine

4. Register

By registering, you can get an account without the intervention of the administrator.

On the login screen, click on Register. Fill the form and submit it. An email will be sent to you. To activate your account, use the link that is contained in this mail.

The possibility to register can be desactived in the application configuration.

\ No newline at end of file + 4. Registerredmine

4. Register

By registering, you can get an account without the intervention of the administrator.

On the login screen, click on Register. Fill the form and submit it. An email will be sent to you. To activate your account, use the link that is contained in this mail.

The possibility to register can be desactived in the application configuration.

\ No newline at end of file diff --git a/public/manual/en/html.css b/public/manual/en/html.css index c5eb0ef96..c9594a30b 100644 --- a/public/manual/en/html.css +++ b/public/manual/en/html.css @@ -54,6 +54,12 @@ pre.programlisting { white-space: pre; } +code.code { + padding: 2px; + font-size: 10pt; + white-space: pre; +} + li p { margin-top: 3px; margin-bottom: 3px; diff --git a/public/manual/en/index.html b/public/manual/en/index.html index 3cc024ef7..def950c3b 100644 --- a/public/manual/en/index.html +++ b/public/manual/en/index.html @@ -1,3 +1,3 @@ - Documentationredmine \ No newline at end of file + Documentationredmine \ No newline at end of file diff --git a/public/manual/fr/ch02.html b/public/manual/fr/ch02.html index d86096430..da882ffcb 100644 --- a/public/manual/fr/ch02.html +++ b/public/manual/fr/ch02.html @@ -1,3 +1,3 @@ - Chapter 2. Projetsredmine \ No newline at end of file + Chapter 2. Projetsredmine \ No newline at end of file diff --git a/public/manual/fr/ch02s09.html b/public/manual/fr/ch02s09.html index 0560b3cc8..300652e95 100644 --- a/public/manual/fr/ch02s09.html +++ b/public/manual/fr/ch02s09.html @@ -1,3 +1,3 @@ - 9. Documentsredmine

9. Documents

Les documents sont groupés par catégories (voir Listes de valeurs). Un document peut contenir plusieurs fichiers (exemple: révisions ou versions successives).

\ No newline at end of file + 9. Documentsredmine

9. Documents

Les documents sont groupés par catégories (voir Listes de valeurs). Un document peut contenir plusieurs fichiers (exemple: révisions ou versions successives).

\ No newline at end of file diff --git a/public/manual/fr/ch02s10.html b/public/manual/fr/ch02s10.html index 830747645..8f53b0d88 100644 --- a/public/manual/fr/ch02s10.html +++ b/public/manual/fr/ch02s10.html @@ -1,3 +1,3 @@ - 10. Fichiersredmine

10. Fichiers

Ce module vous permet de publier les différents fichiers (sources, binaires, ...) pour chaque version du projet.

\ No newline at end of file + 10. Wikiredmine

10. Wiki

10.1. Syntaxe wiki

10.1.1. Mise en forme

  • *gras*

  • _italique_

  • +souligné+

  • -rayé-

  • ??citation??

  • @code@

  • h1. titre de la page

  • h2. titre de niveau 2

  • h3. titre de niveau 3

10.1.2. Liens

  • Lien externe : http://www.redmine.org

  • Lien externe avec texte spécifique : "Redmine":http://www.redmine.org

  • Lien vers une page wiki (éventuellement d'un autre projet) :

    • [[Nom de page]]

    • [[Nom de page|Titre]]

    • [[Projet:]]

    • [[Projet:|Titre]]

    • [[Projet:Nom de page]]

    • [[Projet:Nom de page|Titre]]

  • Lien vers une demande : #52

  • Lien vers une révision du dépôt (commit) : r52

10.1.3. Images

  • Image externe : !http://foo.bar/mon_image.jpg!

  • Image attachée à la page wiki : !mon_image.jpg!

  • Image flotante à droite : !>mon_image.jpg!

\ No newline at end of file diff --git a/public/manual/fr/ch02s11.html b/public/manual/fr/ch02s11.html index 22da267e2..d68061fc6 100644 --- a/public/manual/fr/ch02s11.html +++ b/public/manual/fr/ch02s11.html @@ -1,3 +1,3 @@ - 11. Configuration du projetredmine

11. Configuration du projet

\ No newline at end of file + 11. Fichiersredmine

11. Fichiers

Ce module vous permet de publier les différents fichiers (sources, binaires, ...) pour chaque version du projet.

\ No newline at end of file diff --git a/public/manual/fr/ch03.html b/public/manual/fr/ch03.html index b39193e78..12f01495f 100644 --- a/public/manual/fr/ch03.html +++ b/public/manual/fr/ch03.html @@ -1,3 +1,3 @@ - Chapter 3. Comptes utilisateursredmine \ No newline at end of file + Chapter 3. Comptes utilisateursredmine \ No newline at end of file diff --git a/public/manual/fr/ch03s01.html b/public/manual/fr/ch03s01.html index 0b33b69ad..ce1391118 100644 --- a/public/manual/fr/ch03s01.html +++ b/public/manual/fr/ch03s01.html @@ -1,3 +1,3 @@ - 1. Mon compteredmine

1. Mon compte

1.1. Informations

Cet écran vous permet de modifier les informations relatives à votre compte: nom, prénom, adresse mail, langue (Anglais, Allemand, Espagnol ou Français).

Si la case Notifications par mail est décochée, aucune notification par mail ne vous sera envoyée.

1.2. Changement de mot de passe

Pour changer votre mot de passe, saisissez votre mot de passe actuel et le nouveau mot de passe souhaité (double saisie pour confirmation). Le mot de passe doit avoir une longueur comprise entre 4 et 12 caractères.

Si votre compte utilise une authentification externe (un annuaire LDAP), vous ne pouvez pas changer votre mot de passe dans redMine.

\ No newline at end of file + 1. Mon compteredmine

1. Mon compte

1.1. Informations

Cet écran vous permet de modifier les informations relatives à votre compte: nom, prénom, adresse mail, langue (Anglais, Allemand, Espagnol ou Français).

Si la case Notifications par mail est décochée, aucune notification par mail ne vous sera envoyée.

1.2. Changement de mot de passe

Pour changer votre mot de passe, saisissez votre mot de passe actuel et le nouveau mot de passe souhaité (double saisie pour confirmation). Le mot de passe doit avoir une longueur comprise entre 4 et 12 caractères.

Si votre compte utilise une authentification externe (un annuaire LDAP), vous ne pouvez pas changer votre mot de passe dans redMine.

\ No newline at end of file diff --git a/public/manual/fr/ch03s02.html b/public/manual/fr/ch03s02.html index 159182bf4..012630b93 100644 --- a/public/manual/fr/ch03s02.html +++ b/public/manual/fr/ch03s02.html @@ -1,3 +1,3 @@ - 2. Ma pageredmine

2. Ma page

Cette page vous permet d'afficher de manière synthétique des informations sur vos projets.

Pour personnaliser votre page, cliquer sur le lien Personnaliser cette page. Vous pouvez alors sélectionner les informations à afficher et les positionner où vous le souhaitez sur la page, par glisser-déposer.

\ No newline at end of file + 2. Ma pageredmine

2. Ma page

Cette page vous permet d'afficher de manière synthétique des informations sur vos projets.

Pour personnaliser votre page, cliquer sur le lien Personnaliser cette page. Vous pouvez alors sélectionner les informations à afficher et les positionner où vous le souhaitez sur la page, par glisser-déposer.

\ No newline at end of file diff --git a/public/manual/fr/ch03s03.html b/public/manual/fr/ch03s03.html index ee5d83816..54d6f6171 100644 --- a/public/manual/fr/ch03s03.html +++ b/public/manual/fr/ch03s03.html @@ -1,3 +1,3 @@ - 3. Mot de passe perduredmine

3. Mot de passe perdu

En cas de perte de votre mot de passe, une procédure par mail vous permet d'en choisir un nouveau.

Sur l'écran d'authentification, cliquez sur Mot de passe perdu. Saisissez ensuite votre adresse mail dans le champ prévu et validez. Un mail vous est alors transmis. Il contient un lien qui vous permettra d'accéder à la page de choix du nouveau mot de passe.

Si votre compte utilise une authentification externe (un annuaire LDAP), cette procédure n'est pas disponible.

\ No newline at end of file + 3. Mot de passe perduredmine

3. Mot de passe perdu

En cas de perte de votre mot de passe, une procédure par mail vous permet d'en choisir un nouveau.

Sur l'écran d'authentification, cliquez sur Mot de passe perdu. Saisissez ensuite votre adresse mail dans le champ prévu et validez. Un mail vous est alors transmis. Il contient un lien qui vous permettra d'accéder à la page de choix du nouveau mot de passe.

Si votre compte utilise une authentification externe (un annuaire LDAP), cette procédure n'est pas disponible.

\ No newline at end of file diff --git a/public/manual/fr/ch03s04.html b/public/manual/fr/ch03s04.html index f886ffdd9..69e79c867 100644 --- a/public/manual/fr/ch03s04.html +++ b/public/manual/fr/ch03s04.html @@ -1,3 +1,3 @@ - 4. S'enregistrerredmine

4. S'enregistrer

L'enregistrement vous permet d'obtenir un compte sans intervention de l'administrateur.

Sur l'écran d'authentification, cliquez sur S'enregistrer. Complétez le formulaire d'inscription et validez. Un mail vous est alors transmis. Pour activer votre compte, utilisez le lien présent dans le mail qui vous a été envoyé.

La possibilité de s'enregistrer peut avoir été désactivée par l'administrateur.

\ No newline at end of file + 4. S'enregistrerredmine

4. S'enregistrer

L'enregistrement vous permet d'obtenir un compte sans intervention de l'administrateur.

Sur l'écran d'authentification, cliquez sur S'enregistrer. Complétez le formulaire d'inscription et validez. Un mail vous est alors transmis. Pour activer votre compte, utilisez le lien présent dans le mail qui vous a été envoyé.

La possibilité de s'enregistrer peut avoir été désactivée par l'administrateur.

\ No newline at end of file diff --git a/public/manual/fr/html.css b/public/manual/fr/html.css index c5eb0ef96..c9594a30b 100644 --- a/public/manual/fr/html.css +++ b/public/manual/fr/html.css @@ -54,6 +54,12 @@ pre.programlisting { white-space: pre; } +code.code { + padding: 2px; + font-size: 10pt; + white-space: pre; +} + li p { margin-top: 3px; margin-bottom: 3px; diff --git a/public/manual/fr/index.html b/public/manual/fr/index.html index 872c1b99b..f9d20c11f 100644 --- a/public/manual/fr/index.html +++ b/public/manual/fr/index.html @@ -1,3 +1,3 @@ - Documentationredmine \ No newline at end of file + Documentationredmine \ No newline at end of file