Changes between Version 2 and Version 3 of Doc/ProjStruct


Ignore:
Timestamp:
Oct 30, 2006, 2:41:50 PM (19 years ago)
Author:
/C=FR/O=CNRS/OU=UMR8607/CN=Christian Helft/emailAddress=helft@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Doc/ProjStruct

    v2 v3  
    1 = Recommandations pour la Structuration d'un Projet =
     1= Recommandations pour la structuration d'un projet =
    22[[TracNav]]
    33
    … …  
    2727Il y a plusieurs avantages à une telle structuration :
    2828
    29  * Si on demande la liste de [wiki:TitleIndex toutes les pages] du !WiKi, on visualise plus facilement les pages qui ont un lien entre elle. On peut obtenir un effet similaire en utilisant un préfixe commun aux pages traitant du même sujet. Mais ce sera moins exploitable par les outils de navigation décrits plus loin...
     29 * Si on demande la liste de [wiki:TitleIndex toutes les pages] du !WiKi, on visualise plus facilement les pages qui ont un lien entre elles. On peut obtenir un effet similaire en utilisant un préfixe commun aux pages traitant du même sujet. Mais ce sera moins exploitable par les outils de navigation décrits plus loin...
    3030 * En l'absence de tags attachés aux pages, on va pouvoir exploiter cette structure hiérarchique pour offrir une navigation facile dans l'ensemble des documents.
    3131
    32 Il est important de prendre le temps pour organiser la structure avant de créer les pages car la modification ultérieure du nom des pages (possible uniquement en copiant/collant le contenu de pages existantes dans de nouvelles pages) cassera inévitablement les références entre page.
     32Il est important de prendre le temps pour organiser la structure avant de créer les pages car la modification ultérieure du nom des pages (possible uniquement en copiant/collant le contenu de pages existantes dans de nouvelles pages) cassera inévitablement les références entre pages.
    3333
    3434== Barre de Navigation ==
    … …  
    3636=== Configuration ===
    3737
    38 Il y a plusieurs facons de construire des menus de navigation. Celle décrite ici repose sur l'utilisation du macro [http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav/Usage TracNav], utilisé dans cette page. !TracNav offre plusieurs fonctionnalités intéressantes :
     38Il y a plusieurs façons de construire des menus de navigation. Celle décrite ici repose sur l'utilisation de la macro [http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav/Usage TracNav], utilisée dans cette page. !TracNav offre plusieurs fonctionnalités intéressantes :
    3939
    4040 * La description des menus disponibles se fait dans une page !WiKi standard en utilisant des listes à puce.
    4141 * On peut avoir plusieurs niveaux de menus en imbriquant les listes à puces
    42  * Lorsqu'il y a plusieurs niveaux, seul la catégorie correspondant au document courant est déroulé, ce qui permet de conserver un menu de navigation court avec un grand nombre de documents.
     42 * Lorsqu'il y a plusieurs niveaux, seule la catégorie correspondant au document courant est déroulée, ce qui permet de conserver un menu de navigation court avec un grand nombre de documents.
    4343
    44 Pour utiliser [http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav/Usage TracNav], il suffit de placer l'appel du macro en tête de toutes les pages qui doivent afficher le menu de navigation, généralement après le titre, avec les instructions suivantes :
     44Pour utiliser [http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav/Usage TracNav], il suffit de placer l'appel de la macro en tête de toutes les pages qui doivent afficher le menu de navigation, généralement après le titre, avec les instructions suivantes :
    4545
    4646{{{
    … …  
    7575}}}
    7676
    77 Les éléments des listes à puce peuvent être soit du texte litéral, soit des [http://trac.lal.in2p3.fr/W2KIN2P3/wiki/WikiFormatting références] à des pages Wiki avec la syntaxe explicite utilisé ici.
     77Les éléments des listes à puce peuvent être soit du texte litéral, soit des [http://trac.lal.in2p3.fr/W2KIN2P3/wiki/WikiFormatting références] à des pages Wiki avec la syntaxe explicite utilisée ici.
    7878
    79 Si on visualite une page qui fait appel à !TracNav mais n'est pas listé dans la page TOC, l'ensemble du menu apparait déroulé. Si la page se trouve dans le menu TOC, la partie du menu auquel elle appartient est déroulée et les autres sont repliées et transformées en lien. La partie déroulée apparaît toujours en tête.
     79Si on visualise une page qui fait appel à !TracNav mais n'est pas listée dans la page TOC, l'ensemble du menu apparait déroulé. Si la page se trouve dans le menu TOC, la partie du menu auquel elle appartient est déroulée et les autres sont repliées et transformées en lien. La partie déroulée apparaît toujours en tête.
    8080
    8181Lorsqu'on clique sur un lien qui a des sous menus, le document associé à ce lien s'ouvre. Il faut mettre dans le menu une deuxième entrée associée au même document (mais éventuellement avec un autre texte) pour que la page correspondante soit considérée répertoriée dans le TOC. C'est la raison des répétitions comme :
    … …  
    8989=== Ajouter de nouvelles entrées ===
    9090
    91 Pour ajouter une entrée dans le menu, il suffit de l'éditer avec le menu ''edit''. On peut référencer une page existante mais on peut aussi nommer une nouvelle page. En effet, c'est une fonctionnalité de base de TracWiki : si on référence une page inexistance, cela donne accès à une page permettant de la créer. C'est donc souvent le moyen le plus simple de créer de nouvelles pages, en étant sur que la référence sera correcte.
     91Pour ajouter une entrée dans le menu, il suffit de l'éditer avec le menu ''edit''. On peut référencer une page existante mais on peut aussi nommer une nouvelle page. En effet, c'est une fonctionnalité de base de TracWiki : si on référence une page inexistance, cela donne accès à une page permettant de la créer. C'est donc souvent le moyen le plus simple de créer de nouvelles pages, en étant sûr que la référence sera correcte.
    9292
    9393
    9494=== Conséquence sur l'organisation des pages ===
    9595
    96 A chaque niveau de menu, il peut être intéressant d'associer un niveau de hiérarchie dans le nommage des pages. Pour chaque niveau ainsi créer, la recommandation est de créer une page portant le même nom que le niveau et qui deviendra la page d'aperçu du niveau correspondant. Voir la structuration de ce site pour des exemples.
     96A chaque niveau de menu, il peut être intéressant d'associer un niveau de hiérarchie dans le nommage des pages. Pour chaque niveau ainsi créée, la recommandation est de créer une page portant le même nom que le niveau et qui deviendra la page d'aperçu du niveau correspondant. Voir la structuration de ce site pour des exemples.
    9797
    9898=== Index des pages d'une catégorie ===
    … …  
    115115Cela produit une liste de toutes les pages de la catégorie, avec le titre de la page en description.
    116116
    117 Il est aussi possible d'utiliser le macro TitleIndex au lieu [wiki:Doc/Macros#TOC TOC]. Dans ce cas, la liste ne contient que le nom des pages, sans le titre.
     117Il est aussi possible d'utiliser la macro TitleIndex au lieu de [wiki:Doc/Wiki/Macros#TOC TOC]. Dans ce cas, la liste ne contient que le nom des pages, sans le titre.
    118118
    119119
    120120== Table des Matières ==
    121121
    122 Quand on écrit des pages un peu longues, il peut être intéressant de générer en tête de la page une table des matières à partir de la structure de la pages (les différents niveaux de titre). Cela se fait très simplement en ajoutant au début de la page (généralement après l'appel à !TracNav) un appel au macro [wiki:Doc/Macros#TOC TOC]. Par exemple :
     122Quand on écrit des pages un peu longues, il peut être intéressant de générer en tête de la page une table des matières à partir de la structure de la pages (les différents niveaux de titre). Cela se fait très simplement en ajoutant au début de la page (généralement après l'appel à !TracNav) un appel à la macro [wiki:Doc/Wiki/Macros#TOC TOC]. Par exemple :
    123123
    124124{{{
    … …  
    130130Pour un exemple, éditer cette page.
    131131
    132 La macro [wiki:Doc/Macros#TOC TOC] permet aussi de faire la table des matières de une ou plusieurs autres pages, en les passant leur nom en paramètre de la macro.
     132La macro [wiki:Doc/Wiki/Macros#TOC TOC] permet aussi de faire la table des matières de une ou plusieurs autres pages, en les passant leur nom en paramètre de la macro.
    133133
    134134== Page de démarrage ==