Archive: Difference between revisions

From IAMC-Documentation
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
You can archive the current content of your model in a pdf file.
How to handle different versions of your model on the IAMC wiki?


Steps:
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.
# Select the 'To pdf' page for your model
# Use the Print function of your browser (Ctrl P); select as Printer 'Adobe PDF'; click Print and save as <model name>-<version>.pdf
# Upload  the pdf to the wiki using Tools => Upload file
# Edit the page: [[Archived model versions]].  
## Double click in the right column cell of your model;
## Enter the string to link;
## Select this string and use the Link option;
## Enter: File:<model name>-<version>; a list of hits will appear.  
## Select the appropiate pdf file;
## Edit the link and change 'File:' intto 'Media:'. This will open the pdf when a user clicks on the link
## Save the page


= Archive pages =
= How it works =
* [[To pdf - AIM-Hub]]
* 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.
* [[To pdf - BLUES]]
* 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
* [[To pdf - COFFEE-TEA]]
* 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.
* [[To pdf - DNE21+]]
* The infobox on the documentation pages contains a section ''Previous versions''. All version pages will be listed here.
* [[To pdf - E3ME-FTT]]
Note: You can always create a pdf of the snapshot page for backup purposes
* [[To pdf - GCAM]]
 
* [[To pdf - GEM-E3]]
= The update process of a model =
* [[To pdf - IFs]]
An update of the documentation of your model to a recent version should follow these steps:
* [[To pdf - IMACLIM]]
# 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).
* [[To pdf - IMAGE]]
# Use the Archive page of your model (see table in next section) to create a version page.
* [[To pdf - IPETS]]
# Change the version number in the About section into the new version number
* [[To pdf - MESSAGE-GLOBIOM]]
# Start updating the content
* [[To pdf - POLES]]
 
* [[To pdf - REMIND]]
= Overview of models and archive pages =
* [[To pdf - TIAM-UCL]]
{{#ask:[[Category:Model]]
* [[To pdf - WITCH]]
  |? 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 11: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:

  1. 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).
  2. Use the Archive page of your model (see table in next section) to create a version page.
  3. Change the version number in the About section into the new version number
  4. Start updating the content

Overview of models and archive pages

 Snapshot pageArchive pageDocumentation stageParticipationCurrent archives
VESPApublishedreference card only
IPETSpublishedreference card only
TIMES-Francepublishedreference card only
BETpublishedreference card only
REModpublishedreference card only
IMACLIM-NLUpublishedreference card only
SNOW GL HHpublishedreference card only
AIM-Hub Thailandpublishedreference card only
China TIMESpublishedreference card only
DARTpublishedreference card only
GENeSYS-MODpublishedreference card only
MESSAGE Koreapublishedreference card only
GCAM-KSApublishedreference card only
WEGDYNpublishedreference card only
AIM-Enduse Japanpublishedreference card only
Euro-Calliopepublishedreference card only
RICE50+publishedreference card only
MIGRATIONpublishedreference card only
AIM-Hub Viet Nampublishedreference card only
GCAM-KAISTin preparationreference card only
ENVISAGEin preparationreference card only
McKinseyin preparationreference card only
IMACLIM-Indiain preparationreference card only
PRIMESin preparationreference card only
MEDEASin preparationreference card only
AIM-Hub Indonesiain preparationreference card only
GCAMunder reviewfull
GRACEunder reviewfull
IFsunder reviewfull
COFFEE-TEAunder reviewfull
PROMETHEUSunder reviewfull
E3ME-FTTsubmittedfull
IMAGEpublishedfull
AIM-Hubpublishedfull
TIAM-UCLpublishedfull
MESSAGE-GLOBIOMpublishedfull
WITCHpublishedfull
DNE21+publishedfull
BLUESpublishedfull
GEM-E3publishedfull
C3IAMpublishedfull
IMACLIMpublishedfull
REMIND-MAgPIEpublishedfull
POLESpublishedfull
IPAC-AIM technologyin preparationfull
WITNESSin preparationfull
MARKAL-Indiain preparationfull
EPPAin preparationfull
ENV-Linkagesin preparationfull
MUSEin preparationfull
... further results