Jump to main content

User Guide for Writers
User FAQ
Glossary
Notices

Index

Home
User Guide for Writers
The user guide for writers using IXIA CCMS Web. It contains information to help users with authoring, managing, and reviewing content in CCMS Web.
Topics
Topics are the basic containers for all content in IXIA CCMS Web.
Topic modification

User Guide for Writers
The user guide for writers using IXIA CCMS Web. It contains information to help users with authoring, managing, and reviewing content in CCMS Web.
- Get started
  This section provides you the tools you need to access IXIA CCMS Web.
- Maps
  Maps provide a structured hierarchy to the objects and content within it.
- Topics
  Topics are the basic containers for all content in IXIA CCMS Web.
  - Topic creation
    Create a topic for use in a map, once you determine the nature of content you intend to develop and its relationship to other map objects.
  - Topic modification
    - Topic Editor
      Topic Editor provides the editing tools you need to add or change content in topics.
    - Check out an object
      You must check out an object, such as an image, map, or topic before you can edit it.
    - Designate a context map
      While in a topic, you can determine if there is a context map in the Details side panel. If the topic does not have one or you need to switch to a different context map, you can designate a context map.
    - Track your changes during check in of an object
      You may be prompted to provide a description of the changes or add a tracker link when you check in an object, depending on the workflow settings in IXIA CCMS.
    - Edit an object in DRM
      In IXIA Dynamic Release Management (DRM), if you edit an object in more than one Branch, you can choose whether to edit the object in some or all of the branches that use it.
    - Add a comment during an edit
      You can add comments while editing an object, such as a topic, to provide feedback to others.
    - Manage comments
      You can manage comments while editing an object in any editor.
    - Upload and add an image to a topic
      If the image you need does not already exist as an object in IXIA CCMS Web, you must add it, which requires an upload.
    - Add an existing image to a topic
      You can search the images already uploaded to IXIA CCMS Web for inserting within a topic.
    - Conditional content
      You can condition content by adding a metadata or profiling attribute to an element to specify either information about the element or for the element's inclusion or exclusion during output.
    - Insert a key in a topic
      You can insert an element as a variable into a topic as a key, also known as a key reference or <keyref>.
    - Insert a special character in the content
      During development or edit, you can add special characters to CCMS Web content.
    - Adjust table properties
      You can format tables using the Table Properties dialog.
    - Adjust the width of a column
      You can adjust the width of a column in a table using the <colspec> element.
    - Modify the method to view XML tags
      You can change how XML tags are used to mark up the content in the Main Editing area.
  - Links between topics
    Use links in topics to direct end users to other topics that might be useful or are related to the current topic.
  - Content reuse
    In IXIA CCMS Web, you can reuse content instead of creating multiple copies of the same content.
- Images
  Upload images that you want to use to IXIA CCMS Web.
- Content and object management
  IXIA CCMS Web manages content as a variety of objects according to its specified workflow.
- Resources
  Resources are non-DITA files (such as PDF files and Word files) that support documentation. You can use resources to upload and store these files in IXIA CCMS. For a definition of what constitutes a resource, see https://www.oxygenxml.com/dita/1.3/specs/archSpec/base/dita-terminology.html.
- Assignments
  You can track all IXIA CCMS Web work assigned to you on the My Assignments page.
- Collaborative Review feature
  Reviewers can use the Collaborative Review (CR) feature on the content assigned to them as a means to both provide feedback to writers and view any annotations added by other assigned reviewers.
- The Approvals feature
  Use the Approvals feature to get a final sign off on content after completion of all reviews.
- Unified localization
  The latest approach in IXIA CCMS Web 7.3, known as unified localization, significantly departs from the approach to localization in previous releases of CCMS Desktop.
- Output generation and publication
  All of the content that you create can be exported from IXIA CCMS Web to the target document deliverables using the IXIA CCMS Output Generator. The CCMS Output Generator is the component that executes the transformation processes from DITA files to a specified output type, such as PDF, HTML, and XML.
- Technical support
  IXIA CCMS Customer Support staff are available to answer your questions. We welcome your comments.

Topic modification

Generated by IXIA CCMS oXygen Webhelp