Description

Learn about the description package.

The following information is displayed on the description page:

  • Information on the package version (only in the package description), see Package Version Number
  • Title
  • Subtitle
  • Author
  • Description of the package, process or item
  • Entries in the history, see History
  • Hyperlinks
  • Descriptive documents

You can collapse and expand the individual sections by clicking on the small up or down arrows to the left of the headings. In the screenshot above, the history has been collapsed.

You should always enter information under Description that describes the functionality of the package, process or item for documentation purposes.

To enter the description of a package:

  1. Click on Description in the icon bar or select View > General > Description from the menu.

    The description page is displayed. This description page includes the package description, package history, hyperlinks and any attached documents. In addition, the package description includes a version number, see Package Version Number .

  2. Click on the icon next to Description. A dialog box opens.
  3. Enter the description of the package in the dialog box and confirm with OK.
  4. Enter a Title, Subtitle (used on the title page by documentation generated by CRM.cockpit) and Author in the same manner, see Documentation .

You can also add entries to the package history, attach documents or define hyperlinks by clicking on the icon next to the appropriate option:

  • Hyperlinks: You can enter a URL to be associated with a process or item. Add "http://" to the start of the URL to ensure that links are opened correctly from within your documentation. Clicking on the URL in CRM.cockpit opens the page in your default browser.
  • Descriptive Documents: You can associate documents with processes and items. You can choose to add a document from Aurea.CRM's database or from your local file system. Either browse to the desired file or search for and select the desired document in the Aurea.CRM database. If you add a file from your file system, the file is added to the Aurea.CRM database.

    Once you have added a file, click on the hyperlink to open the document in the associated application.

    Image files (PNG, 24-bit BMP, JPG) added to items are embedded in the appendix when generating documentation, see Documentation .

  • Select an item using its check box and click on to delete an item.
    Note: You cannot delete history items.