Silver:Library Intro: Difference between revisions

From KBwiki
Jump to navigation Jump to search
No edit summary
 
(48 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Library Overview =
= Library Overview =
The Library area is that part of the Wiki where new submissions or modifications to existing Silver content
The Library area is where new submissions or modifications to existing Silver content
is done.  Access to this part of the Wiki is restricted to registered Wiki users within the Submitters group.
is implemented.  Access to this part of the Wiki is restricted to authorised registered Wiki users within the Submitters group.


This page provides information on how new content can be contributed.  It also contains links to the templates for editors to use for setting up new articles.
== Information for Contributors ==


== Contributing new content ==
The procedure for adding new content is as follows:
The procedure for adding new content is as follows:
* Email the ERCOFTAC Editorial Board with a request for new content or modification of existing content. This should contain:
** The name of the article
** The list of authors
** The AC or UFR type of the article
** Whether it is a new type of AC or UFR
** An abstract of the article
** The associated projects, eg, EU funded, nationally funded etc
** A brief description of why this would be useful to the ERCOFTAC community
* ERCOFTAC will reply with an email that either approves or declines the request.  If successful, the reply will contain:
** A link to the terms and conditions that authors must agree to when contributing new content.
* The authors must confirm their acceptance of the Terms and Conditions by email to the ERCOFTAC team.
* The ERCOFTAC team will then grant access to the pages.
** A link to the location in the Wiki where the new article is stored is provided in the email


== Information for Editors ==
Users will not be able to directly edit or change a Silver document, but they are highly encouraged to provide new content, either by suggesting modifications/extensions to existing content or indeed by adding new contributions. To do this the user must email the Knowledge Base Editorial Board with a request ([mailto:rodi@ifh.uni-karlsruhe.de Knowledge Base Editorial Board]). The email must set out:
A MediaWiki Template provides the means for standard ERCOFTAC Wiki pages to be correctly formatted. It enables the seperate sections to be defined for the authors to populate.


Templates can either be Transcluded or substituted.  The current version of these Templates requires them to be substituted.
* The title of the test case considered
* The list of authors
* Is the test case considered in the AC, UFR or DNS category?
* Is it a new AC, UFR or DNS or a modification of an existing one?
* Abstract describing briefly the contents of the new AC or UFR or which parts of an existing one are modified or extended


Here are the links to the various MediaWiki templates that can be used for setting up new articles. Each template has notes on how it should be used.
The Knowledge Base Editorial Board will respond with an email that either approves or declines the request. If successful, the response will give a username and password enabling access to the Library Area together with instructions on where to find the article template assigned to you. Enter the Library Area, access the article template and begin to make your contribution. When this is completed, inform the Knowledge Base Editorial Board by sending a short email giving your name and article or test case title. The editor will review the article and if and when it meets his requirements it will be lifted into the Silver Domain either as a new document or replacing an existing one.


=== Application Challenges Templates ===
* [[Template:ACHeader|Application Challenges List of page links]]
* [[Template:ACArticle|Application Challenges Abstract]]
* [[Template:ACDescription|Application Challenges Description]]
* [[Template:ACCFDSim|Application Challenges CFD Simulations]]
* [[Template:ACEval|Application Challenges Evaluations]]
* [[Template:ACQR|Application Challenges Quality Reviews]]
* [[Template:ACUFR|Application Challenges Page of links to UFRS]]


=== Underlying Flow Regime Templates ===
'''Please use the [[Article_Templates|Article Templates]] and [[Referencing_Guide|Referencing Guide]] located in the Library Folder as an aid for submitting new or modifying existing content. For further assistance when making your contribution please access the User Guide: [[How_to_access_content#|How to Navigate around the Knowledge Base]] and [[How_to_contribute#|How to contribute material]]. Here you will also find additional information for [[Writing_Latex_Equations#|writing LaTeX equations]]. Alternatively you can search through our [[FAQ_L#|FAQ]].
* [[Template:UFR|UFR Template for Links]]
 
 
'''Please note all submissions have to be in Mediawiki Text format. If you wish to submit a word document you will have to convert your word document first, by using a HTML converter, into the desired MediaWiki Text. Once this has been achieved a simple copy and paste is all that is required. For further information on HTML converters and MediaWiki Text please see our [[FAQ_L#|FAQ]] and [[How_to_contribute#General_Advice#|How to contribute material]] section of the userguide.
 
 
 
'''For all other enquiries and or advice please feel free to [[Contactus-url#|contact us]] where we will be more than happy to help.
 
== Information for Reviewers ==
* The reviewer must complete and submit the template document in PDF format to the ERCOFTAC Editorial team

Latest revision as of 13:27, 23 September 2020

Library Overview

The Library area is where new submissions or modifications to existing Silver content is implemented. Access to this part of the Wiki is restricted to authorised registered Wiki users within the Submitters group.

Information for Contributors

The procedure for adding new content is as follows:

Users will not be able to directly edit or change a Silver document, but they are highly encouraged to provide new content, either by suggesting modifications/extensions to existing content or indeed by adding new contributions. To do this the user must email the Knowledge Base Editorial Board with a request (Knowledge Base Editorial Board). The email must set out:

  • The title of the test case considered
  • The list of authors
  • Is the test case considered in the AC, UFR or DNS category?
  • Is it a new AC, UFR or DNS or a modification of an existing one?
  • Abstract describing briefly the contents of the new AC or UFR or which parts of an existing one are modified or extended

The Knowledge Base Editorial Board will respond with an email that either approves or declines the request. If successful, the response will give a username and password enabling access to the Library Area together with instructions on where to find the article template assigned to you. Enter the Library Area, access the article template and begin to make your contribution. When this is completed, inform the Knowledge Base Editorial Board by sending a short email giving your name and article or test case title. The editor will review the article and if and when it meets his requirements it will be lifted into the Silver Domain either as a new document or replacing an existing one.


Please use the Article Templates and Referencing Guide located in the Library Folder as an aid for submitting new or modifying existing content. For further assistance when making your contribution please access the User Guide: How to Navigate around the Knowledge Base and How to contribute material. Here you will also find additional information for writing LaTeX equations. Alternatively you can search through our FAQ.


Please note all submissions have to be in Mediawiki Text format. If you wish to submit a word document you will have to convert your word document first, by using a HTML converter, into the desired MediaWiki Text. Once this has been achieved a simple copy and paste is all that is required. For further information on HTML converters and MediaWiki Text please see our FAQ and How to contribute material section of the userguide.


For all other enquiries and or advice please feel free to contact us where we will be more than happy to help.

Information for Reviewers

  • The reviewer must complete and submit the template document in PDF format to the ERCOFTAC Editorial team