Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionDocument a version of a product or service. 
Doctypedoctypehide
NameVersion 
IDversion 
SuiteCore
SetCore
 
hide
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
propertyDocumentation Type
 
Categories
Name List
doctypecategory
names/ Document / Data
propertyCategories
 
Tags
Tag List
namesMaven, POM Import, Core
 
Iteration
Iteration
valueproduction
hide
Since4.0.0 
Sort Keyhide



Section
indextrue
titleDescription

Version documents, and their subdocuments (typically of document type Metadata), provide information that is specific for a special version of a product or service.

The version information is kept for each version. Reference the current version of the documentation from the space homepage. Please refer to space-properties-extension Space Properties Extension (Space Property) for details.

This mechanism allows to import information from a POM and store it in a space. The space provides information for all versions of the product or service and its version specific information is available to all documents. It is not designed to keep multiple versions of document trees. Although this may work for projects with minor variable parts, but may not scale with the number of documents you need for version specifics.

...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
level2
titleproject-logo

A hidden property to store the logo of the project to be transcluded using the Display Document Property Macro.


Section
level2
titlespace-properties-extension-doctypes

A hidden property that references all Metadata documents that are children to this Version document.

The space properties can be easily defined to include all document properties of a Version document and all its Metadata documents. See space-properties-extension Space Properties Extension (Space Property) for more information.



Section
titleSections


Section
level2
titleDescription

A description of the version.


Section
level2
titleMetadata

A list of Metadata documents that provide space properties for this version.


Section
titleReports

Lists the reports that are attached as children to this version document and are not of type Metadata.


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...

Section
titleDetails


Section
level2
titlePOM

If the version document is created from a Maven POM file, the generation process will create a Metadata document with that POM's information. The POM file will be attached as a JSON document to that Metadata document.

Note Box

There is a slight difference between specifying the POM via URL or G:A:V (groupId:artifactId:version):

URLThe POM file is stored in a temporary folder and then resolved. Only dependent artifacts end up in the local artifact repository.
G:A:VThe POM file is resolved within the Maven environment. Every artifact ends up in the local artifact repository.

Therefore using an URL to a POM file is only recommended if you do not want to add this file to the repository.


Note Box

To use the POM feature, the Maven Extension has to be installed for the projectdoc Toolbox version greater or equal to 1.11. If not, the POM Reference input field is disabled.



Section
level2
titleHomepages

Version documents do not provide a separate homepage from their index page. This is because subversions are not attached as children to a page. Therefore the contents of a homepage and a index page would be the same. To remove redundancies, the default target for a version document is its index page.


...

Section
indextrue
titleRelated Doctypes

The following doctypes are related to the Version doctype.

Tour
render-as-definition-listtrue
replace-title-with-nametrue


TitleShort Description
Metadata 




Section
indextrue
titleSub-Doctypes
Display Table
doctypedoctype
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleReferences


Section
titleResources

The following resources are related to the Version doctype.

Tour
render-as-definition-listtrue
replace-title-with-nametrue


TitleShort Description
Maven Extension 
Maven POM Import 

 

...




Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-doctype
Typecore