Publication process: Difference between revisions

From IMAGE
Jump to navigation Jump to search
m (Text replace - "DiscussionItems" to "Discussion items")
No edit summary
Line 5: Line 5:
There are several situations with different solutions:
There are several situations with different solutions:
#Minor text change, may be a correction or enhancement: Enter the changes in the wiki.
#Minor text change, may be a correction or enhancement: Enter the changes in the wiki.
#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 changes and do some checks on the content and on redactional level.
#Small adaptations to model components or substantial rewriting of a description: ****
# 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.
# Substantial change resulting in a new version: When making a substantial change to your model by adding a submodule or changing the conceptual model, ****


=== Create new version of an existing component ===
=== Create new version of an existing component ===

Revision as of 11:39, 7 January 2014

There is an internal PBL wiki and an external wiki. The external wiki is a subset of the internal wiki and is meant to be viewed by webusers. The implementation will probably (discussion item) be by installing one wiki inside the firewall and one wiki outside the firewall. The external wiki will be filled by an import of pages from the internal wiki and periodically updated.

  • Internal wiki: This wiki is visible for PBL employees and external people that can login (?). In principle all contentpages are visible for all these people. However there will be a difference between viewers, writers and administrators, with more options available in this sequence. Viewers can view and discuss; writers will have an extended menu with functions to add content and may edit pages; administrators can change the structure and maintain user rights and use other maintenance functions.
  • External wiki: This is the publishable part of the internal wiki and will be accessible for the outside world via a PBL URL.

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: ****
  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, ****

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 (or only changed component and how ?)
  2. Copy all pages from the 'Next' namespace concerning the new version into the 'Main' (how)

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