Hosting Documentation on an Internal HTTP Server

You can serve all the documentation for a release on an internal-only web host.

Modern browsers have implemented security restrictions that, by default, prevent JavaScript from accessing local files without an HTTP server. Because InfoHub is a JavaScript-driven system that accesses locally installed files, it cannot fully function unless you configure your browser to enable JavaScript to run on local files. One way you can get around this issue, without changing your browser’s security settings, is to host the Siemens Software and Mentor documentation on an HTTP server that is available from within your company’s firewall (not available outside of your internal network).

Procedure

  1. Copy the documentation from your software tree to an internal HTTP server.

    Typically, you would copy the docs directory. It is recommended that you create a directory named for the release, such as ee_7.9.5 or calibre_2013.4, and place the new docs directory inside. This way you can have multiple documentation trees copied from multiple Siemens Software and Mentor releases available on the HTTP server.

  2. Confirm that your new docs directory on the web-server contains the infohubs, htmldocs, and pdfdocs directories, along with any other files and directories that were in the docs directory of your original software tree.
  3. Create a file named mgc_doc_options.ini and place it in the docs directory of your original software tree.
  4. Add the MGC_ALT_DOC_PATH variable to the file and specify the “http://” path to the documents copied to your internal web-server.

    For more details and examples, refer to “mgc_doc_options.ini File Format”.

  5. Test the setup by invoking a product in the software tree and accessing the documentation through the Help menu.