Skip to main content

独自のコンテンツでCODESYSオフラインヘルプを拡張

ザル CODESYS Development System には、独自のヘルプページでオフラインヘルプを拡張する機能があります。新しいヘルプページは、どのような構造でも、目次のどの位置にも追加できます。

さらに、追加されたヘルプページに目次全体を表示することもできます。言語の切り替えや内容の検索もサポートされています

重要

HTML ページを統合するための要件は、のインストールです。 CODESYS オフラインヘルプ。ザブ CODESYS オフラインヘルプはからインストールできます。 ヘルプポータル または CODESYS Installer

. 拡張には次のファイルが必要です
  • HTML 形式のヘルプページ

    ヘルプページは、ディレクトリ C:\ProgramData\CODESYS\Offline Help\<language>.

  • 設定ファイル: <name>-productinfo.json 製品ヘルプの概要

    設定ファイルはディレクトリに保存されます。 C:\ProgramData\CODESYS\Offline Help\de\js

  • 設定ファイル: <name>-toc.json 新しいページの挿入位置

    設定ファイルはディレクトリに保存されます。 C:\ProgramData\CODESYS\Offline Help\de\js

  • 設定ファイル: <name>-search.json 新しいコンテンツを検索に含める

    設定ファイルはディレクトリに保存されます。 C:\ProgramData\CODESYS\Offline Help\de\js

    このファイルはオプションです。

重要

3つのコンフィギュレーション・ファイルの接頭辞 <name>は同一でなければならない。

ザ・ファイル fuzzydata.jsproductsinfo.js、および toc.js はオフラインヘルプの標準設定ファイルです。起動後 CODESYSjson ファイルの内容は標準設定ファイル (*.js) に統合されます。元の設定ファイルは、に保存されます backup ディレクトリ。

_cds_img_offlinehelp_files.png

設定ファイルの作成

製品ヘルプ概要の設定ファイル  <name>-productinfo.json

このファイルにより、製品ヘルプの概要ページにエントリが作成されます。

_cds_img_3rd_party_help_overview.png

title

表示されている製品名とバージョン

url

リンク先のページ

children

重要性なし、評価なし

1.
[
  {
      "title": "3rd Party, V1.2.3.4",
      "url": "3rd_new_pub.html",
      "children": []
    }
]


新しいヘルプページの挿入位置の設定ファイル <name>-toc.json

このファイルは、新しいページがヘルプに統合される位置を定義します。

url

挿入するページの HTML 名

text

挿入するページの名前。この名前は目次に表示されます。

insert_after

指定されたヘルプページと同じレベルに新しいページを挿入します

append_below

指定されたヘルプページの下の最後の子ページとして新しいページを挿入します。

もし / HTML 名の代わりに文字が割り当てられ、新しいページが目次の最上位に追加されます。

children

子ページを追加します

プレースホルダー: *

製品のスタートページの HTML 名には内部 ID がありますが、これは変更される可能性があります。変更後もこれらのページが見つけられるようにするには、プレースホルダーを使用します * このような場合は ID に使用してください。

2. サンプル 1

ヘルプページ 3rd_new_pub.html ヘルプページの後に兄弟ページとして挿入されます 1064796-311627-codesys-redundancy.html

[
    {   "url": "3rd_new_pub.html",
        "text": "New Publication",
        "insert_after": "1064796-311627-codesys-redundancy.html"
    }
]


3. サンプル 2

例 1 に加えて、下に 2 つの子ページが挿入されています New Publication ページ。

[
    {   "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"
    }
]


4. サンプル 3

製品のスタートページの HTML 名には内部 ID がありますが、これは変更される可能性があります。変更後もこれらのページが見つけられるようにするには、プレースホルダーを使用します * このような場合は ID に使用してください。

例 2 と似ていますが、プレースホルダーが使われています。 Insert_after ページ。

[
    {   "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"
    }
]


5. サンプル 4

ヘルプページ 3rd_new_pub.html そして、ヘルプページの下の最後の子ページとして 2 つのサブページが挿入されます。 *-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"
    }
]


6. サンプル 5

この設定により、ヘルプページが追加されます。 3rd_toplevel.html 目次の最後にあるトップレベル。

[
    {
        "url": "3rd_toplevel.html",
        "text": "Kapitel Toplevel",
        "append_below": "/"
    }
]


7. サンプル 6

この例は、挿入位置が異なる構成を示しています。

[
    {
        "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": "/"
    }
]


検索用設定ファイル <name>-search.json

この設定には、ページの完全なヘルプテキストが含まれています。

title

チャプターのタイトル。検索ヒットとして表示されます

url

見つかったページの HTML 名

breadcrumbs

ページのブレッドクラムが見つかりました。検索ヒットに表示されます。

snippet

ページが見つかったショートテキスト。検索ヒットに表示されます

body

見出しを含むヘルプページの全文

[
  {
    "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"
  }
]

HTML ページのカスタマイズ

追加のヘルプページは HTML 形式である必要があります。新しく追加したページに目次、言語切り替え、検索フィールドも確実に表示されるようにするには、新しいページを HTML フレームに埋め込む必要があります

テンプレートファイル TemplateOfflineHelp_Simple.html サブディレクトリにあります。 C:\ProgramData\CODESYS\Offline Help\Templates オフラインヘルプをインストールした後。このテンプレートは他の HTML ページのフレームワークとして使用されます。

以下の変更が必要です。

  • ブラウザ内のプレースホルダーへのタブ名の挿入 {{TITLE}}。これは通常、ヘルプページの見出しです。

        <title>{{TITLE}}</title>                      
    
  • 追加ヘルプページの内容全体をプレースホルダーに挿入 {{CONTENT}}

    <!-- Place main content here -->
    {{CONTENT}}                         
    

新しいページのデザインが次のようになっている場合 CODESYS ヘルプ、次に既存のスタイルシートクラス CODESYS オフラインヘルプを使用する必要があります。 TemplateOfflineHelp_Full.html は、これらの変更の例を示しています。

パッケージによるヘルプページのインストール

通常、パッケージはオフラインヘルプの拡張に使用されます。

8. 例:パッケージへのデータの保存
_cds_img_3rd_party_help_package.png

のサンプルエントリ package.manifest ファイル

<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>