projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 7

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 8

changes.mady.by.user Robert Reiner

Saved on

Key

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

...

Section
titleHands-on Steps

Create an new space that will be your index space.

Section
titleCreate an Agile Project Space

  1. The Core Doctypes Add-on provides the index space blueprint.

    Version Box
    until8.x

    Prior to version 9.0 of the Core Doctypes: Select the Agile Project Space space blueprint for the creation of your index space.


  2. Choose IDX for the space key of your index.

    Image Modified

    Note Box

    If you cannot use IDX as the space key, use any other key. The only drawback is that you have to set the index space for all your spaces explicitly.

    All spaces delegate to the space with key IDX per default. To switch off this default behaviour, set use-default-space to false.

    For more information refer to: delegate-space.


  3. Have a look at the new index space (for versions prior to 9.0)

The new index space provides homepages to store documents that are relevant to all your spaces.

Expand
titleExplain the screenshot ...


Section
titleTypes

The box labelled with Index contains references to homepages for the following types

The Team & Stakeholdes box contains a reference to Roles that are used globally.


Section
titleRepositories

Repositories are defined in the Documentation, Project Library, Team & Stakeholders, and For Authors box:

  • Documentation
    • Tours - group material for readers in a given context
    • FAQs - a corporation-wide FAQ repository
    • Topics - information relevant for all users
    • Glossary - a corporation-wide glossary
  • Project Library
    • Resources - a corporation-wide library
    • Quotes - a corporation-wide repository of inspiring quotes
  • Team & Stakeholders
    • Stakeholders - list of persons with their functions
    • Persons - a corporation-wide address book
    • Organizations - a corporation-wide repository of partner and customer corporations
  • For Authors
    • Modules - a corporation-wide repository of reusable page fragments to be reused with transclusion




Section
titleSpecify a Space Property

The space property extract-short-description-from-metadata-table controls whether a short description is rendered within the properties table of a document or in front of it.

Section
titleSample Page with Short Description

First we need to create a page with a short description (for this exercise only):

  1. Create a page with the projectdoc Blank Document Blueprint
  2. Provide a name and a short description, then check the box to send the document to its homepage
  3. Click 'Create' to see the document in the editor
  4. Click 'Save' at the bottom of the page

This is the new document:


Section
titleAdd a Space Property

Now add a property to the space homepage.

  1. Open the homepage of your index space
  2. Click 'Edit' to edit the homepage
  3. Add a property named extract-short-description-from-metadata-table and value true (choose hide as a value for the third column, which is called the property control) to the table within the Document Property Marker Macro at the top of the document

  4. Save the homepage

Finally have a look at the test document you created in the index space in the previous step.

The short description is rendered in front of the properties table. The space property extract-short-description-from-metadata-table controls the rendering of every document in the space (or any space that delegates to this space and does not override this property).

Tip Box
titleTips staying sane
  1. To have a look at the currently set space properties, add the Display All Space Properties Macro to a page
  2. projectdoc is picky with the entered values: There must not be any markup for the space property name or value, just the pure text value. Use the Confluence Source Editor Add-on to check the values
  3. To have a look at the document properties in the view, use the Display All Document Properties Macro Macro
  4. The Document Properties Marker Macro allows to override space properties with the Override parameter




...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH