fragref

14.16. fragref

L'élément de référence de fragment (<fragref>) fournit une référence logique à un fragment de définition de syntaxe ce qui permet d'appeler plusieurs fois un fragment de syntaxe, ou d'extraire une grande section de syntaxe de la ligne pour une lecture plus aisée. Cet élément appartient au domaine programming DITA, un jeu spécial d'éléments DITA conçus pour documenter des tâches, concepts et informations de référence de programmation.

Exemple

<syntaxdiagram frame="none"> <title>CopyFile</title> <groupseq><kwd>COPYF</kwd></groupseq> <groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp> <groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq> <fragref href="#syntax/overlay"></fragref> <groupchoice><var>input-filename</var><kwd>*INFILE</kwd></groupchoice> <groupchoice><var>output-filename</var><kwd>*OUTFILE</kwd></groupchoice> <fragment id="overlay"> <title>Overlay</title> <groupchoice><kwd>*OVERLAP</kwd><kwd>*Prompt</kwd></groupchoice> </fragment> </syntaxdiagram>

CopyFile >>-COPYF--input-filename*INFILE--output-filename--*OUTFILE------> >--| Overlay |--+-input-filename-+--+-output-filename-+-------->< '-*INFILE--------' '-*OUTFILE--------' Overlay |--+-*OVERLAP-+-------------------------------------------------| '-*Prompt--'

Contient :

Doctype	Modèle de contenu
ditabase, topic, task, reference, concept, glossary	( données textuelles ou ph ou codeph ou synph ou filepath ou msgph ou userinput ou systemoutput ou b ou u ou i ou tt ou sup ou sub ou uicontrol ou menucascade ou term ou q ou boolean ou state ou keyword ou option ou parmname ou apiname ou cmdname ou msgnum ou varname ou wintitle ou tm ou data ou data-about ou foreign ou unknown) (un nombre quelconque)

Doctype

Modèle de contenu

ditabase, topic, task, reference, concept, glossary

( données textuelles ou ph ou codeph ou synph ou filepath ou msgph ou userinput ou systemoutput ou b ou u ou i ou tt ou sup ou sub ou uicontrol ou menucascade ou term ou q ou boolean ou state ou keyword ou option ou parmname ou apiname ou cmdname ou msgnum ou varname ou wintitle ou tm ou data ou data-about ou foreign ou unknown) (un nombre quelconque)

Contenu par :

Doctype	Parents
ditabase, topic, task, concept, reference, glossary	syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment

Doctype

Parents

ditabase, topic, task, concept, reference, glossary

syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment

Héritage :

Attributs :

Nom	Description	Type de donnée	Valeur par défaut	Obligatoire ?
`href`	Une référence vers un élément de fragment de diagramme de syntaxe. Le fragment référencé devrait être dans le même diagramme que l'élément <`fragref`>. L'attribut `href` utilise une syntaxe URL conventionnelle pour pointer vers l'identificateur du fragment de diagramme de syntaxe correspondant : href="#topicid/fragmentid"	CDATA	#IMPLIED	non
`importance`	L'attribut indique si cet élément dans un diagramme de syntaxe est optionnel ("`optional`") ou obligatoire ("`required`"). Les processeurs de sortie peuvent l'indiquer dans un diagramme généré. Cf. la section 25.10.1.1. Utilisation de la valeur "`-dita-use-conref-target`" pour plus d'informations sur la valeur de `conref`.	`optional` \| `required` \| `-dita-use-conref-target`	#IMPLIED	non
`props`	L'attribut racine à partir duquel on peut spécialiser de nouveaux attributs de métadonnée. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <`related-links`>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs délimitées par des espaces. Par contre, agissant comme conteneur pour des attributs généralisés, le modèle de contenu sera plus complexe ; ce modèle est décrit à la section Généralisation des attributs de la spécification architecturale DITA.	CDATA	#IMPLIED	non
`base`	Un attribut générique sans utilisation spécifique mais destiné à servir de base pour les attributs spécialisés qui ont une syntaxe de valeur simple comme les attributs de traitement conditionnel (une ou plusieurs valeurs alphanumériques séparées par des blancs). L'attribut prend un ensemble de valeurs délimitées par des espaces. Par contre, lorsqu'il sert de conteneur pour des attributs généralisés, le modèle de contenu sera plus complexe ; ce modèle est documenté à la section Généralisation des attributs de la spécification architecturale DITA.	CDATA	#IMPLIED	non
`platform`	Indique le système d'exploitation et le matériel. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage et du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <`related-links`>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.	CDATA	#IMPLIED	non
`product`	Contient le nom du produit auquel le thème s'applique. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <`related-links`>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.	CDATA	#IMPLIED	non
`audience`	Indique le public visé pour l'élément. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <`related-links`>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.	CDATA	#IMPLIED	non
`otherprops`	Cet attribut est utilisable pour toutes les autres propriétés qui seraient nécessaires pour décrire un public ou pour fournir des critères de sélection pour l'élément. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <`related-links`>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.	CDATA	#IMPLIED	non
`rev`	Indique le niveau de révision d'un élément. Il est utile pour marquer les sorties fondées sur une révision. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <`related-links`>, la valeur sera héritée de l'ancêtre le plus proche.	CDATA	#IMPLIED	non
`status`	Le statut de l'élément courant.	`new` \| `changed` \| `deleted` \| `unchanged` \| `-dita-use-conref-target`	#IMPLIED	non
%id-atts; (`id`, `conref`)	Un ensemble d'attributs liés, décrit à la section 25.3. %id-atts;	entité paramètre	sans objet pour une entité paramètre	sans objet
%localization-atts; (`translate`, `xml:lang`, `dir`)	Un ensemble d'attributs liés, décrit à la section 25.6. %localization-atts;.	entité paramètre	sans objet pour une entité paramètre	sans objet
%global-atts; (`xtrf`, `xtrc`)	Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts;	entité paramètre	sans objet pour une entité paramètre	sans objet
`class`, `outputclass`	Attributs communs, décrit à la section 25.9. Autres attributs DITA communs

