Documentation Center

Generating a publication

Complete these steps to generate an IETP using the LiveContent S1000D Publish tool.

Before you begin

  • The LiveContent S1000D Publishing Server must be installed.
  • The source XML and figures for the publication must be copied to the appropriate folders in the LiveContentData directory.
  • The user must have sufficient read-write permissions to create and modify configuration, data, and status log files in their respective directories.

Procedure

  1. Launch the LiveContent S1000D Publish tool.
    1. In Windows File Explorer, navigate to folder containing the LiveContentS1000DPublish.exe executable (by default LiveContent/PublishUI).
    2. Right-click the executable and select Run as Administrator.
    The Publish tool launches in a browser window.
  2. From the LiveContent S1000D Publish home screen, click Publications.
    The Publication List displays a list of the available publications.
  3. Click Add.
    The Publication Configuration Builder appears.
  4. Make entries to the following fields.
    FieldDescription
    IDRequired.

    Name of the folder containing the publication in the LiveContentData/publications directory.

    This value must be unique and can be up to 60 characters in length and cannot contain special characters.

    NameRequired.

    Name of the publication.

    This value can be up to 256 characters in length and cannot contain special characters.

    Module FileRequired.

    The publication module (prefix PMC) for the publication in the LiveContentData/publications/publication_ID/source_xml folder. Browse to the publication module file.

    Windows allows up to 260 for the file path, which cannot contain special characters.

    TitleRequired.

    Free text title of the publication.

    This value can be up to 256 characters in length and cannot contain special characters.

    IssueRequired.

    S1000D Issue of the publication.

    This value can be up to 8 characters in length, consisting only of numbers and a dot, such as 4.0.

    DateRequired.

    Date of the publication. This field defaults to the current date. Use the calendar widget to select a different date.

    NumberRequired.

    Number of the publication.

    This value can be up to 40 characters in length and cannot contain spaces or special characters.

    DescriptionRequired.

    Description of the publication.

    This value can be up to 256 characters in length and cannot contain special characters.

    ModelRequired.

    Model of the publication.

    This value can be up to 40 characters in length and cannot contain spaces or special characters.

    LanguageOptional.

    Language code of the publication in lowercase characters. This field defaults to en.

    This value can be up to 40 lowercase characters in length.

    Change LevelRequired.

    The change level of the publication.

    This value can be up to 8 numbers in length.

  5. Click Next.
    The tool displays a summary of the values you entered.
  6. Click Publish to launch the publish process using these values, or Cancel to return to the Publication Builder to make changes.
    The Status window displays information about the progress of the process, including running tallies of warnings and fatal errors encountered. If the process fails, a Help icon () becomes available to assist with troubleshooting. Click this icon to display a window listing common fatal publish errors.

    When the process completes, the status of the package in the Package List changes to Complete, which appears as a link with an icon indicating success or failure. Click this link to view the process log.

  7. Click Finish to close the Publication Configuration Builder.
    The Publication List appears, including the new publication in the list.

Results

The LiveContent S1000D Publish tool does the following.
  • Creates a configuration file for the publication in the LiveContent/templates/conf directory.
  • Updates the PublicationsData.xml file in the LiveContentData/publishData directory, or creates it if does not exist.
  • Creates a DML file for the publication in its source_xml folder in the LiveContentData directory if applicability is configured for the publication.
  • Updates the publication_PUBLICATION-ID.txt status log file in the LiveContentData/publishData/logs directory, or creates it if does not exist.