Skip to content

Commit

Permalink
Mise à jour documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Arnaud-D committed Apr 28, 2024
1 parent 9d2d64a commit f0faa76
Showing 1 changed file with 14 additions and 25 deletions.
39 changes: 14 additions & 25 deletions doc/source/back-end/contents.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=========================
Les tutoriels et articles
=========================
================================
Les tutoriels, articles, billets
================================

Vocabulaire et définitions
==========================
Expand Down Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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
Expand Down

0 comments on commit f0faa76

Please sign in to comment.