Settings

Library configuration & administration

There are a number of library settings that define how Author-it deals with content. Library settings are available under the Settings section in Author-it Administrator.

  • Xtend settings that display indexing information for the library.
  • General settings that configure the drop-down list when inserting File objects from the Thumbnail view.
  • History settings that create and store history records for modifications to an object.
  • Publishing settings used for including image files with books published to XML.
  • Localization manager settings that control how images are included with the Translation Job XML files.
  • Change timestamp settings that control the Modified Date when a release state is changed.
  • Email settings are used to configure the mail server details used email notifications in Review.
  • Publishing server settings used to define publishing paths used by Localize (and Contribute).

    The Publishing Server Settings window in Author-it administrator has setting used by the Publishing service and Contribute.

    A Publishing server has Author-it Service Manager installed, and runs the Publishing service. The Publishing service processes remote publishing jobs and publishing jobs for Contribute.

    Note: Contribute replaced Author-it Live. Some of the names in the Publishing Server Settings window use Author-it Live rather than Contribute.

    Publishing Server Settings from Administrator

    • Live Library Alias - This setting is automatically populated from the Contribute file Library.config. The alias is the "user-friendly" name given to the library; it is used when logging in.
    • Live Base URL - This option was required to open Author-it Live inside Author. It isn't required for Contribute.
    • Publishing Server Path - Determines the location that the Publishing service sends published outputs to. This should be the location of the publishing folder for Contribute and remote publishing jobs. In a multi-server environment this could be a network location.
    • Publishing Server URL - The URL to the virtual directory of the Contribute publishing folder.
      For example, http://[domain]/Contribute/publishing
      Required to view published outputs on the Publishing page in Contribute. If this URL is incorrect, when contributors attempt to view a published output, Contribute will be unable to locate it.
    • Publishing Sub Folder path - defines how the publishing files will be stored in the publishing folder for Contribute and remote publishing jobs, and the naming conventions that will be used. The publishing sub folders are created as a job is published.
      • If the "Publishing Sub Folder" field is empty, the publishing job will add all files created by the publishing job directly to the publishing folder, instead of adding them to a sub folder.
      • Use variables to add the sub folders for the published output. For example, SYS_PUBLISH_TYPE will resolve to the sub folder name from the publishing profile (such as HTML Pages), and then SYS_DESCRIPTION will resolve to the next level of sub folder with the name based on the book object's description field.

        For example, when you publish the "Acme Staff handbook", the following sub folders could be created in the publishing folder HTML Pages\Acme Staff Handbook

      • Each variable used in this field must be separated with a back slash, but ensure you don't add a back slash at the start of this value. If you do, when contributors attempt to view a published output in Contribute, Contribute will be unable to locate it.
      • Part of the publishing server URL and publishing sub folder path are combined and transformed to provide the full path to the published content.

        For example, this would create the following path in IIS Manger as the "Local path" for the directory: [Default Web Site]\Contribute\Publishing\HTML Pages\Acme Staff Handbook

    Other variables that can be used in the "Publishing Sub Folder" field are:

    <SYS_USER>

    Creates a sub folder for the logged in user.

    <SYS_AD_USER>

    Creates a sub folder for the logged in Active Directory user (use this variable when your library is using Active Directory).

    <SYS_PUBLISH_TYPE>

    Creates a sub folder named after the publishing profile description.

    <SYS_DESCRIPTION>

    Creates a sub folder named using the Book object's description field.

    <SYS_GUID>

    Creates a sub folder named using a globally unique identifier such as "bb4b0b17-74c5-41b0-8f92-434ca46352b9".

    <SYS_PUBLISH_BOOK_ID>

    Creates a sub folder named using the book's object code.

  • Review settings are used to configure the Review access for the View History functionality.
  • Plugin settings are used to configure a plugin used with Author.