Archive/IMAGE3.0/Step by step guide: Difference between revisions

From IMAGE
Jump to navigation Jump to search
(Created page with "==Steps to create a component== In the menu, under useful forms and upload figures,are placed all the 'tools' for creating a component. Steps: You can start with adding all th...")
 
m (Oostenrijr moved page Step by step guide to Archive/IMAGE3.0/Step by step guide without leaving a redirect: archived)
 
(72 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Steps to create a component==
==Step by step==
In the menu, under useful forms and upload figures,are placed all the 'tools' for creating a component.
This is a step by step guide to upload your chapter in the IMAGE-wiki. Some notes:
Steps:
* Use the 'Open in New-tab' option via the mouse to keep your current page open. Since we do a lot of side steps this is the easiest way.
You can start with adding all the elements of a component:
* When you are stuck on something or are not sure how to handle anomalies; make a note on the discussion page via the Discussion-tab in the wiki-bar.
# Upload the flowchart with  'Add component flowcharts' and fill in the metadata
* Don't use the preview option, but save the page to have a look on the result.
# Upload the component icon with 'Add an icon'
===Introduction page===
# Use 'Add policy interventions'  to create an policy intervention. Choose a meaningful name for each intervention. They will be used in overviews, see [[Policy_interventions_overview]]. Append the component code in parentheses, e.g. Agricultural trade policies (AEF).
# Navigate to your component on the wiki, by going to Main overviews => Framework. When you open your component, you will see that the basic structure is already implemented. The component will consist of five component-pages. The start page is the introduction page, the others pages are shown in the infobox and at the bottom of the page. Make sure you understand the structure of the framework elements as are described in the help [[Elements_summary]] and the [[Wiki_syntax]].
# add baseline figure
# Start with the introduction page. Click the Edit-tab in de wiki-bar. You will see the introduction component-form, with some parts already filled.
# add policy intervention figures
# Go to the infobox-part of the form and fill in the key-references which are stated at the bottom of your chapter.
Now we have all elements. Open or create the component. You can do this (new or existing componentwith 'Add a component to the wiki' or use the [[Conceptual_Framework_Overview]], select your component and use the edit option above the page.
# Skip the other fields of the infobox-part and variable-part and go directly to the introduction text of the textual-part at the bottom of the form.
* Start with the Introduction
# Copy the introduction text from your chapter in this field. You can always save your page and see how it looks.
Any time you encounter a project; external Model etc. use the form fields to couple these to the infobox.
# Start the '''editorial process''': Go through your text and please pay attention to the following points (see the [[HowTo]] page):
* Save the page
#* Headers: A webpage needs more headers than are used in a book chapter to guide the reader, so add headers when possible.
Use the links under Main pages header and create the subpages (Note Rineke check ttemplate...)
#* Lists: Lists in the text should be transformed into bullet-ed or numbered text.
#* References:
#*#For published references, there are two actions:
#*#*Link the inline citation to the reference.
#*#*Include this citation in the references-field in the form you are working in.
#*#For unpublished references, create a footnote with the reference.
#* Research organisations;
#* Computer models and databases;
#*Acronyms; acronyms that do not describe research organizations or computer models/databases.
#*Add Figures;
#* In text reference to the figures;
#*Formulas;
#* In text links to other chapters: Replace the chapter-name to the component-name and create the link.
#*Footnotes.
#* Additional information: Make a background information page
#Go to the variable-part of the form. Check the set of input- output-variables and parameters for your component, when you disagree with the content, please make a note in the discussion-tab in the wiki-bar and leave the component-fields unchanged.
# Save the page.
# Go to the section 'Inputs' of the introduction page and edit the description of your parameters. See the related [[HowTo]]. Leave the 'model variables' and 'drivers' unchanged.
# Go to the section 'Outputs' of the introduction page and edit the description of the output-variables. See the related [[HowTo]].
# Save the page
# Click on 'Detailed description' in the infobox. This will lead you to the Detailed description component-form.
 
===Detailed description page===
# Copy the description part of your chapter in the description-field.
# Perform the same editorial steps as stated above.
# Save the page
# Click on 'Policy issues' in the infobox. This will lead you to the Policy issue component-form.
===Policy issue page===
# Copy the Baseline description part of your chapter in the description-field.
# Perform the same editorial steps as stated above.
# Look at the section Policy interventions. This consists of a set of policy interventions and a descriptive example below the interventions. Do the following for each Policy intervention:
#* Go to 'Forms =>Add policy interventions
#* Create a meaningful name for your policy intervention, e.g. Carbon tax.
#* Copy the policy intervention text into the description field for the policy intervention at hand.
#* Fill in the other fields of the form.
#* Save the page
# Navigate to the component-page by using the link to your component which is given at: 'Is policy intervention of' on the page.
# Click on 'Policy issues' in the infobox. This will lead you to the Policy issue page.
# Go back to the Policy issue component-form by clicking on the Edit-tab on the wiki-bar.
# Copy the Policy issue example from your chapter in the appropriate field.
# Perform the same editorial steps as stated above.
# Save the page
# Click on 'Data uncertainties and limitations' in the infobox. This will lead you to the Data, uncertainties and limitations component-form.
 
===Data, uncertainties and limitations page===
# Copy the description part of your chapter in the description-field.
# Perform the same editorial steps as stated above.
# Save the page
===Component info-box===
# Go to the Introduction-page. Go to the infobox-part of the introduction component-form. Check the relations in your chapter to the other parts of the framework. Include those relations in the corresponding fields (Projects/Applications, Models/Databases, Related IMAGE components). <br/>Each field has its own set of possible related items. Look at the overviews for the existing items, they are mentioned above the fields. Get the right item by using auto-completion. For new items see the related [[HowTo]]. <br/> The references-field and key-references have been filled in the previous steps.
 
 
[[Category:help]]

Latest revision as of 11:31, 22 February 2019

Step by step

This is a step by step guide to upload your chapter in the IMAGE-wiki. Some notes:

  • Use the 'Open in New-tab' option via the mouse to keep your current page open. Since we do a lot of side steps this is the easiest way.
  • When you are stuck on something or are not sure how to handle anomalies; make a note on the discussion page via the Discussion-tab in the wiki-bar.
  • Don't use the preview option, but save the page to have a look on the result.

Introduction page

  1. Navigate to your component on the wiki, by going to Main overviews => Framework. When you open your component, you will see that the basic structure is already implemented. The component will consist of five component-pages. The start page is the introduction page, the others pages are shown in the infobox and at the bottom of the page. Make sure you understand the structure of the framework elements as are described in the help Elements_summary and the Wiki_syntax.
  2. Start with the introduction page. Click the Edit-tab in de wiki-bar. You will see the introduction component-form, with some parts already filled.
  3. Go to the infobox-part of the form and fill in the key-references which are stated at the bottom of your chapter.
  4. Skip the other fields of the infobox-part and variable-part and go directly to the introduction text of the textual-part at the bottom of the form.
  5. Copy the introduction text from your chapter in this field. You can always save your page and see how it looks.
  6. Start the editorial process: Go through your text and please pay attention to the following points (see the HowTo page):
    • Headers: A webpage needs more headers than are used in a book chapter to guide the reader, so add headers when possible.
    • Lists: Lists in the text should be transformed into bullet-ed or numbered text.
    • References:
      1. For published references, there are two actions:
        • Link the inline citation to the reference.
        • Include this citation in the references-field in the form you are working in.
      2. For unpublished references, create a footnote with the reference.
    • Research organisations;
    • Computer models and databases;
    • Acronyms; acronyms that do not describe research organizations or computer models/databases.
    • Add Figures;
    • In text reference to the figures;
    • Formulas;
    • In text links to other chapters: Replace the chapter-name to the component-name and create the link.
    • Footnotes.
    • Additional information: Make a background information page
  7. Go to the variable-part of the form. Check the set of input- output-variables and parameters for your component, when you disagree with the content, please make a note in the discussion-tab in the wiki-bar and leave the component-fields unchanged.
  8. Save the page.
  9. Go to the section 'Inputs' of the introduction page and edit the description of your parameters. See the related HowTo. Leave the 'model variables' and 'drivers' unchanged.
  10. Go to the section 'Outputs' of the introduction page and edit the description of the output-variables. See the related HowTo.
  11. Save the page
  12. Click on 'Detailed description' in the infobox. This will lead you to the Detailed description component-form.

Detailed description page

  1. Copy the description part of your chapter in the description-field.
  2. Perform the same editorial steps as stated above.
  3. Save the page
  4. Click on 'Policy issues' in the infobox. This will lead you to the Policy issue component-form.

Policy issue page

  1. Copy the Baseline description part of your chapter in the description-field.
  2. Perform the same editorial steps as stated above.
  3. Look at the section Policy interventions. This consists of a set of policy interventions and a descriptive example below the interventions. Do the following for each Policy intervention:
    • Go to 'Forms =>Add policy interventions
    • Create a meaningful name for your policy intervention, e.g. Carbon tax.
    • Copy the policy intervention text into the description field for the policy intervention at hand.
    • Fill in the other fields of the form.
    • Save the page
  4. Navigate to the component-page by using the link to your component which is given at: 'Is policy intervention of' on the page.
  5. Click on 'Policy issues' in the infobox. This will lead you to the Policy issue page.
  6. Go back to the Policy issue component-form by clicking on the Edit-tab on the wiki-bar.
  7. Copy the Policy issue example from your chapter in the appropriate field.
  8. Perform the same editorial steps as stated above.
  9. Save the page
  10. Click on 'Data uncertainties and limitations' in the infobox. This will lead you to the Data, uncertainties and limitations component-form.

Data, uncertainties and limitations page

  1. Copy the description part of your chapter in the description-field.
  2. Perform the same editorial steps as stated above.
  3. Save the page

Component info-box

  1. Go to the Introduction-page. Go to the infobox-part of the introduction component-form. Check the relations in your chapter to the other parts of the framework. Include those relations in the corresponding fields (Projects/Applications, Models/Databases, Related IMAGE components).
    Each field has its own set of possible related items. Look at the overviews for the existing items, they are mentioned above the fields. Get the right item by using auto-completion. For new items see the related HowTo.
    The references-field and key-references have been filled in the previous steps.