How to Use this Online Manual

XYZ Utilities O&M Manual Rev. 2.0 - November 1, 2019

This topic is included within each manual to help you use features.

A note about the manual layout

The manual is formatted for "Responsive" access - which means it will self-customize to the most optimal layout for the viewing device (e.g. Android Phone, Android Tablet, iPhone, iPad, Kindle Fire, Desktop/Laptop, etc.) and browser window size.

You can see this on a desktop or laptop: as the browser window size decreases the display switches to tablet - landscape layout (function bar at left) then phone or tablet - portrait layout (function bar at bottom).

Using features in this manual

Basic navigation

Filtering content

Finding specific information - index and search

Using the glossary and definitions

Copying information

Basic Navigation

View the function panes:
  

Table of Contents

  

Index

 

Glossary

 

Filter

 

Search

  
In a large browser window on desktops, the function pane is automatically displayed at left with a function bar at the top, and the topic pane is displayed at right.
 
In a smaller window and on mobile devices only one pane is shown - either a function pane or the topic pane. The function bar appears on the left or bottom side of the window.
 
Click/tap the button in the function bar for the pane you want to see:  

Table of Contents

Index

Glossary

 Filter

  Search

On small screens, to dismiss the pane, tap the button on the function bar again.
Hide or show the function pane Desktop: Click or between the left and right panes.
Mobile: Tap the button in the function bar again, or tap the Back to Topic button  or  at upper-right to return to the previously-viewed topic.
Return to the previous screen Desktop: click the browser's "back" button.
Mobile: press your device's "back" button.
 
Note: links to federal and state regulations open in a new browser tab. To return to the manual close that tab.
Step through topics Click/tap the browse buttons  or in the function bar at the top of the topic.
Return to the top of the topic Click/tap the Go to Top button at the bottom of the window.
Return to the Home (Welcome) page Click/tap the manual name on the title bar.
Go to the ViaData.com website Click/tap the logo on the title bar.
View regulations Links to federal and state regulations will open in a new browser tab.
  • To return to the manual, simply close the regulations tab.
  • To view other regulations, use the table of contents, index and search functions in the regulations window.
  • To go to the first topic with a list of  regulations for that state or code part, click/tap the top title bar in the regulations window.
  • Click/tap the WinDOT icon on a regulation's title bar to go to the login screen for WinDOT, the pipeline safety encyclopedia. You must be a WinDOT subscriber to log in.
  • Anyone can view ViaData's free federal regulations at 49cfrpipeline.com. State regulations are only available to Manuals On-Line users and WinDOT subscribers.
Print the current topic Desktop: Click the Print button  in the function bar at the top of the topic. (If the print button does not display, increase the browser window size.) 
The topic will print on your default printer. 
  
Mobile: Consult your browser/device documentation for how to print a web page. The Print function is usually accessible through the browser's Share function.
Switch from desktop to tablet and mobile layouts Decrease the browser window size.
Report any incorrect or missing/ incomplete information in this manual, or suggest an improvement Contact ViaData

 

Filtering content

State-specific information is displayed with the state's icon (or a 'Multi' icon for multiple states) and a light blue background.

You can use filters to display this information only for the states you select in the Filter pane.

Note: Whenever you open the manual, check the Filter pane to see if any filters are enabled. This will ensure that the content you want to see is not hidden.

Display state-specific information only for select states Click/tap the Filter button in the function bar to display the Filter pane.
  • Select the states whose information you want to see.
    The Filter button will change  to show that a filter is active.
  • When you view topics, information for other (unchecked) states will be hidden.
  • If no states are checked, all available information for all states will be displayed.
  • As you change the filter to select different states the topic content changes dynamically to show only the information for those states.
  • When filters are active, hidden information may cause some subsections to appear blank, and some skips in numbered items.
  • Links to any information hidden by a filter will not function.
  • The filter remains active until you disable it (uncheck all states).

 

Finding specific information - index and search

Find topics using the Index Click/tap the Index button in the function bar to open the Index pane.
Type the first few letters of the word in the Filter Keywords box, or scroll until you find the item in the list.
Click/tap the index item to see relevant topics.
(In a larger manual, most index entries will display multiple topics associated.)
Find text within the current topic Use your browser's Find function (<Ctrl+F> for desktop users).
Search the entire manual for specific text Click/tap the Search button in the function bar, type your text in the Search box.
 
Check "Display results with all search words" option to find content with all the words; uncheck it to find content with any of the words. 
Press Enter or tap  in the box.

(Desktop users can also enter text in the Search box on the topic function bar, then click the search icon in the box.)

  
A list of matching items appears, ordered by their relevance. 
  
Documents with text content that are included with your manual are also searchable by keyword. 
  
Click/tap a topic or document title in the results to display it. Search item(s) are highlighted in topics but not in other documents.

Search hints

Search examples

Search term Result
dent Topics with any word containing 'dent' including dent, dents, indents, incidents, confidential etc.
plastic pipe valve 
["Display results with all..." checked]
Topics that contain all the words; they can occur anywhere in the topic and need not be adjacent.1
plastic pipe valve 
["Display results with all..." not checked]
Topics that contain at least one of the words. 2
"plastic pipe valve" Only topics that contain the exact phrase.
Boolean searches 
Note: You must clear the "Display results with all search words" checkbox for the following search types.
plastic and pipe and valve Topics that contain all the words; they can occur anywhere in the topic and need not be adjacent.1
plastic or pipe or valve Topics that contain at least one of the words.2
plastic and not pipe Topics that contain the first word (plastic) but do not contain the second word (pipe).
  1 - These searches are equivalent. 
2 - These searches are equivalent.

 

Using the glossary and definitions

View a list of glossary terms and their definitions Click/tap the Glossary button in the function bar.
 
In the alphabetical list of terms that displays, scroll to find the term of interest, or enter text in the Filter terms box at the top to display matching terms. 
  
Click/tap the term - the definition will appear below the term.
View the definition of a term within the text Glossary terms within a topic are indicated by maroon text.
 
Click/tap the colored text (e.g. MAOP) to display the definition of the word or phrase.
 
Click/tap again to close the definition.

 

Copying information

You can copy information from the manual and paste it into another program such as Microsoft Word. Use your system or device built-in copy and paste functions.

Note: If the manual is displayed in an older version of Internet Explorer, text copied to Microsoft Word may include unwanted hidden text. For example, pasting text that includes a glossary term may show the hidden definition text. To remedy this, in Word, go to File > Options > Display and disable the options "Show all formatting marks" and "Hidden text".

This is not an issue when viewing the manual in other browsers.