Archive: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
How to handle different versions of your model on the IAMC wiki? | |||
The underlying software is not made to manage versions of sets of pages, the system keeps a history only for individual pages. So we created a version management solution with pdf-files of previous versions. These pdf-files contain the reference card information plus all documentation pages of a model on the time of creation. | |||
= | = How it works = | ||
* [[ | * A snapshot page has been created for each model: Snapshot of - <model>, for example [[Snapshot of - IMAGE]]. When you open this page, the current content of your model will be retrieved and put together on this page. | ||
* | * An archive page has been created for each model: Archive page of - <model>, for example [[Archive page of - MESSAGE-GLOBIOM]]. This page will guide you through the process of archiving | ||
* The archive page creates a specific version page for your model, named: Archive of <model> version <model version>, for example [[Archive of REMIND version 1.7]]. The version number will be derived from the model info of the ''About'' section of the reference card! The version page contains a link to the archive pdf, the archive date and (optional) a comment. | |||
* [[ | * The infobox on the documentation pages contains a section ''Previous versions''. All version pages will be listed here. | ||
* | Note: You can always create a pdf of the snapshot page for backup purposes | ||
= The update process of a model = | |||
An update of the documentation of your model to a recent version should follow these steps: | |||
# Check whether the version number of your model represents the correct number for the current description in the About section of your model page (see table in next section). | |||
# Use the Archive page of your model (see table in next section) to create a version page. | |||
# Change the version number in the About section into the new version number | |||
# Start updating the content | |||
= Overview of models and archive pages = | |||
{{#ask:[[Category:Model]] | |||
|? IsSnapshotOf=Snapshot page | |||
|? IsArchiverPageOf=Archive page | |||
|? HasProcessState=Documentation stage | |||
|? HasParticipationState=Participation | |||
|? IsArchivedVersionOfModel=Current archives | |||
|sort=HasParticipationState,HasProcessState | |||
|order=descending,descending | |||
}} | |||
[[Category:Editor Tool]] | [[Category:Editor Tool]] | ||
Revision as of 10:21, 10 August 2020
How to handle different versions of your model on the IAMC wiki?
The underlying software is not made to manage versions of sets of pages, the system keeps a history only for individual pages. So we created a version management solution with pdf-files of previous versions. These pdf-files contain the reference card information plus all documentation pages of a model on the time of creation.
How it works
- A snapshot page has been created for each model: Snapshot of - <model>, for example Snapshot of - IMAGE. When you open this page, the current content of your model will be retrieved and put together on this page.
- An archive page has been created for each model: Archive page of - <model>, for example Archive page of - MESSAGE-GLOBIOM. This page will guide you through the process of archiving
- The archive page creates a specific version page for your model, named: Archive of <model> version <model version>, for example Archive of REMIND version 1.7. The version number will be derived from the model info of the About section of the reference card! The version page contains a link to the archive pdf, the archive date and (optional) a comment.
- The infobox on the documentation pages contains a section Previous versions. All version pages will be listed here.
Note: You can always create a pdf of the snapshot page for backup purposes
The update process of a model
An update of the documentation of your model to a recent version should follow these steps:
- Check whether the version number of your model represents the correct number for the current description in the About section of your model page (see table in next section).
- Use the Archive page of your model (see table in next section) to create a version page.
- Change the version number in the About section into the new version number
- Start updating the content
Overview of models and archive pages
| Snapshot page | Archive page | Documentation stage | Participation | Current archives | |
|---|---|---|---|---|---|
| WEGDYN | published | reference card only | |||
| AIM-Enduse Japan | published | reference card only | |||
| GCAM-India | published | reference card only | |||
| Euro-Calliope | published | reference card only | |||
| MIGRATION | published | reference card only | |||
| AIM-Hub Viet Nam | published | reference card only | |||
| IPETS | published | reference card only | |||
| RICE50+ | published | reference card only | |||
| TIMES-France | published | reference card only | |||
| BET | published | reference card only | |||
| IMACLIM-NLU | published | reference card only | |||
| VESPA | published | reference card only | |||
| SNOW GL HH | published | reference card only | |||
| AIM-Hub Thailand | published | reference card only | |||
| China TIMES | published | reference card only | |||
| REMod | published | reference card only | |||
| DART | published | reference card only | |||
| GENeSYS-MOD | published | reference card only | |||
| MESSAGE Korea | published | reference card only | |||
| CCEM | published | reference card only | |||
| GCAM-KSA | published | reference card only | |||
| MEDEAS | in preparation | reference card only | |||
| NICE | in preparation | reference card only | |||
| AIM-Hub Indonesia | in preparation | reference card only | |||
| GCAM-KAIST | in preparation | reference card only | |||
| ENVISAGE | in preparation | reference card only | |||
| McKinsey | in preparation | reference card only | |||
| IMACLIM-India | in preparation | reference card only | |||
| PRIMES | in preparation | reference card only | |||
| PROMETHEUS | under review | full | |||
| COFFEE-TEA | under review | full | |||
| GCAM | under review | full | |||
| GRACE | under review | full | |||
| E3ME-FTT | submitted | full | |||
| IFs | published | full | |||
| IMACLIM | published | full | |||
| WITNESS | published | full | |||
| POLES | published | full | |||
| IMAGE | published | full | |||
| AIM-Hub | published | full | |||
| TIAM-UCL | published | full | |||
| MESSAGE-GLOBIOM | published | full | |||
| WITCH | published | full | |||
| DNE21+ | published | full | |||
| BLUES | published | full | |||
| GEM-E3 | published | full | |||
| C3IAM | published | full | |||
| TIAM-ECN | in preparation | full | |||
| ICES | in preparation | full | |||
| GMM | in preparation | full | |||
| ... further results | |||||