Tout les documents du site sont regroupés dans un arbre qui les regroupent tous, il est représenté dans l'administration par une arborescence qui permet d'évaluer visuellement la position de chaque document.
À la base un document se place à la racine de l'arborescence, mais il peut aussi être positionné comme sous-document d'un autre document qui devient alors son parent. Un sous-document est représenté dans l'arborescence sous son document parent et il est légèrement indenté vers la droite pour exprimer cette parenté.
Sachez que tout les documents à la racine de l'arborescence ne s'afficheront pas directement sur le Wiki si ils n'ont pas déja été prévus dans l'application. Et la création d'un nouveau document à la racine nécessitera une intervention manuelle sur la plateforme pour le rendre accessible depuis un nouveau lien.
Par contre tout les nouveaux sous-documents s'afficheront automatiquement sur le site (dans la navigation de leur parent) dès lors que leur gabarit le permet.
Selon le contexte du document, il peut s'avérer utile d'avoir une mise en page différente, c'est pourquoi il existe plusieurs gabarits prédéfinis. Vous pouvez choisir l'un d'entre eux à tout moment pour vos documents.
Les gabarits ne sont pas modifiables en ligne car ils sont "fondus" dans l'application. La partie de l'administration Django appelée "Gabarits" ne sert qu'à identifier les fichiers des gabarits mais l'ajout de nouveaux fichiers de gabarits nécessite une intervention manuelle sur la plateforme.
En règle général, on ne donne pas aux administrateurs normaux le droit d'accès à l'administration des gabarits.
Le gabarit par défaut d'une page d'un document. Il contient seulement le titre, le contenu du document et sa liste de fichiers attachés.
Un gabarit qui contient le titre, le contenu du document, sa liste de fichiers attachés et une liste du sommaire (affiché sous le contenu) de ses sous-documents si il en a.
Un gabarit composé deux cadres l'un à côté de l'autre :
Un gabarit composé deux cadres l'un à côté de l'autre :
C'est un gabarit spécial pour les documents qui n'ont pas leur propre page mais qui sont intégrés dans une page existante du site. Ce gabarit ne contient que le titre, le contenu du document et sa liste de fichiers attachés.
Il n'est pas à utiliser pour de nouveaux documents car ils les rendraient non affichables sur le site. En effet l'intégration d'un document dans une page nécessite une intervention sur l'application.
Cette partie d'un gabarit est une liste de tout les titres contenus dans un document, elle est représentée sous forme d'une liste à puces arborescente dont les titres sont indentés selon leur niveau d'importance (les plus gros titres à la racine et les plus petits indentés).
Chaque élément de la liste est un lien cliquable qui fait défiler le document vers le titre cible. Ceci est très utile dans le cadre de longs documents et il est alors recommandé de bien utiliser les titres pour indiquer ses différentes parties à la manière de l'index d'un livre.
Cette partie d'un gabarit est une liste des sous-documents existants pour le document en cours. Si le document n'en a aucun, cette liste ne s'affichera pas. Elle est représentée par une liste à puces arborescente dont l'indentation des éléments dépend de leur parenté (de la même manière que sur l'administration CMS).
Chaque élément de la liste est un lien cliquable qui amène le navigateur vers la page du document cible.
Cette partie d'un gabarit liste tout les fichiers attachés au document. Elle dépend de son option de visibilité dans le document.
L'insertion d'un fichier attaché dans un document passe par trois étapes :
Une fois attachés à un document, les fichiers deviennent disponibles dans une liste de sélection de l'éditeur de contenu du document, il suffit de les sélectionner et de cliquer sur l'icône (juste à droite de la liste) pour l'insérer sous forme d'une macro dans le contenu à la position du curseur de texte et sans avoir à inscrire directement le lien.
Le lien d'un fichier attaché apparaîtra alors dans le document à la position ou il a été inséré selon le comportement suivant :
Il n'est cependant pas nécessaire d'insérer de macro d'un fichier attaché dans un document, car ce dernier possède aussi une option Attachements > Listage des fichiers qui permet d'afficher après le contenu une liste de tout les fichiers attachés au document, suivant le même comportement pour le titre du lien.
Si vous supprimez une entrée de fichier d'attachement, cela ne détériorera pas les documents qui l'utilisaient. L'entrée sera simplement supprimée de la liste des fichiers attachés aux documents et les macros liés seront simplement "avalés" dans le contenu comme si ils n'existaient pas.
Cependant il est fortement recommandé, de tenir à jour les documents pour ne pas laisser des macros de fichiers qui n'existent plus, afin d'éviter les confusions et la pollution inutile dans la rédaction du contenu.
Un document possède plusieurs options et paramètres à définir, certains étant optionnels.
Qui détermine la parenté vers un autre document, par défaut un nouveau document n'a pas de parent, il est donc destiné à être à la racine de l'arborescence des documents.
Cette option n'est utile que dans le cadre d'un sous-document, il permet d'ajuster sa position dans le sommaire des sous-documents de leur parent.
Par défaut les documents sont triés par ordre alphabétique croissant, un document "A" se trouvera avant un document "B" et ainsi de suite. Mais si un ordre est spécifié, il prendra le dessus sur le tri alphabétique. Par exemple pour les documents suivants :
- Altaïr (ordre: 10) - Bubble-gum (ordre: 5) - Canelle (ordre: 0)
Le résultat dans la liste des sous-documents sera trié de la façon suivante :
- Canelle - Bubble-gum - Altaïr
Si jamais deux documents ont le même ordre, le tri alphabétique arbitrera l'ordre final.
L'ordre est numérique, vous pouvez utilisez un nombre de 0 à 5000 si vous le souhaitez, en général on numérote l'ordre des documents par tranches de 5 ou 10 ce qui laisse une marge pour l'arrivée de nouveaux documents et éviter de devoir renuméroter tout les autres documents manuellement.
C'est le mot clé utilisé dans l'URL pour retrouvé un document sur le site, il ne peut comporter de caractères spéciaux autres que ``-_`` ni de caractères accentués. Deux documents ne peuvent avoir la même URI pour des raisons évidentes, mais l'administration vous empêchera de toute façons de faire cette erreur.
L'administration remplie automatiquement ce champ d'après le titre saisie, en général il n'est donc pas utile de s'en préocupper et de le remplir manuellement. Surveillez juste simplement que la conversion du titre en URI n'aboutit pas à des incongruités.
C'est le titre du document utilisé et affiché dans les navigations en entête de la page d'un document (non intégré).
La source de votre texte qui sera convertie en HTML d'après la syntaxe de mise en forme que vous y aurez appliqué. Un éditeur de mise en forme avec prévisualisation du rendu de mise en forme s'ouvrira à chaque fois que vous souhaitez l'éditer dans l'administration.
Cette option permet de désactiver l'affichage du document dans toute les listes de documents qui le contiennent.
Si vous utilisez un gabarit du type *document intégré* cette option est automatiquement décochée lors de l'enregistrement, cependant si vous changez après pour un gabarit de *page complète* il vous faudra la réactiver manuellement dans l'administration pour que votre page redevienne visible sur le site.
Une option qui permet de rendre totalement inaccessible le document, il n'apparait plus dans les listes de document et il n'est plus atteignable. Ceci vous permet d'archiver un document temporairement ou non, sans le supprimer complètement.
Des liens figés vers les documents à la racine de l'arborescence existent dans l'application, si vous désactivez ces documents, leurs liens resteront visibles sur le site et conduiront alors à une page d'erreur (*Page introuvable*), donc dans leur cas n'y touchez pas.
La séléction du gabarit de mise en page du document, il est optionnel et en cas de séléction vide le gabarit par défaut sera utilisé.
Une liste de séléctions multiples de fichiers d'attachements à attacher au document. N'oubliez pas de sauvegarder vos changements dessus si vous souhaitez les intégrer comme macros dans le document car tant que les changements n'auront pas été enregistrés ils n'apparaitront pas dans la liste de séléction de l'éditeur de contenu.
Option qui permet d'afficher la liste complète des fichiers attachés au document. Par défaut cette option n'est pas cochée, la liste ne s'affichera donc pas. Cette liste a l'intérêt de résumer la liste complète de tout les fichiers sans avoir obligatoirement à les insérer comme macro dans le document.
Les révisions étant des archives de précédentes versions de documents, leur représentation dans l'administration est identique aux documents à ceci près qu'il y a un paramètre **Document** supplémentaire pour définir le document dont est issue la révision.
En général, vous ne modifierez pas ces révisions, car elles ont un rôle d'historique et les modifier le troublerait.