From f0faa769a189b0ed27231830d230a6d0ab6cd29d Mon Sep 17 00:00:00 2001 From: Arnaud-D <35631001+Arnaud-D@users.noreply.github.com> Date: Sun, 28 Apr 2024 20:56:21 +0200 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/source/back-end/contents.rst | 39 ++++++++++++-------------------- 1 file changed, 14 insertions(+), 25 deletions(-) diff --git a/doc/source/back-end/contents.rst b/doc/source/back-end/contents.rst index 0c1d11956e..2d7245a66f 100644 --- a/doc/source/back-end/contents.rst +++ b/doc/source/back-end/contents.rst @@ -1,6 +1,6 @@ -========================= -Les tutoriels et articles -========================= +================================ +Les tutoriels, articles, billets +================================ Vocabulaire et définitions ========================== @@ -50,38 +50,36 @@ Un contenu Un **contenu** est un agencement particulier de conteneurs et d'extraits. Il est décrit par des métadonnées (*metadata*), détaillées -`ici <./contents_manifest.html>`__. Une de ces métadonnées est le type : article -ou tutoriel. Leur visée pédagogique diffère, mais aussi leur structure : un -article ne peut comporter de conteneurs, seulement des extraits, ce qui n'est -pas le cas d'un tutoriel. +`ici <./contents_manifest.html>`__. Une de ces métadonnées est le type : article, tutoriel ou billet. -Les exemples suivants devraient éclairer ces notions. +Techniquement, le type n'a pas d'influencevsur la structure du contenu. On rencontre cependant +des structures typiques selon la longueur du contenu. -Communément appelé « mini-tutoriel » : +Structure typique pour un contenu court : .. sourcecode:: none - + Tutoriel + + Contenu + Section + Section + Section -Communément appelé « moyen-tutoriel » : +Structure typique pour un contenu de taille moyenne : .. sourcecode:: none - + Tutoriel + + Contenu + Partie + Section + Partie + Section + Section -Communément appelé « big-tutoriel » : +Structure typique pour un contenu long : .. sourcecode:: none - + Tutoriel + + Contenu + Partie + Chapitre + Section @@ -93,7 +91,7 @@ Communément appelé « big-tutoriel » : + Section + Section -On peut aussi faire un mélange des conteneurs : +Des structures plus complexes sont possibles, avec des niveaux de conteneurs différents selon les parties : .. sourcecode:: none @@ -107,7 +105,7 @@ On peut aussi faire un mélange des conteneurs : + Chapitre + Section -Mais pas de conteneurs et d'extraits adjacents : +Il n'est pas possible d'avoir à la fois des conteneurs et des extraits au même niveau : .. sourcecode:: none @@ -122,15 +120,6 @@ Mais pas de conteneurs et d'extraits adjacents : + Section + Section /!\ Impossible ! -Pour finir, un article. Même structure qu'un mini-tutoriel, mais vocation -pédagogique différente : - -.. sourcecode:: none - - + Article - + Section - + Section - D'autre part, tout contenu se voit attribuer un identifiant unique sous la forme d'un entier naturel (en anglais : *pk*, pour *primary key*). Cet identifiant apparaît dans les URL, qui sont de la forme