Versions Compared

Key

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

...

Section
indextrue
show-titlefalse
titleDescription

Creates a set of documents based on a description document.

The service accepts JSON and XML documents.

Transclusion
documentPlease Backup your Data first!
idsSummary


...

Section
titleParameters

The following parameters allow to control the creation of the projectdoc documents.


Transclusion
taget-heading-level*
documentDocuments Service / POST
idsspace-key


Transclusion
taget-heading-level*
documentDocuments Service / POST
idslocation



Section
titleDocument

The basic structure is a list of documents.

Code Block
languagejs
{
  "documents": [ ]
}    

Each document has three properties:

  1. property
    1. name
    2. value
    3. controls
    4. position
  2. section
    1. title
    2. content
  3. children - list of documents
Code Block
languagejs
{
      "property": [],
      "section": [],
      "children": []
}    

The basic structure of a property:

Code Block
languagejs
{
  "name": "Iteration",
  "value": "production",
  "controls": "hide",
  "position": "replace-values"
}   

The basic structure of a section:

Code Block
languagejs
{
  "title": "References",
  "content": "The content in Confluence Storage Format."
}   


Example Box
titleExample Document


Expand


Code Block
languagejs
{
  "documents": [
    {
      "property": [
        {
          "name": "Short Description",
          "value": "Document your content management strategy.",
          "position": "replace"
        },
        {
          "name": "Doctype",
          "value": "category",
          "position": "merge"
        },
        {
          "name": "Name",
          "value": "Content Management",
          "position": "merge"
        },
        {
          "name": "Iteration",
          "value": "production",
          "controls": "hide",
          "position": "replace-values"
        }
      ],
      "section": [],
      "children": [
        {
          "property": [
            {
              "name": "Short Description",
              "value": "The content design consists of the editorial strategy and experience design.",
              "position": "replace"
            },
            {
              "name": "Doctype",
              "value": "category",
              "position": "merge"
            },
            {
              "name": "Name",
              "value": "Content Design",
              "position": "merge"
            },
            {
              "name": "Iteration",
              "value": "production",
              "controls": "hide",
              "position": "replace-values"
            },
            {
              "name": "Sort Key",
              "value": "0010",
              "controls": "hide",
              "position": "replace"
            }
          ],
          "section": [],
          "children": [
            {
              "property": [
                {
                  "name": "Short Description",
                  "value": "Part of the content design the experience design documents the audience\u0027s needs and preferences, the shape of the ecosystem the content is part of, and the way the audience encounters and interacts with the content. It also takes into account the different environments from which users of the content will access the content. This leads to the decision in which formats the content will be delivered.",
                  "position": "replace"
                },
                {
                  "name": "Doctype",
                  "value": "category",
                  "position": "merge"
                },
                {
                  "name": "Name",
                  "value": "Experience Design",
                  "position": "merge"
                },
                {
                  "name": "Iteration",
                  "value": "production",
                  "controls": "hide",
                  "position": "replace-values"
                }
              ],
              "section": [],
              "children": []
            },
            {
              "property": [
                {
                  "name": "Short Description",
                  "value": "Part of the content design the editorial strategy documents the goal, the target audience, and the general guidelines you define to talk to your audience.",
                  "position": "replace"
                },
                {
                  "name": "Doctype",
                  "value": "category",
                  "position": "merge"
                },
                {
                  "name": "Name",
                  "value": "Editorial Strategy",
                  "position": "merge"
                },
                {
                  "name": "Iteration",
                  "value": "production",
                  "controls": "hide",
                  "position": "replace-values"
                }
              ],
              "section": [],
              "children": []
            }
          ]
        },
        {
          "property": [
            {
              "name": "Short Description",
              "value": "The system design consists of the information architecture and process design.",
              "position": "replace"
            },
            {
              "name": "Doctype",
              "value": "category",
              "position": "merge"
            },
            {
              "name": "Name",
              "value": "Systems Design",
              "position": "merge"
            },
            {
              "name": "Iteration",
              "value": "production",
              "controls": "hide",
              "position": "replace-values"
            },
            {
              "name": "Sort Key",
              "value": "0020",
              "controls": "hide",
              "position": "replace"
            }
          ],
          "section": [],
          "children": [
            {
              "property": [
                {
                  "name": "Short Description",
                  "value": "The process design explains, which tools are used, how new users are welcomed on-board, and which processes support the development of content and the maintenance of the support structures. This also includes a description about the change management process.",
                  "position": "replace"
                },
                {
                  "name": "Doctype",
                  "value": "category",
                  "position": "merge"
                },
                {
                  "name": "Name",
                  "value": "Process Design",
                  "position": "merge"
                },
                {
                  "name": "Iteration",
                  "value": "production",
                  "controls": "hide",
                  "position": "replace-values"
                }
              ],
              "section": [],
              "children": []
            },
            {
              "property": [
                {
                  "name": "Short Description",
                  "value": "The information architecture explains how content is organized and why it is organized that way. It also includes how and which content should be added.",
                  "position": "replace"
                },
                {
                  "name": "Doctype",
                  "value": "category",
                  "position": "merge"
                },
                {
                  "name": "Name",
                  "value": "Information Architecture",
                  "position": "merge"
                },
                {
                  "name": "Iteration",
                  "value": "production",
                  "controls": "hide",
                  "position": "replace-values"
                }
              ],
              "section": [],
              "children": []
            }
          ]
        }
      ]
    }
  ]
}





Section
titleDoctype Maven Plugin Support

The Doctype Maven Plugin supports generating category trees since version 1.8.

To switch on category tree generation by setting the generateCategoryTree to true.

Code Block
languagexml
<generateCategoryTree>true</generateCategoryTree>



Section
titleREST Service

The Documents Create Hierarchy Service is used to create document instance hierarchies.


Section
titleSubordinate Components
Display Table
doctypeaddon-component
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleReferences


Section
titleResources


Tour


TitleShort Description
Confluence Storage FormatThis page describes the XHTML-based format that Confluence uses to store the content of pages, page templates, blueprints, blog posts and comments. This information is intended for advanced users who need to interpret and edit the underlying markup of a Confluence page.