Integrate Help Document into DSM Help

To integrate a help document of your application into DSM Help, please do the following steps:

  • Classify the help documents according to language, and put them in the help folder of your application.
  • To have consistent style, and our customized scroll bar, you should add the following html tag:

    <!DOCTYPE html>
    <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    
    <link href="../../../../help/help.css" rel="stylesheet" type="text/css">
    <link href="../../../../help/scrollbar/flexcroll.css" rel="stylesheet" type="text/css">
    <script type="text/javascript" src="../../../../help/scrollbar/flexcroll.js"></script>
    <script type="text/javascript" src="../../../../help/scrollbar/initFlexcroll.js"></script>
    
    </head>
    

    Note: The js files are required because the native browser scroll bar has been disabled.

  • You will need to add a text file "helptoc.conf" into your application. This text file "helptoc.conf" is to configure the structure of your help document. The content of helptoc.conf should be in JSON format. For example:

    {
       "app": "SYNO.App.TestAppInstance",
       "title": "app_tree:index_title"
       "helpset": "help",
       "stringset": "texts",
       "content": "testapp_index.html",
       "toc": [{
       "title": "app_tree:node_1"
       "content": "testapp_node1.html",
       "nodes": [{
           "title": "app_tree:node_1_child"
           "content": "testapp_node1_child.html"
    }]
    }, {
       "title": "app_tree:node_2"
       "content": "testapp_node2.html"
    }]
    }
    

    Details of helptoc.conf are stated in below.

Property Description
stringset (Required) "stringset" is the folder that stores your application strings.
app "app" represents the application instance.
helpset "helpset" displays more details about the application upon mouse-over.
title (Required) "title" is the text that will be displayed in the DSM Help tree. It consists of two parts - section and key, and is separated by a colon.
content (Required) "content" represents the url of the node.
toc "toc" are the child nodes for your application. (use empty array if your application doesn't have one)
nodes "nodes" are the child nodes of toc. (not necessary if there is no child nodes)
  • Add the following content to the resource specification file. Please refer to Index DB for more detail.
"indexdb": {
    "app-index"  : {
        "conf-relpath": "ui/index.conf",
        "db-relpath": "indexdb/appindexdb"
    },
    "help-index": {
        "conf-relpath": "ui/helptoc.conf",
        "db-relpath": "indexdb/helpindexdb"
    }
}