Nom

Description

Type de donnée

Valeur par défaut

Obligatoire ?

href

Une référence vers un élément de fragment de diagramme de syntaxe. Le fragment référencé devrait être dans le même diagramme que l'élément <fragref>. L'attribut href utilise une syntaxe URL conventionnelle pour pointer vers l'identificateur du fragment de diagramme de syntaxe correspondant :

href="#topicid/fragmentid"

CDATA

#IMPLIED

non

importance

L'attribut indique si cet élément dans un diagramme de syntaxe est optionnel ("optional") ou obligatoire ("required"). Les processeurs de sortie peuvent l'indiquer dans un diagramme généré. Cf. la section 25.10.1.1. Utilisation de la valeur "-dita-use-conref-target" pour plus d'informations sur la valeur de conref.

optional | required | -dita-use-conref-target

#IMPLIED

non

props

L'attribut racine à partir duquel on peut spécialiser de nouveaux attributs de métadonnée. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs délimitées par des espaces. Par contre, agissant comme conteneur pour des attributs généralisés, le modèle de contenu sera plus complexe ; ce modèle est décrit à la section Généralisation des attributs de la spécification architecturale DITA.

CDATA

#IMPLIED

non

base

Un attribut générique sans utilisation spécifique mais destiné à servir de base pour les attributs spécialisés qui ont une syntaxe de valeur simple comme les attributs de traitement conditionnel (une ou plusieurs valeurs alphanumériques séparées par des blancs). L'attribut prend un ensemble de valeurs délimitées par des espaces. Par contre, lorsqu'il sert de conteneur pour des attributs généralisés, le modèle de contenu sera plus complexe ; ce modèle est documenté à la section Généralisation des attributs de la spécification architecturale DITA.

CDATA

#IMPLIED

non

platform

Indique le système d'exploitation et le matériel. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage et du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.

CDATA

#IMPLIED

non

product

Contient le nom du produit auquel le thème s'applique. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.

CDATA

#IMPLIED

non

audience

Indique le public visé pour l'élément. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.

CDATA

#IMPLIED

non

otherprops

Cet attribut est utilisable pour toutes les autres propriétés qui seraient nécessaires pour décrire un public ou pour fournir des critères de sélection pour l'élément. C'est un attribut de propriété qui soutient un traitement conditionnel du filtrage ou du marquage. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche. L'attribut prend un ensemble de valeurs séparées par des espaces.

CDATA

#IMPLIED

non

rev

Indique le niveau de révision d'un élément. Il est utile pour marquer les sorties fondées sur une révision. Si aucune valeur n'est spécifiée, mais que l'attribut est spécifié sur un ancêtre dans une carte ou dans la section <related-links>, la valeur sera héritée de l'ancêtre le plus proche.

CDATA

#IMPLIED

non

status

Le statut de l'élément courant.

new | changed | deleted | unchanged | -dita-use-conref-target

#IMPLIED

non

%id-atts; (id, conref)

Un ensemble d'attributs liés, décrit à la section 25.3. %id-atts;

entité paramètre

sans objet pour une entité paramètre

sans objet

%localization-atts; (translate, xml:lang, dir)

Un ensemble d'attributs liés, décrit à la section 25.6. %localization-atts;.

entité paramètre

sans objet pour une entité paramètre

sans objet

%global-atts; (xtrf, xtrc)

Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts;

entité paramètre

sans objet pour une entité paramètre

sans objet

class, outputclass

Attributs communs, décrit à la section 25.9. Autres attributs DITA communs

Section parente 14. Éléments de programmation

Section précédente 14.15. fragment

Section suivante 14.17. synblk

Retour au sommaire.