Publishing models

The publishing feature produces a hypertext-linked web of HTML pages that shows information about models. The published information mirrors the content of the models, profiles, and packages and you can view the published information by using a standard browser.

About this task

The publishing process re-creates model elements, including diagrams, relationships, and attributes. You can use the published links to traverse the model the same way that you do in the modeling products.

Each published model is a separate, wholly contained entity with its own root page. When you publish, an overview page is generated that contains a link to the root page for each included model.

To publish models to a hypertext-linked web of HTML pages:

Procedure

  1. Make sure that you are in the Modeling perspective.
  2. In the Project Explorer or the Data Project Explorer view, open and select the model or model element to publish, and click Data > Publish > Web or Modeling > Publish > Web.
  3. In the Publish to Web window, on the General tab, select a level of detail:
    • To show only the documentation that is associated with the element, click Minimum.
    • To also show properties and owned elements, click Full.
  4. For models other than data models: Select a navigation style:
    • To provide navigation in separate package and element navigation frames, click Javadoc.
    • To provide navigation through a tree with expandable nodes, click Interactive tree.
  5. Specify any of the following publishing options:
    • To generate diagrams, select the Generate diagram image files check box and select a diagram image format. If you do not generate diagrams, the content is published as text.
      Note: To support the SVG format on a browser, you might need to download a supplemental plug-in.
    • For data models, if you would like add a link to an external source, select Link to external content and type the text to display on the overview page, and specify the location of the link.
    • To display element icons in the navigation panes, and public, protected, or private status icons for the elements, select the Display element icons check box. If icons are not displayed, the published content looks more like Javadoc HTML documentation and the element status is represented with words.
    • To open the overview page when publishing finishes, select the Automatically display published output check box.
    • To delete the old contents of the destination folder before publishing the model, select the Always clean destination folder without asking check box.
    • To sort attributes and operations alphabetically within classes, select the Order class attributes and operations alphabetically check box.
    • To include links to model documentation, under URLs, select Create links.

      If you select Create links, you can also copy file content into the published model by selecting Copy referenced files. This option is useful when the model includes links to local files and when users of the published model do not have access to the original publication directory.

  6. In the Select folder to publish to field, specify the destination folder for your published model.
  7. For models other than data models: To customize the published overview page, click the Overview tab, select the Enable Overview customizations check box, and customize any of the following items.
    • Specify the author, title, company, and whether to display the publishing date.
    • Display a company logo by specifying the location of the image to use.
    • Add a link to an external source by selecting Enable, typing the text to display for the link, and specifying the location of the link.
  8. For models other than data models: To control the element types to include in the main frame of the generated report, click the Types tab and select the element types that you want.

    You can change the order of element types by selecting a type and clicking Up or Down.

  9. For models other than data models: To filter properties for which values are not specified, click the Properties tab and select the check box.
  10. Click OK.

Results

The publishing process starts and a progress bar is displayed. When publishing completes, the output folder contains all the published HTML files for the selected elements of the models.

If you selected the Automatically display published output check box, the overview page of the published content opens to display a link to each of the published model elements. Otherwise, to view the published model, browse to the output folder that you specified and open the index.html file.

What to do next


Feedback