Difference between revisions of "Help:Basic setup, rules and guidelines"
From Coastal Wiki
(→Excellent article) |
Dronkers J (talk | contribs) |
||
| (28 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Read this article carefully, before you start to edit or write an article. This article explains the rules of the Coastal Wiki, how to write an article and what an excellent article looks like. For more information on editing an article, see [[how to edit an article]]. | + | Read this article carefully, before you start to edit or write an article. This article explains the rules of the Coastal Wiki, how to write an article and what an excellent article looks like. For more information on editing an article, see [[help:how to edit an article]]. |
==Basic setup== | ==Basic setup== | ||
| − | === | + | ===Creating an account=== |
| − | + | Your account is linked with your personal record in the [http://www.coastalwiki.org/imis/imis.php?module=person Coastal Wiki Contact Database]. To find your name in the contact database enter your name under 'IMIS name'. To request an account, please contact info@coastalwiki.org. | |
===Write a new article=== | ===Write a new article=== | ||
| − | First, check | + | Anonymous contributions to the Coastal Wiki are precluded. Authors, co-authors and editors of articles are explicitly acknowledged. Your contribution will be reviewed by an editorial board member who is expert in your field. Please make sure that your contribution is adequately linked to existing articles on similar or related topics. First, have a search around you topic of interest to check that your proposed article is not duplicating the information contained within an existing article. If this is the case, instead of adding your article, please complement or revise the existing article (see the subsection "Edit other articles" below). You may also use the Discussion page. To create a new article, enter the title in the '''search window''' and click on '''Go'''. If an article with this title does not yet exist you may create the article by clicking on '''create this page'''. It is also possible to create a new article by typing the article name between brackets in an existing article: <nowiki>[[Name of new article]]</nowiki>. Click the '''Save page''' button and follow the link which appears in red. If you need to change your title do it before editing; otherwise use '''Move Page''' function in the '''Edit''' box. This creates a new article, to which users are redirected. Always check "what links here" (in the toolbox at the left-hand) before moving a page. Eventually, adjust internal links to the new title. |
| + | |||
| + | Make sure that your article fits the fabric of articles dealing with related topics, especially articles with a more general scope. Refer to these articles by introducing links; you should also consider re-editing related articles to introduce appropriate links to your article (but not more often than strictly necessary). Submit your article for peer review to expert colleagues before entering it in the Coastal Wiki. See also the rules and guidelines below. | ||
===Edit other articles=== | ===Edit other articles=== | ||
| − | To start editing this or any other page either click the edit link at the top of the page or use the edit button at the beginning of each section. This takes you to the edit page: a page with a text box containing the wikitext | + | To start editing this or any other page either click the edit link at the top of the page or use the '''edit''' button at the beginning of each section. This takes you to the edit page: a page with a text box containing the wikitext, i.e. the editable source code from which the server produces the webpage. We recommend to contact the author; you will find contact details by clicking on history. In the case of conflicting evidence use the discussion page. |
===Editing and saving=== | ===Editing and saving=== | ||
| − | Have an article prepared in a word document or work as you go. See the [[#Rules]] and [[#Guidelines]] how a Wiki-article should look like. Make use of [[How to edit an article#Basic Wiki- | + | Have an article prepared in a word document or work as you go. See the [[Basic setup, rules and guidelines#Coastal Wiki rules|Rules]] and [[Basic setup, rules and guidelines#Guidelines|Guidelines]] how a Wiki-article should look like. Make use of [[Help:How to edit an article#Basic Wiki-formatting|basic Wiki-formatting]] to make links and do simple formatting. You can preview your work as you go, click '''Show preview''' to see how your changes will look before you make them permanent. Repeat the edit/preview process until you are satisfied, then click '''Save page''' and your changes will be immediately applied to the article. It is also important to '''Save page''' often while you are working. The buttons '''Show preview''' and '''Save page''' are found at the bottom of the edit page. |
| − | ==Coastal Wiki | + | ==Coastal Wiki rules== |
Check this rules first, before starting editing and writing! | Check this rules first, before starting editing and writing! | ||
# Check if an article on the same of a very similar topic exists already (by using the search function). In that case, instead of adding your article, it might be better to complement or revise this existing article. We recommend to contact the author; you will find contact details by clicking on history. In the case of conflicting evidence use the discussion page. | # Check if an article on the same of a very similar topic exists already (by using the search function). In that case, instead of adding your article, it might be better to complement or revise this existing article. We recommend to contact the author; you will find contact details by clicking on history. In the case of conflicting evidence use the discussion page. | ||
# Make sure that your article fits the fabric of articles dealing with related topics, especially articles with a more general scope. Refer to these articles by introducing links; you should also consider re-editing related articles to introduce appropriate links to your article (but not more often than strictly necessary). | # Make sure that your article fits the fabric of articles dealing with related topics, especially articles with a more general scope. Refer to these articles by introducing links; you should also consider re-editing related articles to introduce appropriate links to your article (but not more often than strictly necessary). | ||
# Important claims or statements need to be substantiated; adding an authoritative reference (or a link to authoritative Internet source) is often better than providing proof in the paper. | # Important claims or statements need to be substantiated; adding an authoritative reference (or a link to authoritative Internet source) is often better than providing proof in the paper. | ||
| − | |||
# Submit your article for peer review to expert colleagues before entering it in the Coastal Wiki; we encourage Coastal Wiki authors to work in teams and to review each other’s contributions. | # Submit your article for peer review to expert colleagues before entering it in the Coastal Wiki; we encourage Coastal Wiki authors to work in teams and to review each other’s contributions. | ||
# Do not copy-and-paste any material that is subject to copyright. | # Do not copy-and-paste any material that is subject to copyright. | ||
| − | # Coastal Wiki are well-focused | + | # Coastal Wiki are well-focused; structure your article according to the instructions given in the Guidelines. |
==Guidelines== | ==Guidelines== | ||
| − | # '''Title''': The title should be as short as possible. Note: If you need to change your title do it before editing; otherwise use Move Page function in the Edit box. This creates a new article, to which users are redirected. | + | # '''Title''': The title should be sufficiently specific but also as short as possible. Good titles are easily found by users through an Internet search engine (Google, or else). Note: If you need to change your title do it before editing; otherwise use '''Move Page''' function in the '''Edit''' box. This creates a new article, to which users are redirected. Always check "what links here" (in the toolbox at the left-hand) before moving a page. Eventually, adjust internal links to the new title. |
# '''Lead''': An article should start with a concise lead that summarizes the entire topic and prepares the reader for the higher level of detail in the subsequent sections. The lead section should appear before the table of contents, without a heading. So, do not type ‘introduction’ as a heading – just write the introductory paragraph at the start of article. You may include an introduction as well, but this has a different purpose than the summary. | # '''Lead''': An article should start with a concise lead that summarizes the entire topic and prepares the reader for the higher level of detail in the subsequent sections. The lead section should appear before the table of contents, without a heading. So, do not type ‘introduction’ as a heading – just write the introductory paragraph at the start of article. You may include an introduction as well, but this has a different purpose than the summary. | ||
# '''Structure of main text''': an article preferably starts with an introduction, which provides a relevant context (policy, practice, science). Consider also important interactions with other components of the coastal system. After the main text enter a section “See also” with “Internal links”, “External links” and “Further reading”. Close the article with a list with cited references, credit the author and add categories to the article. | # '''Structure of main text''': an article preferably starts with an introduction, which provides a relevant context (policy, practice, science). Consider also important interactions with other components of the coastal system. After the main text enter a section “See also” with “Internal links”, “External links” and “Further reading”. Close the article with a list with cited references, credit the author and add categories to the article. | ||
| − | # '''Content of an article''': An article should contain illustrations, boxes and tables, if they are appropriate to the subject, with succinct captions and acceptable copyright status. It | + | # '''Content of an article''': An article should contain illustrations, boxes and tables, if they are appropriate to the subject, with succinct captions and acceptable copyright status. It stays focused on the main topic without going into unnecessary detail. Appropriate links are created with related articles for information on broader context or on specific details. Don’t enter into details if good references and links to detailed information are available. General tips: |
## Separate major sections of article with section headlines and use a hierarchical heading structure | ## Separate major sections of article with section headlines and use a hierarchical heading structure | ||
## Use wiki markup, see also format | ## Use wiki markup, see also format | ||
| − | ## Define terms, in a separate, individual definition page, see [[ | + | ## Define terms, in a separate, individual definition page, see [[glossary]] |
## Add relevant images or graphics, tables with explanatory captions. Preferably an article contains 1 image for every 500 words. | ## Add relevant images or graphics, tables with explanatory captions. Preferably an article contains 1 image for every 500 words. | ||
| − | ## Use analogies and comparisons to illustrate | + | ## Use analogies and comparisons to illustrate |
==Excellent article== | ==Excellent article== | ||
| Line 44: | Line 45: | ||
==See also== | ==See also== | ||
| − | See also the page [[Coastal Wiki:Why, What and for Whom]] for more information about the background and audience of the Coastal Wiki. | + | See also the page [[Coastal Wiki:Why, What and for Whom?]] for more information about the background and audience of the Coastal Wiki. |
| − | See [[How to edit an article]] for more information on the editing of an article. | + | See [[help:How to edit an article]] for more information on the editing of an article. |
| + | [[Category:Help]] | ||
Latest revision as of 21:47, 7 December 2018
Read this article carefully, before you start to edit or write an article. This article explains the rules of the Coastal Wiki, how to write an article and what an excellent article looks like. For more information on editing an article, see help:how to edit an article.
Contents
Basic setup
Creating an account
Your account is linked with your personal record in the Coastal Wiki Contact Database. To find your name in the contact database enter your name under 'IMIS name'. To request an account, please contact info@coastalwiki.org.
Write a new article
Anonymous contributions to the Coastal Wiki are precluded. Authors, co-authors and editors of articles are explicitly acknowledged. Your contribution will be reviewed by an editorial board member who is expert in your field. Please make sure that your contribution is adequately linked to existing articles on similar or related topics. First, have a search around you topic of interest to check that your proposed article is not duplicating the information contained within an existing article. If this is the case, instead of adding your article, please complement or revise the existing article (see the subsection "Edit other articles" below). You may also use the Discussion page. To create a new article, enter the title in the search window and click on Go. If an article with this title does not yet exist you may create the article by clicking on create this page. It is also possible to create a new article by typing the article name between brackets in an existing article: [[Name of new article]]. Click the Save page button and follow the link which appears in red. If you need to change your title do it before editing; otherwise use Move Page function in the Edit box. This creates a new article, to which users are redirected. Always check "what links here" (in the toolbox at the left-hand) before moving a page. Eventually, adjust internal links to the new title.
Make sure that your article fits the fabric of articles dealing with related topics, especially articles with a more general scope. Refer to these articles by introducing links; you should also consider re-editing related articles to introduce appropriate links to your article (but not more often than strictly necessary). Submit your article for peer review to expert colleagues before entering it in the Coastal Wiki. See also the rules and guidelines below.
Edit other articles
To start editing this or any other page either click the edit link at the top of the page or use the edit button at the beginning of each section. This takes you to the edit page: a page with a text box containing the wikitext, i.e. the editable source code from which the server produces the webpage. We recommend to contact the author; you will find contact details by clicking on history. In the case of conflicting evidence use the discussion page.
Editing and saving
Have an article prepared in a word document or work as you go. See the Rules and Guidelines how a Wiki-article should look like. Make use of basic Wiki-formatting to make links and do simple formatting. You can preview your work as you go, click Show preview to see how your changes will look before you make them permanent. Repeat the edit/preview process until you are satisfied, then click Save page and your changes will be immediately applied to the article. It is also important to Save page often while you are working. The buttons Show preview and Save page are found at the bottom of the edit page.
Coastal Wiki rules
Check this rules first, before starting editing and writing!
- Check if an article on the same of a very similar topic exists already (by using the search function). In that case, instead of adding your article, it might be better to complement or revise this existing article. We recommend to contact the author; you will find contact details by clicking on history. In the case of conflicting evidence use the discussion page.
- Make sure that your article fits the fabric of articles dealing with related topics, especially articles with a more general scope. Refer to these articles by introducing links; you should also consider re-editing related articles to introduce appropriate links to your article (but not more often than strictly necessary).
- Important claims or statements need to be substantiated; adding an authoritative reference (or a link to authoritative Internet source) is often better than providing proof in the paper.
- Submit your article for peer review to expert colleagues before entering it in the Coastal Wiki; we encourage Coastal Wiki authors to work in teams and to review each other’s contributions.
- Do not copy-and-paste any material that is subject to copyright.
- Coastal Wiki are well-focused; structure your article according to the instructions given in the Guidelines.
Guidelines
- Title: The title should be sufficiently specific but also as short as possible. Good titles are easily found by users through an Internet search engine (Google, or else). Note: If you need to change your title do it before editing; otherwise use Move Page function in the Edit box. This creates a new article, to which users are redirected. Always check "what links here" (in the toolbox at the left-hand) before moving a page. Eventually, adjust internal links to the new title.
- Lead: An article should start with a concise lead that summarizes the entire topic and prepares the reader for the higher level of detail in the subsequent sections. The lead section should appear before the table of contents, without a heading. So, do not type ‘introduction’ as a heading – just write the introductory paragraph at the start of article. You may include an introduction as well, but this has a different purpose than the summary.
- Structure of main text: an article preferably starts with an introduction, which provides a relevant context (policy, practice, science). Consider also important interactions with other components of the coastal system. After the main text enter a section “See also” with “Internal links”, “External links” and “Further reading”. Close the article with a list with cited references, credit the author and add categories to the article.
- Content of an article: An article should contain illustrations, boxes and tables, if they are appropriate to the subject, with succinct captions and acceptable copyright status. It stays focused on the main topic without going into unnecessary detail. Appropriate links are created with related articles for information on broader context or on specific details. Don’t enter into details if good references and links to detailed information are available. General tips:
- Separate major sections of article with section headlines and use a hierarchical heading structure
- Use wiki markup, see also format
- Define terms, in a separate, individual definition page, see glossary
- Add relevant images or graphics, tables with explanatory captions. Preferably an article contains 1 image for every 500 words.
- Use analogies and comparisons to illustrate
Excellent article
An excellent Coastal Wiki article is well written, comprehensive, factually accurate, neutral and stable.
- Well written means that the prose is compelling, understandable for non-experts, avoids unnecessary technical terms and unexplained abbreviations.
- Comprehensive means that the article provides relevant context and relationships.
- Factually accurate means that claims are verifiable against reliable sources and accurately present the related body of published knowledge. Claims are supported with specific evidence and external citations; this involves the provision of a "References" section in which sources are set out and, where appropriate, complemented by online citations. See also the Coastal Wiki Rules.
- Neutral means that the article presents views fairly and without bias; however, articles need not give minority views equal coverage.
- Stable means that the article is not the subject of ongoing edit wars and that its content does not change significantly from day to day.
See also
See also the page Coastal Wiki:Why, What and for Whom? for more information about the background and audience of the Coastal Wiki.
See help:How to edit an article for more information on the editing of an article.
