Extension de l'aide hors ligne de CODESYS à vos propres contenus
Le CODESYS Development System permet d'étendre l'aide hors ligne à vos propres pages d'aide. Les nouvelles pages d'aide peuvent être ajoutées dans n'importe quelle structure et à n'importe quel endroit de la table des matières.
De plus, il est possible d'afficher la table des matières complète sur les pages d'aide ajoutées. Le basculement entre les langues et la recherche dans le contenu sont également
Important
La condition requise pour l'intégration des pages HTML est l'installation du CODESYS Aide hors ligne. CODESYS L'aide hors ligne peut être installée via portail d'aide ou CODESYS Installer.
Pages d'aide au format HTML
Les pages d'aide sont stockées dans le répertoire
C:\ProgramData\CODESYS\Offline Help\<language>.Fichier de configuration:
<name>-productinfo.json pour la présentation de l'aide au produitLe fichier de configuration est stocké dans le répertoire
C:\ProgramData\CODESYS\Offline Help\de\js.Fichier de configuration :
<name>-toc.jsonpour la position d'insertion des nouvelles pagesLe fichier de configuration est stocké dans le répertoire
C:\ProgramData\CODESYS\Offline Help\de\js.Fichier de configuration
<name>-search.jsonpour l'inclusion du nouveau contenu dans la rechercheLe fichier de configuration est stocké dans le répertoire
C:\ProgramData\CODESYS\Offline Help\de\js.This file is optional.
Important
Le préfixe <name> des trois fichiers de configuration doit être identique.
Les dossiers fuzzydata.js, productsinfo.js, et toc.js sont les fichiers de configuration standard pour l'aide hors ligne. Après le démarrage CODESYS, le contenu des fichiers json est intégré dans les fichiers de configuration standard (*.js). Les fichiers de configuration d'origine sont enregistrés dans backup annuaire.
Création des fichiers de configuration
Fichier de configuration pour l'aperçu de l'aide au produit <name>-productinfo.json
Ce fichier crée des entrées sur la page de présentation de l'aide du produit.
| Nom affiché du produit avec version |
| Page liée |
| No significance; not evaluated |
[
{
"title": "3rd Party, V1.2.3.4",
"url": "3rd_new_pub.html",
"children": []
}
]Fichier de configuration pour la position d'insertion des nouvelles pages d'aide <name>-toc.json
Ce fichier définit la position où les nouvelles pages sont intégrées dans l'aide.
| HTML name of the page to be inserted |
| Name of the page to be inserted. This name is displayed in the table of contents |
| Inserts a new page on the same level as the specified help page |
| Insère une nouvelle page en tant que dernière page enfant en dessous de la page d'aide spécifiée. Si le |
| Ajoute des pages supplémentaires pour enfants |
Espace réservé : | Les pages d'accueil des produits ont un identifiant interne dans leur nom HTML, qui peut changer. Pour vous assurer que ces pages peuvent également être trouvées après une modification, l'espace réservé |
La page d'aide 3rd_new_pub.html est insérée en tant que page sœur après la page d'aide 1064796-311627-codesys-redundancy.html.
[
{ "url": "3rd_new_pub.html",
"text": "New Publication",
"insert_after": "1064796-311627-codesys-redundancy.html"
}
]En plus de l'exemple 1, deux pages secondaires sont insérées sous le New Publication page.
[
{ "url": "3rd_new_pub.html",
"text": "New Publication",
"children": [
{
"url": "3rd_new_pub_topic1.html",
"text": "New Publication - Chapter 1"
},
{
"url": "3rd_new_pub_topic2.html",
"text": "New Publication - Chapter 2"
}
],
"insert_after": "1064796-311627-codesys-redundancy.html"
}
]Les pages d'accueil des produits ont un identifiant interne dans leur nom HTML, qui peut changer. Pour vous assurer que ces pages peuvent également être trouvées après une modification, l'espace réservé * doit être utilisé comme identifiant dans ces cas.
Analogue à l'exemple 2, mais un espace réservé est utilisé pour Insert_after page.
[
{ "url": "3rd_new_pub.html",
"text": "New Publication",
"children": [
{
"url": "3rd_new_pub_topic1.html",
"text": "New Publication - Chapter 1"
},
{
"url": "3rd_new_pub_topic2.html",
"text": "New Publication - Chapter 2"
}
],
"insert_after": "*-codesys-redundancy.html"
}
]La page d'aide 3rd_new_pub.html et deux sous-pages sont insérées comme dernière page enfant sous la page d'aide *-codesys-softmotion.html.
[
{ "url": "3rd_new_pub.html",
"text": "New Publication",
"children": [
{
"url": "3rd_new_pub_topic1.html",
"text": "New Publication - Chapter 1"
},
{
"url": "3rd_new_pub_topic2.html",
"text": "New Publication - Chapter 2"
}
],
"append_below": "*-codesys-softmotion.html"
}
]Cette configuration ajoute la page d'aide 3rd_toplevel.html niveau supérieur à la fin de la table des matières.
[
{
"url": "3rd_toplevel.html",
"text": "Kapitel Toplevel",
"append_below": "/"
}
]Cet exemple montre une configuration avec différentes positions d'insertion.
[
{
"url": "3rd_new_pub.html"
, "text": "New Publication",
"children": [
{
"url": "3rd_new_pub_topic1.html",
"text": "New Publication - Chapter 1"
},
{
"url": "3rd_new_pub_topic2.html",
"text": "New Publication - Chapter 2"
}
],
"insert_after": "*-codesys-git.html"
},
{
"url": "3rd_add_child.html",
"text": "Kapitel Geschwister",
"insert_after": "_pbdp_cmd_scan_devices.html"
},
{
"url": "3rd_toplevel.html",
"text": "Chapter Toplevel",
"append_below": "/"
}
]Fichier de configuration pour la recherche <name>-search.json
Cette configuration contient le texte d'aide complet d'une page.
| Titre du chapitre ; affiché en tant que résultat de recherche |
| Nom HTML de la page trouvée |
| d'Ariane de la page trouvée. Affiché dans le résultat de recherche |
| Texte court de la page trouvée. Affiché dans le résultat de recherche |
| Texte intégral de la page d'aide, y compris le titre |
[
{
"title": "Chapter 1,
"url": "3rd_chapter1.html",
"breadcrumbs": "3rdParty - Offline help / Chapter 1",
"snippet": "Lorem ipsum dolor sit amet...",
"body": "Chapter 1. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita
kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet"
},
{
"title": "Chapter 2",
"url": "3rd_chapter2.html",
"breadcrumbs": "3rdParty - Offline help / Chapter 2",
"snippet": "Lorem ipsum dolor sit amet...",
"body": "Chapter 2. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita
kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet"
}
]Personnalisation des pages HTML
Les pages d'aide supplémentaires doivent être au format HTML. Pour que la table des matières, le changement de langue et le champ de recherche soient également affichés sur les nouvelles pages ajoutées, celles-ci doivent être intégrées dans un cadre HTML
Le fichier modèle TemplateOfflineHelp_Simple.html se trouve dans le sous-répertoire C:\ProgramData\CODESYS\Offline Help\Templates après avoir installé l'aide hors ligne. Ce modèle est utilisé comme cadre pour les pages HTML supplémentaires.
Les modifications suivantes sont nécessaires :
Insertion du nom de l'onglet dans le navigateur dans l'espace réservé
{{TITLE}}. Il s'agit généralement du titre de la page d'aide.<title>{{TITLE}}</title>Insertion de l'intégralité du contenu de la page d'aide supplémentaire dans l'espace réservé
{{CONTENT}}.<!-- Place main content here --> {{CONTENT}}
Si les nouvelles pages sont censées avoir le design du CODESYS Aide, puis les classes de feuille de style de l'existant CODESYS aide hors ligne doit être utilisée. Le modèle TemplateOfflineHelp_Full.html montre un exemple de ces modifications.
Installation des pages d'aide via un package
Un package est généralement utilisé pour étendre l'aide hors ligne.
Exemple d'entrée dans le package.manifest fichier
<Component>
<General>
<Id>1</Id>
<Name>Offline Help Files</Name>
<Description>Offline help files for 3rd party product</Description>
<Selectable>false</Selectable>
<SelectedByDefault>true</SelectedByDefault>
</General>
<Items>
<Folder>
<TargetFolder>%REPOSITORY_LOCATION%</TargetFolder>
<Path>Offline Help</Path>
</Folder>
</Items>
</Component>