m |
PKalinosky (talk | contribs) m (→Categories) |
||
(37 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | This page provides some basic guidance for working in the wiki. It will be updated periodically. | |
+ | |||
+ | ==Why do you want to work in the Manual wiki?== | ||
+ | The Minnesota Stormwater Manual is a powerful online tool for disseminating information to stakeholders. Stakeholders include permittees, technical people, managers, educators, the general public, and more. | ||
+ | |||
+ | There are many reasons why you may want to work in the manual. Examples include the following. | ||
+ | *Delivering guidance to a specific or general audience | ||
+ | *Education and training for professionals, including Powerpoints, videos, fact sheets, and so on. | ||
+ | *Delivering or making tools accessible, such as models and spreadsheets | ||
+ | *Providing links to other resources and websites | ||
+ | *Providing resources such as images and photos, event notices, funding information, etc. | ||
+ | *Providing forms such as inspection sheets, and maintenance sheets | ||
− | + | Staff within a specific program are encouraged to work in the wiki and bring their programmatic expertise and interests into the manual. | |
+ | |||
+ | ==A few ground rules and responsibility== | ||
+ | Before you have wiki rights, you should understand the following. | ||
+ | *You are responsible for material you place on a page. The wiki records every edit made, including the date, time, and author. Misuse of the wiki will result in a loss of access rights. | ||
+ | *You must adhere to specific style guidelines, as specified on this page | ||
+ | *It is not necessary to check with the wiki coordinator for minor edits. The following should be cleared with the coordinator. | ||
+ | **Creation of a new page | ||
+ | **Significant changes to an existing page | ||
+ | **Ideas for new materials, concepts, topic areas, etc. | ||
+ | |||
+ | It is important that the coordinator is familiar with the contents of the wiki. | ||
− | == | + | ==Getting started - getting rights and initial orientation== |
− | *Discuss with your supervisor and have them send | + | *Discuss with your supervisor your desire to work in the wiki and have them send the wiki coordinator an email approving this. |
*You will be sent a username and password to access the wiki. When you get this, log in and then change your password. | *You will be sent a username and password to access the wiki. When you get this, log in and then change your password. | ||
− | *Set up a ½ hour session with | + | *Set up a ½ hour session with the coordinator to go through the basics |
==Help== | ==Help== | ||
*Become familiar with the [https://stormwater.pca.state.mn.us/index.php?title=Help:Contents Help] available in the wiki. It is not necessary to know specifics, but it is useful to have a general understanding of what help is available. On the left toolbar in the wiki, click on Help and review the contents. Note there is a [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style] which we largely adhere to since the Manual wiki uses [https://www.mediawiki.org/wiki/MediaWiki Mediawiki] as its platform, which is the same platform used by Wikipedia. | *Become familiar with the [https://stormwater.pca.state.mn.us/index.php?title=Help:Contents Help] available in the wiki. It is not necessary to know specifics, but it is useful to have a general understanding of what help is available. On the left toolbar in the wiki, click on Help and review the contents. Note there is a [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style] which we largely adhere to since the Manual wiki uses [https://www.mediawiki.org/wiki/MediaWiki Mediawiki] as its platform, which is the same platform used by Wikipedia. | ||
− | *Writing in the wiki utilizes a mix of [https://en.wikipedia.org/wiki/Help:Wikitext wiki] and [https://en.wikipedia.org/wiki/HTML | + | *Writing in the wiki utilizes a mix of [https://en.wikipedia.org/wiki/Help:Wikitext wiki] and [https://en.wikipedia.org/wiki/HTML HTML] coding. If you encounter an issue that is not discussed in the help section described above, a solution can generally be found on the internet. For example, if you wanted to use red font and cannot find help in the Manual wiki, do a Google search on red font HTML or red font wiki. |
*Ask someone familiar with coding in the wiki. It is possible that the issue you are trying to resolve has been encountered by others. | *Ask someone familiar with coding in the wiki. It is possible that the issue you are trying to resolve has been encountered by others. | ||
Line 18: | Line 40: | ||
{{alert|This page is an edit and testing page use by the wiki authors. It is not a content page for the Manual. Information on this page may not be accurate and should not be used as guidance in managing stormwater.|alert-danger}} | {{alert|This page is an edit and testing page use by the wiki authors. It is not a content page for the Manual. Information on this page may not be accurate and should not be used as guidance in managing stormwater.|alert-danger}} | ||
Go into edit mode and copy the coding for this alert onto your test page(s) | Go into edit mode and copy the coding for this alert onto your test page(s) | ||
− | *To create a test page, | + | *To create a test page, go to an existing test page and enter the code needed to create your page. The code is double brackets ([[), Name of the page, and close brackets. This creates a link shown in red text (see next bullet). Click on the link to go to your new test page. |
*Note that a newly created page does not actually exist until you go to that page, edit it, and save your edit(s). If you see a link to a page and the link is in red font, that is a page that has not yet been saved in the wiki. Blue font indicates a page that has been created. | *Note that a newly created page does not actually exist until you go to that page, edit it, and save your edit(s). If you see a link to a page and the link is in red font, that is a page that has not yet been saved in the wiki. Blue font indicates a page that has been created. | ||
− | == | + | ==HTML codes== |
− | Many commands in | + | Many commands in HTML utilize the following code <>. The command is then closed by </>. Examples include the following. |
− | *font size (e.g. between the less than and greater than signs, type | + | *font size (e.g. between the less than and greater than signs, type "font size=5" for 5 point font. Once done, close with the following between the two signs: "/font size") |
+ | **so, typing <nowiki><font size=5> test test test </font size></nowiki> would output <font size=5> test test test </font size> | ||
*span - this command activates many other potential commands, typically related to styling, with the span command. [https://www.codecademy.com/forum_questions/502ad0ea558dfe0002026d69 Link here for more information] | *span - this command activates many other potential commands, typically related to styling, with the span command. [https://www.codecademy.com/forum_questions/502ad0ea558dfe0002026d69 Link here for more information] | ||
*p - starts or ends a paragraph | *p - starts or ends a paragraph | ||
− | You can easily find information on different | + | You can easily find information on different HTML commands on the internet ([http://www.transaction.net/web/tutor/cmdtable.html], [http://www.simplehtmlguide.com/cheatsheet.php], [https://www.math.uh.edu/~torok/math_6298/html/commands.html], [https://www.educba.com/html-commands/]). |
==Page headers and subheaders (sections on a page)== | ==Page headers and subheaders (sections on a page)== | ||
− | *Before the first header on a page, most pages should have a brief introduction explaining what is on the page and if appropriate introducing the topic. | + | *Before the first header on a page, most pages should have a brief introduction explaining what is on the page and if appropriate, introducing the topic. |
*Main headings are ==Header==, and subheadings get an additional = sign. For example, if the topic is soil and a subtopic is soil infiltration, you would use the following coding: ==Soil==, followed by some introductory text, and then the subfolder ===Soil infiltration===, followed by the text for that section | *Main headings are ==Header==, and subheadings get an additional = sign. For example, if the topic is soil and a subtopic is soil infiltration, you would use the following coding: ==Soil==, followed by some introductory text, and then the subfolder ===Soil infiltration===, followed by the text for that section | ||
*Each header and subheader should have some text below it, even if is just introductory, as shown above. | *Each header and subheader should have some text below it, even if is just introductory, as shown above. | ||
Line 42: | Line 65: | ||
==Images== | ==Images== | ||
− | * | + | *Coding is as follows: Double brackets ([[), File:file name|thumb|300|alt=text for screen reader|Text you want on the website, then close double brackets (]]). The text should be in 3 point font. Font size is [https://stormwater.pca.state.mn.us/index.php?title=Guidance_for_wiki_editors#Html_codes set with HTML code]. |
*Must have the alt for ADA compliance | *Must have the alt for ADA compliance | ||
*Can deviate from 300 px if warranted. If an image is small, add the text “Click on image to enlarge” | *Can deviate from 300 px if warranted. If an image is small, add the text “Click on image to enlarge” | ||
− | *Include “left” if image is to be placed on left side of page. | + | *Include “left” if image is to be placed on left side of page. Thumb automatically places the image on the right unless left is specified. |
*You can create a gallery when multiple images should go together. An example is shown below. To see the coding for this, make sure you are logged in and click edit for this section. | *You can create a gallery when multiple images should go together. An example is shown below. To see the coding for this, make sure you are logged in and click edit for this section. | ||
<gallery caption="MIDS Calculator screen shots for inputs for bioretention without an underdrain (bioinfiltration). Click on an image for enlarged view." widths="140px"> | <gallery caption="MIDS Calculator screen shots for inputs for bioretention without an underdrain (bioinfiltration). Click on an image for enlarged view." widths="140px"> | ||
Line 54: | Line 77: | ||
</gallery> | </gallery> | ||
*Provide credit(s) for the image in the caption when necessary. For example, “Image courtesy of Capital Region Watershed District”. | *Provide credit(s) for the image in the caption when necessary. For example, “Image courtesy of Capital Region Watershed District”. | ||
− | + | *We have the ability to create gif images. For an example, [https://stormwater.pca.state.mn.us/index.php?title=File:Infiltration_bmps.gif link here]. | |
− | *We have the ability to create gif images. For an example, [https://stormwater.pca.state.mn.us/index.php?title=File:Infiltration_bmps.gif link here] | + | *We can create links within images. For an example, [https://stormwater.pca.state.mn.us/index.php?title=10_Steps_to_Stormwater_Pollution_Prevention_on_Small_Residential_Construction_Sites link here]. |
− | *We can create links within images. For an example, [https://stormwater.pca.state.mn.us/index.php?title=10_Steps_to_Stormwater_Pollution_Prevention_on_Small_Residential_Construction_Sites link here] | ||
*Note that images are actually on separate pages. Click on one in the wiki to see. The page housing the image can be edited. So if you have a lot of text you would like to explain an image, type in the caption “For more discussion, click on image”, and then add the extra text on the page that houses the image. | *Note that images are actually on separate pages. Click on one in the wiki to see. The page housing the image can be edited. So if you have a lot of text you would like to explain an image, type in the caption “For more discussion, click on image”, and then add the extra text on the page that houses the image. | ||
*The primary purpose of an image is to provide information or explain a concept presented in the text. However, keep visual attractiveness in mind when using images on a page. Place images as necessary to avoid problems such as excess white space, inappropriate text wrapping, interference with alerts and bullets, etc. Group images into a gallery or use .gif images if images can be grouped. | *The primary purpose of an image is to provide information or explain a concept presented in the text. However, keep visual attractiveness in mind when using images on a page. Place images as necessary to avoid problems such as excess white space, inappropriate text wrapping, interference with alerts and bullets, etc. Group images into a gallery or use .gif images if images can be grouped. | ||
==Tables== | ==Tables== | ||
− | *Tables can be done in two formats – | + | *Tables can be done in two formats – HTML and wiki |
− | * | + | *HTML tables are preferred because they are composed on separate pages. The information in the table is embedded on other pages with specific coding (see [https://stormwater.pca.state.mn.us/index.php?title=Guidance_for_wiki_editors#Transclusions Transclusions] below). Unfortunately, HTML tables are time consuming and can be challenging. Certain components of an HTML table are required. For an example of an HTML table, [https://stormwater.pca.state.mn.us/index.php?title=Event_mean_concentrations_for_total_phosphorus go to this link]. To see the coding, make sure you are logged in and click on edit. |
− | **The table caption must have 3 point font for text. | + | **The table caption must have 3 point font for text. |
− | **All | + | **All table captions must create a link to the table. |
− | **All tables must be sortable. | + | **All tables must be sortable. |
+ | **To see an example or see specific coding needed, [https://stormwater.pca.state.mn.us/index.php?title=Summary_of_horizontal_and_vertical_setback_distances here is an example]. After linking to this page, click on edit to observe the coding. | ||
*Wiki tables are created on the page where they will be housed and cannot be linked to other pages (cannot be transcluded; see below). They should therefore be created only when the information in the table is unique to the page on which the table is created. Wiki tables are easy to build using the toolbar in the edit mode within the wiki. If you go to [https://stormwater.pca.state.mn.us/index.php?title=Event_mean_concentrations_of_total_and_dissolved_phosphorus_in_stormwater_runoff this link], the summary table at the top of the page is an example of a wiki table. | *Wiki tables are created on the page where they will be housed and cannot be linked to other pages (cannot be transcluded; see below). They should therefore be created only when the information in the table is unique to the page on which the table is created. Wiki tables are easy to build using the toolbar in the edit mode within the wiki. If you go to [https://stormwater.pca.state.mn.us/index.php?title=Event_mean_concentrations_of_total_and_dissolved_phosphorus_in_stormwater_runoff this link], the summary table at the top of the page is an example of a wiki table. | ||
*Tables can include images. If you include an image, ensure it is sized properly. | *Tables can include images. If you include an image, ensure it is sized properly. | ||
==Transclusions== | ==Transclusions== | ||
− | *A transclusion is the inclusion of material from another page | + | *A transclusion is the inclusion of material from another page onto the page you are editing. That is, the transclusion command tells the wiki to go grab information from another page and insert it on the page being edited. |
− | *The coding for a transclusion is | + | *The coding for a transclusion is curly brackets, colon, the page name, close curly brackets. In this case, the information on page name is placed on the page you are editing. See the coding [https://stormwater.pca.state.mn.us/index.php?title=Design_criteria_for_bioretention#Underdrains here] for an example. |
*Transclusions are very useful for material that is used in multiple places in the wiki. For example, the table Design infiltration rates appears on 13 different pages in the wiki. The actual table [https://stormwater.pca.state.mn.us/index.php?title=Design_infiltration_rates exists on just one page]. Whenever we edit the information in this table, the table automatically updates at the 13 locations where it is transcluded. | *Transclusions are very useful for material that is used in multiple places in the wiki. For example, the table Design infiltration rates appears on 13 different pages in the wiki. The actual table [https://stormwater.pca.state.mn.us/index.php?title=Design_infiltration_rates exists on just one page]. Whenever we edit the information in this table, the table automatically updates at the 13 locations where it is transcluded. | ||
*There may be material on a page that you do not want to be transcluded to another page. On the page to be transcluded, use <noinclude>text</noinclude> for text you do not want transcluded. | *There may be material on a page that you do not want to be transcluded to another page. On the page to be transcluded, use <noinclude>text</noinclude> for text you do not want transcluded. | ||
Line 77: | Line 100: | ||
==Links== | ==Links== | ||
*Link to other websites liberally, including reports/articles if they are available on the web. | *Link to other websites liberally, including reports/articles if they are available on the web. | ||
− | *Do not link to vendor sites unless justifiable. For example, when discussing structural soils for tree trenches, it is necessary to mention specific vendors. In this case, try to be inclusive and link to multiple vendors if appropriate. Place an alert (see below) at the top of the page that states: Reference to any specific commercial product, process, or service by trade name, trademark, service mark, manufacturer, or otherwise does not constitute or imply endorsement, recommendation, or favoring by the Minnesota Pollution Control Agency. | + | *Do not link to vendor sites unless justifiable. For example, when discussing structural soils for tree trenches, it is necessary to mention specific vendors. In this case, try to be inclusive and link to multiple vendors if appropriate. Place an alert (see below) at the top of the page that states: '''''Reference to any specific commercial product, process, or service by trade name, trademark, service mark, manufacturer, or otherwise does not constitute or imply endorsement, recommendation, or favoring by the Minnesota Pollution Control Agency.''''' |
*Links can be internal (to another location in the wiki) or external (to a location outside the wiki). | *Links can be internal (to another location in the wiki) or external (to a location outside the wiki). | ||
*For external links the coding is [url text you want the reader to see]. Note the space between the url and the text you want the reader to see. In the following example, the link is to a Mediawiki site and the user sees the word Mediawiki highlighted in blue, indicating a link: [https://www.mediawiki.org/wiki/MediaWiki Mediawiki]. | *For external links the coding is [url text you want the reader to see]. Note the space between the url and the text you want the reader to see. In the following example, the link is to a Mediawiki site and the user sees the word Mediawiki highlighted in blue, indicating a link: [https://www.mediawiki.org/wiki/MediaWiki Mediawiki]. | ||
Line 84: | Line 107: | ||
==[https://stormwater.pca.state.mn.us/index.php?title=Bioretention_combined#Terminology Alert boxes]== | ==[https://stormwater.pca.state.mn.us/index.php?title=Bioretention_combined#Terminology Alert boxes]== | ||
− | * | + | *Use alert boxes to grab the readers attention for a specific item, such as a permit requirement, a recommendation, or an interesting piece of information. |
− | *Danger for permit requirements; warning for recommendations, important items, etc., info for information items; success for green infrastructure; under-review; under-construction | + | *[https://stormwater.pca.state.mn.us/index.php?title=Help:Formatting#Alert_Messages See this link] |
+ | *There are six types of alert boxes: Danger for permit requirements; warning for recommendations, important items, etc., info for information items; success for green infrastructure; under-review; under-construction | ||
==File uploads== | ==File uploads== | ||
Line 93: | Line 117: | ||
==Inserting a document on a page== | ==Inserting a document on a page== | ||
− | *The coding for inserting a document (e.g. .docx, .pdf, .xlsx, .pptx) is [[file:filename | + | *The coding for inserting a document (e.g. .docx, .pdf, .xlsx, .pptx) is double brackets ([[), file:filename, the text you want the outside reader to see, and close double brackets (]]). |
==Hover boxes== | ==Hover boxes== | ||
Line 110: | Line 134: | ||
*Information boxes are actually wiki tables placed at specific locations on a page and intended to get the readers attention. The most useful application of these is as an overview or brief summary for a page that has a lot of content. This allows the reader to get the important points and not have to go through the entire page. | *Information boxes are actually wiki tables placed at specific locations on a page and intended to get the readers attention. The most useful application of these is as an overview or brief summary for a page that has a lot of content. This allows the reader to get the important points and not have to go through the entire page. | ||
*Use information boxes for pages or sections on pages with a lot of information or that have complex information. The objective is to provide quick access to information or simplify information for the reader. | *Use information boxes for pages or sections on pages with a lot of information or that have complex information. The objective is to provide quick access to information or simplify information for the reader. | ||
+ | *These information boxes can also serve as callout boxes - calling attention to a specific item or information | ||
==Hiding text== | ==Hiding text== | ||
− | *If you want to hide text from the reader, use the following coding: <!--hidden text--> | + | *If you want to hide text from the reader, use the following coding without the parentheses: less than sign (<), exclamation mark (!), and two dashes (--). To end the hidden text use two dashes (--) and the greater than sign (>) |
*Hiding text is useful when you have coded text that is not ready for display or that you want temporarily hidden from the reader. | *Hiding text is useful when you have coded text that is not ready for display or that you want temporarily hidden from the reader. | ||
==Categories== | ==Categories== | ||
*Categories provide another way for readers to find material in the wiki. When different pages have a common theme, we can place those pages into a category named after the theme. For example, if we have pages on soil infiltration, measuring soil infiltration, and soil infiltration rates, we can put each of these pages into a category called Soil infiltration. | *Categories provide another way for readers to find material in the wiki. When different pages have a common theme, we can place those pages into a category named after the theme. For example, if we have pages on soil infiltration, measuring soil infiltration, and soil infiltration rates, we can put each of these pages into a category called Soil infiltration. | ||
− | * | + | *At the bottom of the page, place the page in one or more appropriate categories. An example of the coding is [[Category:Level 2 - General information, reference, tables, images, and archives/Reference]]. In this example, the page is placed in a Category called ''Level 2 - General information, reference, tables, images, and archives/Reference''. You should consider adding the noinclude command either side of the category coding if you do not want this text to be copied to another page if the page is transcluded. |
− | *To find | + | *To find the list of categories, in the left toolbar click on Index (Categories) |
==The left toolbar== | ==The left toolbar== | ||
Line 151: | Line 176: | ||
*[https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Accessibility Wikipedia Manual of style – accessibility] | *[https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Accessibility Wikipedia Manual of style – accessibility] | ||
*[https://stormwater.pca.state.mn.us/index.php?title=Help:Contents Help contents] | *[https://stormwater.pca.state.mn.us/index.php?title=Help:Contents Help contents] | ||
+ | |||
+ | [[Category:Level 2 - General information, reference, tables, images, and archives/Reference]] |
This page provides some basic guidance for working in the wiki. It will be updated periodically.
The Minnesota Stormwater Manual is a powerful online tool for disseminating information to stakeholders. Stakeholders include permittees, technical people, managers, educators, the general public, and more.
There are many reasons why you may want to work in the manual. Examples include the following.
Staff within a specific program are encouraged to work in the wiki and bring their programmatic expertise and interests into the manual.
Before you have wiki rights, you should understand the following.
It is important that the coordinator is familiar with the contents of the wiki.
Go into edit mode and copy the coding for this alert onto your test page(s)
Many commands in HTML utilize the following code <>. The command is then closed by </>. Examples include the following.
You can easily find information on different HTML commands on the internet ([1], [2], [3], [4]).
This page was last edited on 1 May 2024, at 14:38.