Application Technical Information
Présentation de l'application Technical Information
Vous devez implémenter un type de document sur le serveur Arbortext Publishing Engine qui peut publier le document XML transformé, créé par l'application Service. Un exemple d'application de type de document DITA est fourni avec Arbortext Editor and Publishing Engine. Vous pouvez l'utiliser comme point de départ ou l'analyser pour déterminer la configuration requise pour votre propre type de document.
L'application Technical Information est un type de document DITA spécialisé. Elle organise et gère les informations relatives aux opérations de service et aux articles. Le serveur Arbortext Publishing Engine installe par défaut l'application à l'emplacement suivant :
Chemin-Arbortext\application\com.ptc.arbortext.techinfo
Description du type de document de l'application Technical Information
Les rubriques de l'application Technical Information peuvent être utilisées pour créer des informations de service ou comme point de départ pour créer votre propre application DITA spécialisée. L'application Technical Information est une spécialisation de l'application DITA Arbortext, mais un type de document personnalisé ne doit pas obligatoirement être basé sur DITA.
Les types de rubrique suivants sont disponibles pour le type de document de l'application Technical Information :
Concept
Fournit des informations d'arrière-plan que les utilisateurs doivent comprendre avant de pouvoir utiliser un produit ou une interface, ou effectuer une tâche.
Page de garde
Fournit les informations qui apparaîtront sur la page de garde d'un document PDF ou imprimé.
Diagnostic
Fournit des informations de diagnostic.
Procédure
Indique la procédure à suivre pour effectuer une tâche. Dans ce cas, les étapes et les graphiques sont combinés dans un flux de texte unique.
Référence
Fournit des informations relatives aux fonctions normales d'un service, d'un produit ou d'un article.
Procédure côte à côte
Indique la procédure à suivre pour effectuer une tâche. Dans ce cas, les étapes et les graphiques sont présentés côte à côte dans un format tabulaire.
Tâche
Fournit des informations procédurales.
Dépannage
Fournit des informations relatives au dépannage ou au diagnostic.
Description de la feuille de style de l'application Technical Information
Le type de document de l'application Technical Information comprend un exemple de feuille de style Arbortext Styler pour la publication, qui se trouve à l'emplacement suivant :
chemin-Arbortext\application\com.ptc.arbortext.techinfo
\doctypes\techinfo\techinfo.style
Contrôle de la transformation et du style
Vous pouvez produire une feuille de style pour votre sortie. Pour contrôler la progression, vous pouvez ouvrir le document racine du champ de données, procéder au réglage de votre feuille de style, et tester vos modifications pour générer la sortie à l'aide de Arbortext Publishing Engine Interactive. Les auteurs de XSLT peuvent également utiliser ce processus pour évaluer les transformations qui produisent le mappage cible et les listes d'articles cibles.
Vous devez obtenir un champ de données du Arbortext Publishing Engine. WVS et Arbortext Publishing Engine doivent être configurés pour la publication. Sur le serveur Arbortext Publishing Engine, l'archive des transactions doit être configurée et active. (Reportez-vous à la documentation du manuel Configuring Arbortext Publishing Engine (Configuration d'Arbortext Publishing Engine) pour en savoir plus sur l'archive des transactions, dans le cadre de la documentation de Arbortext Publishing Engine.) Ensuite, vous pouvez initier une demande de publication à partir de la structure de publication, de la structure d'information ou de la liste d'articles dans Windchill. Dans une archive de transaction, recherchez votre transaction puis téléchargez et renommez le corps de requête, appelé rqbody.dat. Renommez-le en employant une extension .zip.
Ouvrez le fichier Identificateur.xml racine du champ de données dans Arbortext Publishing Engine Interactive pour créer manuellement son mappage cible. Vous pouvez extraire d'abord les fichiers de l'archive payload.zip et ouvrir le document Identificateur.xml racine, ou ouvrir l'archive payload.zip proprement dite. L'option Modifier > Editer le document converti n'apparaît que si vous ouvrez un fichier Identificateur.xml depuis un champ de données (cela signifie que le type de document doit correspondre à PublicationStructure pour que l'option de menu soit disponible). Lorsque vous sélectionnez Editer le document converti, Arbortext Publishing Engine Interactive effectue la transformation à partir de l'application de service du document racine et de tous ses documents référencés. Le mappage cible résultant (par exemple, techinfomap) s'affiche dans une nouvelle fenêtre.
Si vous utilisez une spécialisation de mappage des DITA, vous pouvez utiliser l'option Modifier > Modifier le style du document résolu dans Arbortext Publishing Engine Interactive pour visualiser le résultat stylisé. Si la destination était un autre type de document, vous pouvez au moins voir le résultat en affichant le mappage et en le publiant.
Les sections suivantes donnent des conseils sur la conception de la feuille de style techinfo.style.
Titre du manuel
L'exemple de feuille de style utilise l'attribut outputclass de l'élément de plan racine techinfomap pour générer les titres suivants :
Valeur de l'attribut outputclass
Titre
service
Manuel d'entretien
installation
Manuel d'installation
owners
Manuel du propriétaire
parts
Catalogue de pièces illustré
Numérotation de la page de titres
Sur la page de titres, les éléments number et numberlist sont utilisés pour générer les principales expressions pour les numéros de série, d'article et de modèle.
Valeur de l'attribut outputclass
Expression
serial
Numéro de série
part
Numéro d'article
model
Numéro de modèle
Aucun texte n'est généré si la valeur outputclass est vide ou différente des valeurs répertoriées. L'élément numberlist peut contenir numberarrange.
Procédures côte à côte
Pour qu'une procédure apparaisse avec le texte à gauche et les graphiques à droite, vous devez appliquer une structure de balisage spéciale. Au moins une des balises procstep doit contenir une balise procinfo. Si aucune balise procinfo n'est présente dans la procédure, cette dernière ne s'affiche pas en tant que procédure côte à côte.
Modifications du tableau de liste d'articles
Le marquage XML de la liste d'articles est un tableau personnalisé. Ainsi, la feuille de style Arbortext Styler utilise certaines propriétés du tableau pour appliquer le style. Le tableau de liste d'articles par défaut comprend les propriétés Numéro d'élément, Indentation, Numéro d'article, Nom de l'article, Quantité, Indicateur remplaçable, Non illustré et Remarques.
Propriété
Type de données
partattributeNom
Sortie
Numéro de l'élément
Chaîne
itemNumber
Oui
Item Sequence Number
Entier
itemSequenceNumber
Non
Aplomb
Entier (0 à 6)
indenture
Non, comparé à
Numéro de l'article
Chaîne
number
Oui
Nom de l'article
Chaîne
name
Oui
Quantité
Chaîne
itemQuantity
Oui
Indicateur remplaçable
Booléen
serviceable
Non, comparé à
Non illustré
Booléen
illustrated
Non, comparé à
Référence
FIG
ITM
ISN
referTo
Non
Remarques
Chaîne
remarks
Oui
Pour tester les valeurs de serviceable et de illustrated, vous devez ajouter les valeurs de partattribute name=”serviceable” et de partattribute name=”illustrated” en tant qu'attributs de partitem en modifiant la version XML de la feuille de style, au lieu de passer par l'interface utilisateur d'Arbortext Styler.
La sortie du numéro de l'élément et de l'article dépend des valeurs des propriétés illustrated et serviceable comme suit :
Remplaçable
Illustré
Afficher le numéro de l'article ?
Afficher le numéro de l'élément ?
Vrai
Vrai
Oui
Oui
Vrai
Faux
Oui
Non
Faux
Vrai
Non
Oui
Faux
Faux
Non
Non
En modifiant la version XML de la feuille de style et en utilisant l'élément SetOutputAttribute, les valeurs sont enregistrées en tant qu'attributs. Ces attributs sont ensuite comparés aux éléments _sfe générés dans le cadre du tableau personnalisé.
Est-ce que cela a été utile ?