Child pages
  • Doctype Add-on Specification

Versions Compared

Key

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

...

Section
show-titlefalse
titleSpecification

To create your add-on we require a specification for your add-on, your space, and your doctypes / blueprints.

Tip Box

Howto create your Information Model may help you to find the information you need to create this specification.


Section
titleAdd-on
  • Name
  • Description

The information will be used for your add-on.

Example Box
titleExample

The example add-on is named 'projectdoc for Project Management'. The description is 'projectdoc Blueprints for managing agile projects.'.



Section
titleSpace
  • Name
  • Description
  • About
Example Box

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.

Image Modified



Section
titleDoctypes / Blueprints
  • 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|portrait|empty|type) - use 'standard' if it is not a type doctype; otherwies 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.

Example Box

The example doctype / blueprint is named 'Minutes', the description is 'Add meeting notes.'

Image Added

The about text is 'Record the results and action items of a meeting.'.

Image Added




Section
titleSubordinate Generics
Display Table
doctypegeneric
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...