Wiki syntax

From IMAGE
Jump to navigation Jump to search

Opmerking deze help toevoegen aan Het Help navigatiedeel voor de schrijvers Er komt guidelines en een of meer help pagina's

Help wiki general

Publication process

How to handle changes

There are several situations with different solutions:

  1. Minor text change, may be a correction or enhancement: Enter the changes in the wiki.
  2. Small adaptations to model components or substantial rewriting of a description: Use the hasStatus property (publishable/ on hold) in the forms. Pages with an status 'on hold' will not be published to the external wiki, that is the wiki as seen by the world outside PBL. You have time to enter the changges and have some checks, on the content and redactional, on the change.
  3. Substantial change resulting in a new version: When making a substantial change to your model by adding a submodule or changing the conceptual model, you can document (and discuss) this change in the namespace 'Next'. This namespace is part of the wiki, but does not influence the content of the so called 'Main' namespace. You can implement the change and document it in the wiki. When the changed model/component is taken in production (new version number of module and framework...), the new description of the component must be copied from the 'Next' namespace to the 'Main' namespace. See the following paragraph for the procedure.

Create new version of an existing component

Steps for creation:

  1. Copy existing component page 'ComponentX' to the page Next:ComponentX
  2. Edit Next:ComponentX and adjust the used template to NextComponentTemplate2 (how?)

Now you have a component in the Next-namespace which you can edit without consequences for the existing wiki. All created links (infobox, inputs/outputs, asumptions, policy interventions,…) will be located in the namespace 'Next'

Steps for publishing, this is an action for the 'gardener':

  1. Copy all pages in the "Main' namespace to the 'Previous' namespace ( how ?)
  2. Copy all pages from the 'Next' namespace concerning the new version into the 'Main' (how)

This way we wiil have an active documenation of the previous, current and next version of the IMAGE framework

Help wiki syntax

Help pictures/images/files

help tables