Publication process: Difference between revisions

From IMAGE
Jump to navigation Jump to search
 
(46 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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 be probably ([[DiscussionItems#Maintenance|discussion item]]) 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.
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 items#Maintenance|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 persons and external people that can login (?). To all these people in principle all contentpages are visible. 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.
* 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.
* External wiki: This is the publishable part of the internal wiki and will be accessible for the outside world via a PBL URL.
== The basics ==
*'''CurrentVersion''': This is the version number of a page, given for each page individually
*'''CurrentFrameworkVersion''': This is the version number of the '''Wiki as a whole''', which is only increased when a new release is started.
*'''Approved/ unapproved pages''': The external wiki will only show approved pages. An unapproved page will be put to approved by the editors after the approval procedure.
*'''Approve-revisions-permission''': This permission allows you to look at pages which have the unapproved status. On default the latest approved page will be shown, but with this permission a link will be shown which gives access to the latest/unapproved version of the page. This permission is only given to people who have a user-login.
*'''Automatic approval''': On default each change will automatically be approved, and is thereby directly visible for external people. Automatic approvals will not be applied to new pages and pages which are actively put to the unapproved status.
== How to handle changes ==
== How to handle changes ==
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, either a correction or enhancement
#Small adaptations to model components or substantial rewriting of a description: Use the hasStatus property (publishable/ on hold) in the forms.
##Enter the changes in the wiki.
 
## Do not increase the CurrentVersion number and do not apply the approvement procedure
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, substantial rewriting of a description or the creation of new pages
# 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.
##Adjust the text
 
##After saving the first time; put the version you are currently working on to 'unapproved' via the history tab on the wiki-bar. All changes after this adjustment will stay on 'unapproved'
=== Create new version of an existing component ===
## Do this for the whole set of pages where you want to make adjustments. When all changes in this set of pages are done:
Steps for creation:
##Start the approvement procedure:
#Copy existing component page 'ComponentX' to the page Next:ComponentX
##*Check the combined set of changed components and individual pages
#Edit Next:ComponentX and adjust the used template to NextComponentTemplate2 (how?)
##* '''Increase the Currentversion number of each component you have changed (increase per component, not per page) '''
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'
##*Editorial step for Editors:
##**Check the page and apply the 'approved' status when done


Steps for publishing, this is an action for the 'gardener':
[[Category:Help]]
# Copy all pages in the "Main' namespace to the 'Previous' namespace (or only changed component and how ?)
# 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

Latest revision as of 15:34, 13 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.

The basics

  • CurrentVersion: This is the version number of a page, given for each page individually
  • CurrentFrameworkVersion: This is the version number of the Wiki as a whole, which is only increased when a new release is started.
  • Approved/ unapproved pages: The external wiki will only show approved pages. An unapproved page will be put to approved by the editors after the approval procedure.
  • Approve-revisions-permission: This permission allows you to look at pages which have the unapproved status. On default the latest approved page will be shown, but with this permission a link will be shown which gives access to the latest/unapproved version of the page. This permission is only given to people who have a user-login.
  • Automatic approval: On default each change will automatically be approved, and is thereby directly visible for external people. Automatic approvals will not be applied to new pages and pages which are actively put to the unapproved status.

How to handle changes

There are several situations with different solutions:

  1. Minor text change, either a correction or enhancement
    1. Enter the changes in the wiki.
    2. Do not increase the CurrentVersion number and do not apply the approvement procedure
  2. Small adaptations to model components, substantial rewriting of a description or the creation of new pages
    1. Adjust the text
    2. After saving the first time; put the version you are currently working on to 'unapproved' via the history tab on the wiki-bar. All changes after this adjustment will stay on 'unapproved'
    3. Do this for the whole set of pages where you want to make adjustments. When all changes in this set of pages are done:
    4. Start the approvement procedure:
      • Check the combined set of changed components and individual pages
      • Increase the Currentversion number of each component you have changed (increase per component, not per page)
      • Editorial step for Editors:
        • Check the page and apply the 'approved' status when done
Retrieved from "https://models.pbl.nl/index.php?title=Publication_process&oldid=13389"