Guidance on how to use this website and the Manual Revision as of 18:35, 28 March 2013 by PLeegar (talk | contribs) (→‎Understanding external links)(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff) Guidance on how to use this website and the Manual

The conversion of the Minnesota Stormwater Manual into a web-based application will create a new learning curve for users of the Manual. In addition to the web-based format versus the traditional hardcopy and pdf formats, the contents of the manual have been re-arranged. This guidance provides Manual users information on why we went to a web-based format, why the content was re-arranged, what the formatting style is, and most importantly, how to navigate the website.

Why a web-based format?

We live in an electronic world. There are now more mobile devices than people in the United States, and more than half of these devices have Internet access. People not only want electronic access, they want to find a topic quickly. This requires powerful search capability and advanced use of links. Although many users may wish to print out portions of the Manual, printing options are excellent and can satisfy most user's needs.

Much of the material produced for this website was delivered in traditional formats such as Microsoft Word, Microsoft Excel, and PDF. In most cases, we include links to the original documents. Users should note these original documents contain the material included within the website but have undrgone modification for incorporation into the website. For example, we may receive a Word document containing information that is split and placed into different parts of the website. The attachments and content within the website therefore do not precisely match.

Why a wiki format?

A wiki was specifically chosen for the following reasons:

• It can easily be updated. This is critical for stormwater, since new information is being generated on a daily basis. We anticipate being able to provide updates consistently on a weekly to monthly basis.
• Topics or new information can be added easily. The wiki is dynamic in that a new sub-section, section or even chapter can be added at any time.
• A wiki allows for excellent internal linking between and within articles.
• Mediawiki, the platform on which this website is built, is well established and addresses most of the issues that need to be addressed in building, maintaining, and using the website. Examples include an existing Manual of Style and several extensions that allow for writing formulas, citing the Manual, printing and exporting, and creating a book.
• The wiki is easily maintained and supported by technical staff.

Why and how was the arrangement of the content changed?

It was determined that the content of the Manual should be reorganized. There were three primary areas of reorganization.

• The 2008 updates to the Manual were never incorporated directly into the Manual but instead were added as appendices. It was considered important to bring all information on a particular topic together and avoid the potential for conflicting information as updates were made.
• Information in some chapters could be combined. For example, chapter 10, which addresses unified sizing criteria, could be combined with Chapter 12, which provides BMP information. Chapter 11, which addresses stormwater credits, could be combined with Chapter 8 and Appendix B, both of which address modeling.
• The chapters could be organized to flow better. To address this, the following model was selected;
  • provide general information about stormwater
  • discuss the stormwater treatment train
  • discuss the BMPs that can be used in the treatment train approach
  • discuss pollutant and volume reductions, or credits, that can achieved with BMPs
  • provide a regulatory context
  • provide other information such as Minnesota-specific information, definitions, lists of acronyms, and so on.

This flow of information was followed in building the Stormwater Manual Table of Contents.

Stormwater Manual Style Guide

The Wikipedia Manual of Style guide was adapted for this website. It provides information on formatting guidelines.

Accessibility Manual of Style

The Wikipedia Accessibility Manual of Style guide was adapted for this website. It provides information on formatting guidelines for ADA (American Disabilities Act) compliance.

I knew where it was in the old manual, but where is it now?

Most of the material in the 2008 Manual was migrated to the wiki. We have developed a Guide for finding old manual content to help you determine where the old material now resides.

Navigating the website

This section provides basic information to allow the user to navigate the website.

A note on terminology

In reading this guidance, it may be important to understand certain terminology. This is summarized below.

• The website comprises all the material within the Stormwater Manual. it includes many separate webpages, which is a term discussed below. The term "wiki" and "website" are synonymous. Wiki is often used when addressing functionality issues, such as links, while website is often used in the context of the information within the Manual. nevertheless, the two terms are synonymous.
• Webpage includes all meterial within the page that you are on. The website is comprised on many webpages. The term article is often used and is considered synontnous with webpage. However, article typically refers to a webpage that addresses a specifid topic, such as design criteria for a BMP. The Table of Contents and Main page are webpages but do not contain information on stormwater management. They are therefore generally not referred to as articles, although symantically they could be.
• There are many types of images within the website. these include photos, figures, schematics, illustrations, graphs, etc. We have attempted to categorize images by type. For example, captions for photos within the website contain the word photo so that searches can be made on photos. Image is a generic term that may apply to any of the items referred to above.

Information and functions found on all pages in the website

This screen shot illustrates information and functionality found on the top portion of every page in the website. The picture illustrates the MPCA logo, Minnesota Stormwater Manual header, search box, last three pages accessed, and the left sidebar.

This screen shot illustrates information and functionality found on the bottom portion of every page in the website. The picture illustrates the comment/feedback box, the date the page was last updated, MPCA contact information, and copyright information.

There are certain features common to all webpages within this website. These features are identified below and discussed in greater detail in other parts of this guidance. Links are provided to take you to specific discussions and examples for some of the features. The following featuress are found on every page in the website.

• The MPCA logo, found in the upper left portion of the page.
• A header at the top of the page called Minnesota Stormwater Manual.
• A search box and magnifying glass in the upper right portion of the website.
• The left sidebar.
• Links to the last three pages accessed by the user during their current session within the website. These links are found near the top center portion of each page and are in small, blue font. The most recent link accessed during the current session is shown last.
• A section called Help improve this page. This section contains a comment box in which users can send comments or corrections to the editors. Note that any information submitted is public information and can be viewed by any user of the website.
• A list of categories to which the current page belongs.
• The last date when the site was updated
• MPCA contact information and links to assistance and website policy.
• Copyright information

