Documentation Center

Viewing a publication in LiveContent S1000D

To view a publication, add it to a LiveContent S1000D collection. A collection consists of one or more publications, associated with a set of presentation templates. Presentation templates define the look & feel of the collection: for example, XSL styles that create HTML and PDF output for the user, skins that brand the viewer, and menus that a user can access.

Procedure

  1. Check if your LiveContent S1000D data directory contains a default collection folder.
  2. If this folder does not exist, copy the directory called default/ from the templates/collections/ subdirectory of your LiveContent S1000D home directory to the collections/ subdirectory of your LiveContent S1000D data directory.
  3. Navigate to the collection directory of the collection to which you want to add a publication.
  4. Open launch.ini for editing.
  5. Find the property ConfigArgument1 and set its value to the full path and file name of the collection's wietmsd.xml file.
  6. Save and close launch.ini.
  7. Open wietmsd.xml for editing.
  8. Configure application templates by adding a configuration item such as one of the following examples:
    Windows
    <!-- Location of XSL styles directory, skins and menus directories -->
    <configitem name="app.docs_root">
      <value>C:\Program Files\XyEnterprise\LiveContent\templates\FullSupport\etc</value>
    </configitem>
    
    <!-- LiveContent S1000D program JARs -->
    <configitem name="app.resource_jarname">
      <value>C:\Program Files\XyEnterprise\LiveContent\wietmsd.jar</value>
    </configitem>
    
    <configitem name="app.resource_jarname_ext">
      <value>C:\Program Files\XyEnterprise\LiveContent\wietmsd-etc.jar</value>
    </configitem>
    
    <configitem name="app.resource_jarname_misc">
      <value>C:\Program Files\XyEnterprise\LiveContent\wietmsd-skin.jar</value>
    </configitem>
    Linux
    <!-- Location of XSL styles directory, skins and menus directories -->
    <configitem name="app.docs_root">
      <value>/opt/XyEnterprise/LiveContent/templates/FullSupport/etc</value>
    </configitem>
    
    <!-- Location of HTTP docs, including images and Help files -->
    <configitem name="app.httpd_root">
      <value>/opt/XyEnterprise/LiveContent/templates/FullSupport/httpdocs</value>
    </configitem>
    
    <!-- LiveContent S1000D program JARs -->
    <configitem name="app.resource_jarname">
      <value>/opt/XyEnterprise/LiveContent/wietmsd.jar</value>
    </configitem>
    
    <configitem name="app.resource_jarname_ext">
      <value>/opt/XyEnterprise/LiveContent/wietmsd-etc.jar</value>
    </configitem>
    
    <configitem name="app.resource_jarname_misc">
      <value>/opt/XyEnterprise/LiveContent/wietmsd-skin.jar</value>
    </configitem>
  9. Configure collection information by checking or ensuring the presence of the following:
    <collection name="COLLECTION">
    
      <configitem name="http_name">
        <value>URLFORPUBDOCS</value>
      </configitem>
    
      <configitem name="dir">
        <value>PUBLICATIONLOCATION</value>
      </configitem>
    
      <booklist>
        <book name="PUBLICATION">
          <configitem name="bookTextDB">
            <value>FILENAME.pdm</value>
          </configitem>
          <configitem name="bookTitle">
            <value>TITLE</value>
          </configitem>
          <configitem name="bookModel">
            <value>MODELIDENTIFIER</value>
          </configitem>
          <configitem name="bookDescription">
            <value>DESCRIPTION</value>
          </configitem>
          <configitem name="PubIssue.value">
            <value>X.Y</value>
          </configitem>
          <configitem name="PubNumber.value">
            <value>NUMBER</value>
          </configitem>
          <configitem name="PubDate.value">
            <value>DATE</value>
          </configitem>
          <configitem name="search">
            <value>systtlSearch;tpcttlSearch;fgrttlSearch;tblttlSearch;pnrSearch;dfpSearch;mfcSearch;docidSearch</value>
          </configitem>
        </book>
      </booklist>
    
    </collection>
    where:
    • COLLECTION is the name of your collection, say default
    • URLFORPUBDOCS is the URL to get publication documents, say IETMBooks3
    • PUBLICATIONLOCATION is the location of publications referenced in this collection, which defaults to C:\LiveContent\AppData\publications for Windows and to /opt/XyEnterprise/LiveContentData/ for Linux
    • PUBLICATION is the name of a publication in your collection. Create additional <book> elements inside <booklist> for more publications
    • FILENAME.pdm is the name of the main publication file (with a .pdm extension)
    • TITLE is the title of the publication
    • MODELIDENTIFIER is the model identifier for the publication, say, BIKE
    • DESCRIPTION is a human-readable description of the publication
    • X.Y is the publication issue number, such as 1.0 or 3.5
    • NUMBER is the publication number, such as A1-AAAA-1
    • DATE is the date on which the publication was published, in the format August 8, 2014
  10. Add the information about your publication or publications to the file.
  11. If you want to customize the front matter that LiveContent S1000D displays when a user opens a technical publication, add the following:
    <configitem name="front_matter_html">
      <value>FILENAME.html</value>
    </configitem>

    where FILENAME.html is the name of the HTML file to use as the front matter. Create a file by this name in the folder httpdocs/book_data/COLLECTION/PUBLICATION/ folder, where COLLECTION is the collection name and PUBLICATION is the publication name.

  12. To configure the version for the publication, add the following:
    <configitem name="Client_Version">
      <value>X.Y</value>
    </configitem>

    where X.Y is the version number.

  13. To configure that the publication should upgrade without prompting, add the following:
    <configitem name="Client_AutoUpgrade">
      <value>1</value>
    </configitem>
  14. To prompt users before installing an older version of the publication, add the following:
    <configitem name="Client_OldVersion">
      <value>ASK</value>
    </configitem>
  15. Alternatively, to disable users from installing an older version of the publication, add the following:
    <configitem name="Client_OldVersion">
      <value>DENY</value>
    </configitem>
  16. Save and close wietmsd.xml.
  17. On a Windows system, do the following:
    1. Open a command prompt.
    2. Navigate to the LiveContent S1000D home directory.
    3. Enter the following:
      launch.exe -config PATH/TO/WIETMSD/

      where PATH/TO/WIETMSD is the path to the folder that contains the file wietmsd.xml. For example:

      launch.exe -config C:\LiveContent\AppData\collections\default
    You can now view the publication.
  18. Alternatively, on a Linux system, do the following:
    1. Start a shell session.
    2. Navigate to the LiveContent S1000D home directory.
    3. Enter the following:
      ./LinuxLaunch.sh -config PATH/TO/WIETMSD/

      where PATH/TO/WIETMSD is the path to to the folder that contains the file wietmsd.xml. For example:

      ./LinuxLaunch.sh -config /opt/XyEnterprise/LiveContentData/collections/default
    You can now view the publication.