A simple specification for a basic doctype add-on for the projectdoc Toolbox.
To create your add-on we require a specification for your add-on, your space, and your doctypes / blueprints.
How to create your Information Model may help you to find the information you need to create this specification.
Add-on
The following information is required for your add-on.
- Name
- Description
Example
The example add-on is named 'projectdoc for Project Management'. The description is 'projectdoc Blueprints for managing agile projects.'.
Space
The following information is required for your space.
- Name
- Description
- About
The example space is named 'Project Management Space', the description is 'Manage your project.'
The about information is shown on the right below the name of the space.
Doctypes / Blueprints
The following information is required for each of your doctypes / blueprints (max. 5).
- Name
- Description
- About
- has homepage (yes/no) - are documents of this type always children of other documents, then answer 'no'.
- is subdocument (yes/no) - if 'yes' then the title will append the name of the parent document, making it unique within the space.
- has standard type (yes/no) - if there is a type property, answer 'yes'.
- base template (standard|type) - use 'standard' if it is not a type doctype; otherwise use 'type'.
- list of related doctypes (optional) - list doctype the homepage of this doctypes should link to.
- Properties
- Name - the name of the property
- Description (help text) / Value (Macro) - description will only be shown if no value is provided
- Controls (optional) - see Document Property Controls
- Section
- Name - the title of the section
- Description (help text) - will only be shown if the contents is not a macro (see below)
- Intro (optional) - see Section Macro
- Extro (optional) - see Section Macro
- Macro(s) in body (optional) - for instance a Display Table Macro
Basic templates provide no support for wizard configuration (just name, description, and optionally a send-to-homepage button). Also no categories are supported.
The example doctype / blueprint is named 'Minutes', the description is 'Add meeting notes.'
The about text is 'Record the results and action items of a meeting.'.
