Smartdoc/titre-et-references - Historique des versions

Damien : /* 2 - Intégrer la référence */

2023-04-20T06:24:30Z

2 - Intégrer la référence

Léo le 6 octobre 2020 à 12:54

2020-10-06T12:54:30Z

Léo le 9 septembre 2020 à 13:05

2020-09-09T13:05:52Z

Léo le 9 septembre 2020 à 13:04

2020-09-09T13:04:51Z

Léo le 28 août 2020 à 14:32

2020-08-28T14:32:41Z

Damien : /* 3 - Formater la référence */

2019-10-19T14:28:58Z

3 - Formater la référence

Damien : Ajout référence externe

2019-10-19T13:45:58Z

Ajout référence externe

Damien : /* Titres internes, numérotation et références */

2019-10-19T12:57:19Z

Titres internes, numérotation et références

Léo le 28 août 2019 à 13:08

2019-08-28T13:08:11Z

Damien : /* 3 - Formater la référence */

2019-08-23T21:53:21Z

3 - Formater la référence

@@ Ligne 63 : / Ligne 63 : @@
 :: <pre>Le décret énonce les différents cas pris en compte par la procédure. Voir : { @ref:article-truc }</pre>
-:: '''''Exemple de contenu utilisant une référence externe : '''''
+:: '''''Exemple de contenu utilisant une référence externe vers un autre document: '''''
-:: <pre>Voir annexe : { @ref:annexe1:article-truc }</pre>
+:: <pre>Voir annexe : { @ref-ext:annexe1:article-truc }</pre>
 === 3 - Formater la référence ===

@@ Ligne 19 : / Ligne 19 : @@
 :: '''Marche à suivre :'''
-:: -  Créer un nouvel élément de contenu (c'est à dire une nouvelle ligne dans la feuille du tableur de paramétrage)
+:: -  Créer un nouvel ''[[Élément_de_contenu|élément de contenu]]'' (c'est à dire une nouvelle ligne dans la feuille du tableur de paramétrage)
 :: -  Saisissez le titre à affiche dans la colonne "Contenu"
 :: -  Donner à ce nouvel élément l'option "title-level" pour qu'il soit considéré comme un titre / sous-titre interne au document. L'option "title-level" doit définir le niveau du titre (de 1 à 6 inclus). Ex: `title-level: 3`

@@ Ligne 14 : / Ligne 14 : @@
 Comme défini dans la [[SmartDoc|rubrique dédiée]], un [[SmartDoc|SmartDoc]] est constitué d'une suite ordonnée ''[[Élément_de_contenu|d'éléments de contenu]]''.
-Dans la feuille du tableur de paramétrage, il faut créer autant de lignse que d'[[Élément de contenu
+Dans la feuille du tableur de paramétrage, il faut créer autant de lignes que d'[[Élément_de_contenu|éléments de contenus dynamiques]]. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).
 Les [[SmartDoc#Options|"options"]] disponibles sur l'élément de contenu permettent de définir des caractéristiques spéciales de cet élément : notamment indiquer que cet élément doit être considéré comme un titre, lui assigner un "niveau" (titre de niveau 1, 2, ...) et un "identifiant" pour s'y référer.

@@ Ligne 14 : / Ligne 14 : @@
 Comme défini dans la [[SmartDoc|rubrique dédiée]], un [[SmartDoc|SmartDoc]] est constitué d'une suite ordonnée ''[[Élément_de_contenu|d'éléments de contenu]]''.
-Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'élément de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).
+Dans la feuille du tableur de paramétrage, il faut créer autant de lignse que d'[[Élément de contenu
 Les [[SmartDoc#Options|"options"]] disponibles sur l'élément de contenu permettent de définir des caractéristiques spéciales de cet élément : notamment indiquer que cet élément doit être considéré comme un titre, lui assigner un "niveau" (titre de niveau 1, 2, ...) et un "identifiant" pour s'y référer.

@@ Ligne 13 : / Ligne 13 : @@
 == Définir un titre ==
-Comme défini dans la [[SmartDoc|rubrique dédiée]], un [[SmartDoc|SmartDoc]] est constitué d'une suite ordonnée ''d'élément de contenu''.
+Comme défini dans la [[SmartDoc|rubrique dédiée]], un [[SmartDoc|SmartDoc]] est constitué d'une suite ordonnée ''[[Élément_de_contenu|d'éléments de contenu]]''.
 Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'élément de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).

← Version précédente		Version du 19 octobre 2019 à 14:28
Ligne 77 :		Ligne 77 :
	:: Utiliser le transformateur <code>:num</code> comme dernier paramètre pour n'afficher que la numérotation.		:: Utiliser le transformateur <code>:num</code> comme dernier paramètre pour n'afficher que la numérotation.
	:: <pre> Comme indiqué à l'article {@ref:article-truc:num} du contrat, il faut recourir à une procédure de ...</pre>		:: <pre> Comme indiqué à l'article {@ref:article-truc:num} du contrat, il faut recourir à une procédure de ...</pre>
		+	:: De même pour une référence externe :
		+	:: <pre> Voir article { @ref-ext:mon-doc:article-truc:num } de l'annexe.</pre>

@@ Ligne 7 : / Ligne 7 : @@
 Le [[SmartDoc|SmartDoc]] correspond à un système de document dynamique qu'il est possible de paramétrer avec des variables (pour intégrer des valeurs de façon dynamique), des [[Conditions|conditions de visibilités]] (afficher ou masquer un élément du document selon telle ou telle condition), et même des [[Boucles|conditions de répétitions]] (répéter un éléments autant de fois que nécéssaire).
-Mais qu'en est il des titres internes du document ? Comment paramétrer les titres et leur numérotation dans un modèle de document dynamique puisque n'importe quelle rubrique (chapitre, paragraphe ...) peut apparaitre et disparaitre selon le contexte ? Comment faire référence à une rubrique (càd, à un titre) alors que sa numérotation est dynamique ?
+Mais qu'en est il des titres, sous-titres et de leur numérotation ? Comment paramétrer cela dans un modèle de document dynamique puisque n'importe quel chapitre peut apparaitre et disparaitre selon le contexte et que cela remet en cause la numérotation ? Comment faire référence à titre alors que sa numérotation est dynamique ?
@@ Ligne 15 : / Ligne 16 : @@
 Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'élément de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).
-Les [[SmartDoc#Options|"options"]] disponibles sur l'élément de contenu permettent de définir des caractéristiques spéciales de cet élément : notamment indiquer que cet élément doit être considéré comme un titre / sous-titre interne.
+Les [[SmartDoc#Options|"options"]] disponibles sur l'élément de contenu permettent de définir des caractéristiques spéciales de cet élément : notamment indiquer que cet élément doit être considéré comme un titre, lui assigner un "niveau" (titre de niveau 1, 2, ...) et un "identifiant" pour s'y référer.
-−
 :: '''Marche à suivre :'''
 :: -  Créer un nouvel élément de contenu (c'est à dire une nouvelle ligne dans la feuille du tableur de paramétrage)
 :: -  Saisissez le titre à affiche dans la colonne "Contenu"
-:: -  Donner à ce nouvel élément l'option "title-level" pour qu'il soit considéré comme un titre / sous-titre interne. L'option "title-level" doit définir le niveau du titre (de 1 à 6 inclus). Ex: `title-level: 3`
+:: -  Donner à ce nouvel élément l'option "title-level" pour qu'il soit considéré comme un titre / sous-titre interne au document. L'option "title-level" doit définir le niveau du titre (de 1 à 6 inclus). Ex: `title-level: 3`
-:: -  Vous pouvez éventuellement rajouter une condition de visibilité sur votre élément (comme pour tout autre élément). Notez néanmoins que seul le titre sera affecté par cette condition.
+:: -  Vous pouvez éventuellement rajouter une condition de visibilité sur votre élément (comme pour tout autre élément). Notez néanmoins que seul le titre sera affecté par cette condition, pas le contenu qui suit (pour conditionner la visibilité d'une rubrique entière, utilisez [[SmartDoc/Blocs|le système de blocs]]).
 Notez que :
-* Ce système de niveau de titre permet de réguler la hiérarchie des titres du document, mais '''ce n'est en rien un moyen d'écrire un titre plus grand ou plus petit''' (utilisez les "styles" pour cela) ;
+* Ce système de niveau de titre permet de réguler la hiérarchie des titres du document, mais '''ce n'est en rien un moyen de styliser un titre pour qu'il apparaissent plus grand ou plus petit''' (utilisez les "styles" pour cela) ;
 * Il est préférable de '''respecter la logique hiérarchique''' : un titre de niveau 2 ne peut être défini qu'au sein d'un titre de niveau 1, et qu'un titre de niveau 3 ne le sera qu'au sein d'un titre de niveau 2 et ainsi de suite. Il ne serait pas logique de définir un titre de niveau 5 directement en dessous d'un titre de niveau 1 (il sera alors considéré par le document comme un titre de niveau 2 même si vous avez indiqué 5) ;
 * Si vous rajoutez une [[SmartDoc#Visible_if|conditions de visibilités]] sur un titre, cela ne fera pas disparaitre le contenu de la rubrique mais seulement le titre lui-même. Si vous souhaiter conditionner l'affichage de toute une rubrique (titre + ses paragraphes etc.) nous vous conseillons d'utiliser le système de [[SmartDoc/Blocs|"BLOC"]] : le bloc contiendra l'ensemble de la rubrique et la condition d'affichage portera directement sur le bloc ;
@@ Ligne 32 : / Ligne 32 : @@
 == Intégrer une référence dynamique vers un titre ==
-Vous pouvez à tout moment intégrer dans votre contenu une référence dynamique vers un titre du document.
+Pour pouvoir faire une référence à un titre, il est d'abord nécéssaire de donner un "identifiant unique" au titre vers lequel la référence doit porter.
-==== 1 - Identifier le titre ====
+— <b>Pour une référence vers un titre interne au document</b>, utilisez l'opérateur spécial <code>@ref</code>. Cet opérateur doit être accompagné d'un paramètre obligatoire : le '''title-id''' du titre à référencer. Chaque paramètre étant séparé par le signe <code>:</code>, la syntaxe d'une référence interne prend la forme de : <code>{ @ref : title-id }</code>.
-En amont, il est nécéssaire d'identifier le titre en lui donnant un identifiant unique. Pour cela, utilisez l'option <code>title-id</code> sur l'élément de contenu correspondant (l'option se trouvera donc au dessous de `title-level`).
+— <b>Pour une référence vers un titre présent dans un autre document</b>, utilisez l'opérateur spécial <code>@ref-ext</code>. Cet opérateur doit être accompagné de 2 paramètres obligatoires : le '''doc-id''' du document vers lequel porte la référence, puis le  '''title-id''' du titre à référencer dans ce document externe. Chaque paramètre étant séparé par le signe <code>:</code>, la syntaxe d'une référence externe prend la forme de : <code>{ @ref-ext : doc-id : title-id }</code>.
-Ensuite, vous pouvez faire référence à ce titre dans votre contenu en utilisant l'opérateur spécial <code>@ref</code> suivi du '''title-id''' à référencer.
+:: '''''Exemple de contenu utilisant une référence interne :'''''
-Exemple de contenu utilisant une référence :
+:: '''''Exemple de contenu utilisant une référence externe : '''''
-<pre>
+:: <pre>Voir annexe : { @ref:annexe1:article-truc }</pre>
-Vous pouvez vouloir afficher la référence au titre de plusieurs façon : juste le numéro du titre, juste le titre lui-même, le numéro du titre ainsi que ces parents (1-5-2) etc.
+=== 3 - Formater la référence ===
-Par  défaut, l'intégration d'une référence affiche sa numérotation ainsi que le contenu du titre mais il existe plusieurs façon de personnaliser l'affichage de cette référence :
+Que ce soit une référence interne ou une référence externe, vous pouvez vouloir afficher la référence au titre de plusieurs façon : seulement la numérotation du titre, seulement le titre, la numérotation du titre ainsi que ces parents (1-5-2) etc.
 :: '''— N'afficher que la numérotation :'''
-:: Utiliser le transformateur <code>:num</code> pour n'afficher que la numérotation.
+:: Utiliser le transformateur <code>:num</code> comme dernier paramètre pour n'afficher que la numérotation.
 :: <pre>    Comme indiqué à l'article {@ref:article-truc:num} du contrat, il faut recourir à une procédure de ...</pre>
@@ Ligne 65 : / Ligne 81 : @@
 :: '''— N'afficher que le titre :'''
-:: Utiliser le transformateur <code>:title-only</code> pour n'afficher que le titre sans la numérotation.
+:: Utiliser le transformateur <code>:title-only</code> comme dernier paramètre pour n'afficher que le titre sans sa numérotation.
 :: <pre>    Dans notre article "{@ref:article-truc:title-only}" nous expliquons comment le ...</pre>

← Version précédente		Version du 19 octobre 2019 à 12:57
Ligne 1 :		Ligne 1 :
−	= Titres ~~internes~~, numérotation et références =	+	= Titres, numérotation et références =

	<br/>		<br/>

@@ Ligne 5 : / Ligne 5 : @@
 '''Contexte :'''
-Le [[SmartDoc|SmartDoc]] correspond à un système de document dynamique qu'il est possible de paramétrer avec des variables (pour intégrer des valeurs de façon dynamique), des [[SmartDoc#Visible_if|conditions de visibilités]] (afficher ou masquer un élément du document selon telle ou telle condition), et même des [[SmartDoc#Boucles|conditions de répétitions]] (répéter un éléments autant de fois que nécéssaire).
+Le [[SmartDoc|SmartDoc]] correspond à un système de document dynamique qu'il est possible de paramétrer avec des variables (pour intégrer des valeurs de façon dynamique), des [[Conditions|conditions de visibilités]] (afficher ou masquer un élément du document selon telle ou telle condition), et même des [[Boucles|conditions de répétitions]] (répéter un éléments autant de fois que nécéssaire).
 Mais qu'en est il des titres internes du document ? Comment paramétrer les titres et leur numérotation dans un modèle de document dynamique puisque n'importe quelle rubrique (chapitre, paragraphe ...) peut apparaitre et disparaitre selon le contexte ? Comment faire référence à une rubrique (càd, à un titre) alors que sa numérotation est dynamique ?

@@ Ligne 83 : / Ligne 83 : @@
 :: Autre exemple d'intégration personnalisée :
 :: <pre>    En vous référant à la {@ref:section-bidule:format("section $3 (article $1.$2)")}, vous trouverez ... </pre>
-:: Qui affichera quelque chose comme : ''En vous référant à la <u>section 12 (article 3.4)</u>, vous trouverez ...''
+:: Qui affichera quelque chose comme : "''En vous référant à la <u>section 12 (article 3.4)</u>, vous trouverez ...''"