The Main page

The Main page is the equivalent of the Stormwater Manual home page. In addition to the information and functions found on every page it contains the following:

• The Minnesota Clean Water, Land and Legacy Amendment logo. Funding to build this website was provided through the Clean Water, Land and Legacy Amendment.
• A picture of the cover of the 2006 version of the Minnesota Stormwater Manual.
• A link to the Manual Table of Contents.
• A link to a list of contributors to the Minnesota Stormwater Manual (Acknowledgements)
• A link to this guidance document

The left sidebar

The left sidebar contains much of the functionality for the user. It includes links, help, printing and exporting functions, citing functions, and more. These are explained in greater detail below.

The left sidebar - Navigation

The left sidebar on the website provides many potentially useful functions for the user. Each of the items in the sidebar are explained below.

Main page

This link takes you to the Main Page. This is the "Home page" for the Stormwater Manual. From here you can link to the Table of Contents or find some general information about the website, including access to guidance on using the website, Acknowledgements, a summary of recent important updates, and feedback.

Table of contents

This link takes you to the Table of Contents for the Manual. From here you can cursor down to the section of the Manual you want to view or use the Page Contents in the upper right part of the screen to display the contents of the page, from where you select the section you want to view.

Categories

The wiki allows different subjects to be placed into different categories. This allows a user to view just the topics within a particular category. For example, Fact sheets could be a category that includes all the fact sheets contained within the website. A user could click on category and open the page with all categories. The user would then select the category called Fact sheets to display links to the different fact sheets within the website. The number of categories will continue to grow as the website becomes populated and organized.

Events

The link takes you to a short list of events. NOTE THE MPCA DOES NOT ENDORSE SPECIFIC EVENTS. Only events in which the MPCA participates are listed.

Recent changes

The wiki stores all previous versions of the website. Any change results in the previous version being stored. Users can therefore view any previous version of the website. This page does not specify changes that were made. However, the user can choose specific dates when previous versions existed.

Help

The Help page contains two basic groups of information. First is a link to this guidance document, which provides help on a variety of topics. The second category of information is for editors of the wiki. Examples include links to math and formatting instructions.

The left sidebar - Toolbox

The Toolbox contains links to pages that primarily used by the editors of the website. These are not explained in this guidance. However, What links here may have utility for some users. This page provides a summary of and links to other pages that have links within the page that you are on.

The left sidebar - MPCA links

Links are provided to the MPCA homepage, MPCA's stormwater main page, and a webpage containing MPCA policies and disclaimers.

The left sidebar - Print/Export

This section of the sidebar allows the user to print, export, and build their own documents.

Create a book

Users can combine webpages (e.g. articles) using this utility. For example, if a user wanted to combine all the sections that provide information on credits for individual BMPs, this can be done by creating a book containing these webpages. The pages can be ordered in any manner. The user can save the book or create a PDF document containing the selected webpages.

Export as PDF

Users can export the page they are currently on as a PDF document.

Printable version

Clicking on this link takes the user to a version of the webpage that does not contain the headers, footers and toolbars found on any given page in the website. The view observed on the screen will be what the user obtains when they print from this page.

Finding a topic

Each webpage within the website is essentially an article. The Manual is therefore a collection of articles, each with its own webpage. Articles usually contain multiple sub-sections. We attempted to keep articles at a reasonable length, dividing a topic into multiple articles when the length for a single article became too long.

Using the Table of Contents

You can access the Stormwater Manual Table of Contents from the home page. There is a link at the top of the home page. The Table of Contents is divided into the following chapters:

• General information
• Stormwater treatment
• Best Management Practices
• Stormwater modeling, models and calculators, and calculating credits
• Regulatory
• Minnesota specific applications
• Case studies
• Fact sheets
• CADD drawings
• Construction Stormwater Manual (Blue Book)
• Industrial stormwater
• Acronyms and definitions

Each of these chapters has two or more sub-sections.

Clicking on a topic link from the Table of Contents may take you directly to an article or to another table of contents. For example, most of the BMPs discussed in the chapter Best Management Practices have multiple articles. We have attempted to minimze the number of clicks needed to get to an article while not making the articles excessive in length.

Using the search function

A search box and magnifying glass is found in the upper right portion of each page. This may be used to search within the website. Single or multiple word searches can be conducted. Typing a particular word or phrases produces a number of links to the item of interest. These are ordered first by webpages that are related to the search item and then by content within webpages that is related to the item of interest. For example, typing permeable pavement design criteria results in the screen shot shown to the right. The first link takes you directly to a webpage (article) addressing design criteria for permeable pavement. The remaining links take you to places within the website where one or more of the terms used in the search are found. TRhe search engine used to power these searches is similar to search engines used on modern browsers.

Understanding internal links

An internal link is a hyperlink that is a reference or navigation element in an article to another section of the same article or to another article that may be on or part of the Minnesota stormwater Manuel. In articles like this one, the words highlighted in blue are examples of internal links.

Links are considered either "external" or "internal" depending on perspective. Generally, a link to a page outside the Minnesota Stormwater Manual is considered external, whereas one to a location in the Minnesota Stormwater Manual is considered internal. Although this can be a matter of semantics for some sites that are internal to the MPCA websites but external to the Stormwater Manual itself.

Understanding external links

Minnesota Stormwater Manual articles may include links to web pages outside Minnesota Stormwater Manual (external links). They should not normally be considered as part of the body of an article. Some links include those that contain further research are information that could not be added to the article for reasons such as copyright or amount of detail, or other meaningful, relevant content that is not suitable for inclusion in an article for reasons unrelated to its accuracy.