Difference between revisions of "Manual:FAQ"
| Line 12: | Line 12: | ||
===What do we mean by "content"?=== | ===What do we mean by "content"?=== | ||
Content is the collection of text, tables, images, and videos that Contributors provide to create an article. | Content is the collection of text, tables, images, and videos that Contributors provide to create an article. | ||
| + | |||
| + | [[#top|Return to Top]] | ||
===What is an article?=== | ===What is an article?=== | ||
| − | An article is the presentation of content (text, tables, images, videos) on a page. | + | An article is the presentation of content (text, tables, images, videos) on a page. Each article is divided into sections. An article may only have one section |
| + | |||
| + | [[#top|Return to Top]] | ||
===What is a page=== | ===What is a page=== | ||
A page is essentially the location of the article on the wiki. It can be easily accessed with links from one page to another. The terms "page" and "article" could be used interchangeably as long as it is recognized that the article is the content and the page is the place where the content resides. | A page is essentially the location of the article on the wiki. It can be easily accessed with links from one page to another. The terms "page" and "article" could be used interchangeably as long as it is recognized that the article is the content and the page is the place where the content resides. | ||
| + | |||
| + | [[#top|Return to Top]] | ||
===What is a contributor?=== | ===What is a contributor?=== | ||
Remediapedia is initially being developed with select input from experts in their respective environmental restoration topic areas. Recognizing that these experts may collaborate with their peers and/or staffs to complete an article, the project will collectively recognize them as "contributors". Original authors of the content will be noted as the first contributor as is customary for science papers and reports. Since a wiki is organic on the web and not static as in a physical book, it is anticipated that facts and understandings will be updated as they are developed. Consequently, future contributors may be recognized leaders in a given environmental restoration topic that have not yet been included in the original work. | Remediapedia is initially being developed with select input from experts in their respective environmental restoration topic areas. Recognizing that these experts may collaborate with their peers and/or staffs to complete an article, the project will collectively recognize them as "contributors". Original authors of the content will be noted as the first contributor as is customary for science papers and reports. Since a wiki is organic on the web and not static as in a physical book, it is anticipated that facts and understandings will be updated as they are developed. Consequently, future contributors may be recognized leaders in a given environmental restoration topic that have not yet been included in the original work. | ||
| Line 21: | Line 27: | ||
Each contributor's name will be linked to a special contributor's profile page that provides the reader with a short bio, contact information and relevant links (e.g. a contributor's website). To that end, contributors are asked to provide their personal profile information at the time they submit articles using the format described in the Format Section of this FAQ. | Each contributor's name will be linked to a special contributor's profile page that provides the reader with a short bio, contact information and relevant links (e.g. a contributor's website). To that end, contributors are asked to provide their personal profile information at the time they submit articles using the format described in the Format Section of this FAQ. | ||
| + | [[#top|Return to Top]] | ||
===How should contributors submit their content?=== | ===How should contributors submit their content?=== | ||
For Remediapedia, the Environmental Restoration Wiki ( also called ERWiki), contributors may submit their text and tables to wiki staff in a standard MicroSoft Word format (.doc or .docx extension) and their images in high resolution .jpg or .png format. The contractors who are developing this wiki platform will convert the contributor's materials to wiki format using standard wiki markup code. Any contributor who is already familiar with wiki markup is free to format their article directly on the wiki. If a contributor has ever provided content on mainstream wikis such as Wikipedia, they will understand the level of understanding needed to accomplish this. Contributors are encouraged to write directly to the wiki if they are interested in / comfortable with the approach. | For Remediapedia, the Environmental Restoration Wiki ( also called ERWiki), contributors may submit their text and tables to wiki staff in a standard MicroSoft Word format (.doc or .docx extension) and their images in high resolution .jpg or .png format. The contractors who are developing this wiki platform will convert the contributor's materials to wiki format using standard wiki markup code. Any contributor who is already familiar with wiki markup is free to format their article directly on the wiki. If a contributor has ever provided content on mainstream wikis such as Wikipedia, they will understand the level of understanding needed to accomplish this. Contributors are encouraged to write directly to the wiki if they are interested in / comfortable with the approach. | ||
| + | |||
| + | [[#top|Return to Top]] | ||
===Who is the main target audience for this wiki?=== | ===Who is the main target audience for this wiki?=== | ||
The main target audience of the wiki is Department of Defense (DoD) Remedial Project Managers (RPMs) and regulators who actually manage and regulate environmental restoration (ER) projects. However, we also want the Wiki to be useful to a range of audiences including consultants, students and researchers. | The main target audience of the wiki is Department of Defense (DoD) Remedial Project Managers (RPMs) and regulators who actually manage and regulate environmental restoration (ER) projects. However, we also want the Wiki to be useful to a range of audiences including consultants, students and researchers. | ||
| + | |||
| + | [[#top|Return to Top]] | ||
===How long should a wiki article be?=== | ===How long should a wiki article be?=== | ||
Contributors should limit content to concise, easy to comprehend pages so that a reader only needs to scroll 2 or 3 screen lengths (assuming a standard 21" monitor) to read the full article. If your article needs to be much longer, consider dividing your topic into multiple pages so that appropriate sections can be "stand-alone" articles linked to each other. When an article needs to be longer to provide meaningful continuity of topic, exceptions are made, realizing that some topics will be complex and require development of concepts not easily condensed. | Contributors should limit content to concise, easy to comprehend pages so that a reader only needs to scroll 2 or 3 screen lengths (assuming a standard 21" monitor) to read the full article. If your article needs to be much longer, consider dividing your topic into multiple pages so that appropriate sections can be "stand-alone" articles linked to each other. When an article needs to be longer to provide meaningful continuity of topic, exceptions are made, realizing that some topics will be complex and require development of concepts not easily condensed. | ||
| + | |||
| + | [[#top|Return to Top]] | ||
==Format== | ==Format== | ||
=== What is the format for my article(s)?=== | === What is the format for my article(s)?=== | ||
| Line 32: | Line 45: | ||
*Tables: Tables are typically formatted within documents so that they will be extracted from text submittals. However, contributors may submit spreadsheets or presentation files (e.g. excel or powerpoint) and even images in the appropriate image format. | *Tables: Tables are typically formatted within documents so that they will be extracted from text submittals. However, contributors may submit spreadsheets or presentation files (e.g. excel or powerpoint) and even images in the appropriate image format. | ||
*Images: Appropriate image formats are .jpg and.png. High resolution images are preferred (300 ppi or greater). | *Images: Appropriate image formats are .jpg and.png. High resolution images are preferred (300 ppi or greater). | ||
| + | |||
| + | [[#top|Return to Top]] | ||
===What is the format for my Contributor Personal Profile?=== | ===What is the format for my Contributor Personal Profile?=== | ||
*Contributor's Name: [TITLE] [FIRST NAME] [LAST NAME] [CREDENTIALS] | *Contributor's Name: [TITLE] [FIRST NAME] [LAST NAME] [CREDENTIALS] | ||
*Contributor's Work/Contact information: [PLACE OF WORK] [EMAIL ADDRESS] [PHONE NUMBER] [WEBSITE] [SOCIAL MEDIA (e.g. Twitter, Facebook, LinkedIn, etc.)] | *Contributor's Work/Contact information: [PLACE OF WORK] [EMAIL ADDRESS] [PHONE NUMBER] [WEBSITE] [SOCIAL MEDIA (e.g. Twitter, Facebook, LinkedIn, etc.)] | ||
*Brief Bio: One hundred (100) words or less including education and professional credentials | *Brief Bio: One hundred (100) words or less including education and professional credentials | ||
| + | |||
| + | [[#top|Return to Top]] | ||
==References== | ==References== | ||
===How should I reference my article content?=== | ===How should I reference my article content?=== | ||
References are encouraged and add validity to content. Contributors should provide as much information as possible to allow readers to find the referenced materials themselves. Ideally all references will be more easily accessed by using standard DOI or ISBN numbers. When referencing SERDP/ESTCP articles, ??? | References are encouraged and add validity to content. Contributors should provide as much information as possible to allow readers to find the referenced materials themselves. Ideally all references will be more easily accessed by using standard DOI or ISBN numbers. When referencing SERDP/ESTCP articles, ??? | ||
| + | |||
| + | [[#top|Return to Top]] | ||
Revision as of 17:41, 2 November 2015
| Frequently asked questions (FAQ)
This space is provided to address questions about use of the wiki in general. Wiki contributors should check here first to help understand their role in developing content for the wiki. If you have a question not addressed here, CONTACT US and we will response soon. |
Contents
Content
What do we mean by "content"?
Content is the collection of text, tables, images, and videos that Contributors provide to create an article.
What is an article?
An article is the presentation of content (text, tables, images, videos) on a page. Each article is divided into sections. An article may only have one section
What is a page
A page is essentially the location of the article on the wiki. It can be easily accessed with links from one page to another. The terms "page" and "article" could be used interchangeably as long as it is recognized that the article is the content and the page is the place where the content resides.
What is a contributor?
Remediapedia is initially being developed with select input from experts in their respective environmental restoration topic areas. Recognizing that these experts may collaborate with their peers and/or staffs to complete an article, the project will collectively recognize them as "contributors". Original authors of the content will be noted as the first contributor as is customary for science papers and reports. Since a wiki is organic on the web and not static as in a physical book, it is anticipated that facts and understandings will be updated as they are developed. Consequently, future contributors may be recognized leaders in a given environmental restoration topic that have not yet been included in the original work.
Each contributor's name will be linked to a special contributor's profile page that provides the reader with a short bio, contact information and relevant links (e.g. a contributor's website). To that end, contributors are asked to provide their personal profile information at the time they submit articles using the format described in the Format Section of this FAQ.
How should contributors submit their content?
For Remediapedia, the Environmental Restoration Wiki ( also called ERWiki), contributors may submit their text and tables to wiki staff in a standard MicroSoft Word format (.doc or .docx extension) and their images in high resolution .jpg or .png format. The contractors who are developing this wiki platform will convert the contributor's materials to wiki format using standard wiki markup code. Any contributor who is already familiar with wiki markup is free to format their article directly on the wiki. If a contributor has ever provided content on mainstream wikis such as Wikipedia, they will understand the level of understanding needed to accomplish this. Contributors are encouraged to write directly to the wiki if they are interested in / comfortable with the approach.
Who is the main target audience for this wiki?
The main target audience of the wiki is Department of Defense (DoD) Remedial Project Managers (RPMs) and regulators who actually manage and regulate environmental restoration (ER) projects. However, we also want the Wiki to be useful to a range of audiences including consultants, students and researchers.
How long should a wiki article be?
Contributors should limit content to concise, easy to comprehend pages so that a reader only needs to scroll 2 or 3 screen lengths (assuming a standard 21" monitor) to read the full article. If your article needs to be much longer, consider dividing your topic into multiple pages so that appropriate sections can be "stand-alone" articles linked to each other. When an article needs to be longer to provide meaningful continuity of topic, exceptions are made, realizing that some topics will be complex and require development of concepts not easily condensed.
Format
What is the format for my article(s)?
- Text: Submit any document format that is easily accessible on the average computer. Most contributors will likely use Microsoft Word format (e.g. .DOC, .DOCX) or Word compatible document formats (e.g. .TXT, .RTF).
- Tables: Tables are typically formatted within documents so that they will be extracted from text submittals. However, contributors may submit spreadsheets or presentation files (e.g. excel or powerpoint) and even images in the appropriate image format.
- Images: Appropriate image formats are .jpg and.png. High resolution images are preferred (300 ppi or greater).
What is the format for my Contributor Personal Profile?
- Contributor's Name: [TITLE] [FIRST NAME] [LAST NAME] [CREDENTIALS]
- Contributor's Work/Contact information: [PLACE OF WORK] [EMAIL ADDRESS] [PHONE NUMBER] [WEBSITE] [SOCIAL MEDIA (e.g. Twitter, Facebook, LinkedIn, etc.)]
- Brief Bio: One hundred (100) words or less including education and professional credentials
References
How should I reference my article content?
References are encouraged and add validity to content. Contributors should provide as much information as possible to allow readers to find the referenced materials themselves. Ideally all references will be more easily accessed by using standard DOI or ISBN numbers. When referencing SERDP/ESTCP articles, ???
