For support issues please visit https://jira.deiser.com/support

Page tree
Skip to end of metadata
Go to start of metadata

Publish Documentation Interface:

The Publish Documentation interface allow us to configure a lot of properties of the documentation we are about to publish. These are the most remarkable of them:

  • Confluence Space

The user has to decide whether he wants to create a new space in Confluence with the documentation that is about to publish or he prefers to use an existing space as target.

      • Creating new Space

        A new Blank space type will be created with the corresponding pages based on the publish options selected by the user.

 

      • Using existing Space

Using this option 'EA Connector for Confluence' searchs for the identifier of the selected space's pages contained in the label shown in the image. This identifier is related with the published EA object GUID, so it must not be deleted nor modified. If the identifier exists, the content of the page will be replaced, if don't, a new page will be published. 

The process works differently depending on these two options:

  • Maintain pages: by selecting this option the pages with identifiers that don't belong to the current collection of elements that are going to be publish won't be deleted. The current collection of elements will be publish on the first level of the space under the Space's Home Page. The user will be able to place the pages through the option "View Hierarchy" in Confluence.

 

 

  • Delete pages: the existing pages that don't belong to the current collection will be deleted before publish the selected elements,
  • Templates

   This section has been included in order to let the user to choose the Template that will provide the format of the publication's pages. The Default Template will appear by default.

   Clicking on the "Edit template" button the template's edit form will appear to modify the selected template. The default template can't be modified.

   The managing of templated are explained in depth in the Custom Templates section.

 

 

  • Contents

    The elements' collections appears in EA as shown in the image bellow (Element Browser) or in the elements or packages properties' window.

  • Hierarchy

EA Connector for Confluence allows the user to apply three Confluence page rupture modes.

 

    • One single page.

      If this option is selected, the selected package and all its content including siblings packages and elements will be exported in one single page observing the hierarchy of the EA Project Browser. Inside the Confluence's page the user will be able to move from parent elements to descendants.

 

    • Page per Package.

      Choosing this option, as many pages as packages have the selected package including this one will be created.

 

    • Page per Element.

      In this case a page will be created per each element and package contained in the package to publish. Beside, all cases allow the access to the diagrams exported by expand the link of the image bellow.



Depending on the hierachy mode selected, the internal page structure and links will be different. Here is an example of the structure and links that you will find in a published space:

 

 

  • No labels