Wiki source code of Using On Line Help

Content
Hide line numbers
  1: {{box cssClass="floatinginfobox" title=""}}
  2: {{toc/}}
  3: {{/box}}
  4: Online Help facilitates users to find all relevant information about any task being undertaken. The pages are based on PECOS P2P user guides and manuals and provide structured information to satisfy the different demands of its users who: 
  5: 
  6: * Take part in all Procurement to Pay process activities (e.g. ordering, receipting and settlement)
  7: * Manage the P2P process (e.g. approval, budgetary control, price quote and report monitoring)
  8: * Administration and configuration of business rules.
  9: 
 10: The information on each page comprises text and illustrations. Each topic is logically structured on separate hierarchical pages and includes further detail within child pages as appropriate. Pages have hyperlinks between topics as well as additional documentation where appropriate. Some documents and files can be downloaded or opened in a separate browser.
 11: 
 12: = Features =
 13: The documentation content is held in a number of web pages in major application groupings (e.g. PECOS P2P, P2P Admin and P2P Reporting). 
 14: Information can be navigated via the links embedded in the pages, by using the search panel or by using the tree explorer as explained in the following sections.
 15: 
 16: [[image:2.14-Example Help Screen.png||height="100%" width="100%"]]
 17: 
 18: The help information occupies the majority of the screen and has page tools to enable the export of the information into other formats.
 19: 
 20: Within each grouping, pages are organised hierarchically and include a number of links that allow you to navigate through the information. 
 21: 
 22: The left side of the application are tools that enable navigation of the information (searching, related links, and the context of the current page in the hierarchy of the help information).
 23: 
 24: == Searching ==
 25: The Search Panel accepts the entry of a "Query", a text string of **'Terms'** (words or phrases) and **'Operators'** ( such as **AND** or **OR**) that is used to find relevant information.
 26: 
 27: Enter search text and click the ‘search’ button to search information across all pages of the application groups. Results are presented in a results page, by relevance calculated by the degree of match to the title of the page and its content.
 28: 
 29: [[image:UsinghelpRes1.png||height="95%" width="95%"]]
 30: 
 31: On the search page you may refine your search or navigate to the detail by selecting the link on an entry.
 32: 
 33: === Terms ===
 34: A query is broken up into terms and operators. There are two types of terms: Single Terms and Phrases.
 35: 
 36: * A **Single Term** is a single word such as "test" or "hello". (They do not need to be entered in quotation marks)
 37: * A **Phrase** is a group of words surrounded by double quotes such as "PunchOut catalogue".
 38: 
 39: Multiple terms can be combined together with Boolean operators to form a more complex query (see below).
 40: 
 41: === Wildcards ===
 42: Wild cards help find terms in documents with a similar character pattern e.g.Invoice OR Invoicing OR Invoiced) all of which start with 'Invoic'.
 43: 
 44: There is support for single and multiple character wildcard searches within single terms (but not within phrase queries).
 45: 
 46: * To perform a **single character** wildcard search use the "?" symbol.
 47: The single character wildcard search looks for terms that match that with the single character replaced. For example, to search for "text" or "test" you can use the search: **te?t**
 48: * To perform a **multiple character** wildcard search use the "*" symbol.
 49: Multiple character wildcard searches looks for zero or more characters in a term. For example, to search for Invoice, Invoiced, Invoicer or Invoicing, you can use the search: **invoice***
 50: 
 51: You can also use the wildcard searches in the middle of a term. Note that you cannot use the wildcard symbols (* or ?) as the first character of a search.
 52: 
 53: === Operators ===
 54: Boolean operators allow terms to be combined through logic operators. The following are supported: AND, "+", OR, NOT and "-". Boolean operators must be ALL CAPITALS.
 55: * **OR** is the default operator. This means that when two terms are entered, neither have precedence.
 56: Example: to search for documents that contain either Budget Version or Budgets use the query: “Budget Version” OR Budgets. However, as OR is the default, you could simply enter: “Budget Version” Budgets.
 57: 
 58: * **AND** is an operator that matches documents where both terms exist.
 59: Example: to search for documents that contains both Version and Budget use the query: Budget AND Version.
 60: 
 61: * **“+”** is an operator that requires a term to be present whilst other terms remain optional.
 62: Example: to search for documents that must contain Invoice and may contain ERS use the query: +Invoice ERS.
 63: 
 64: * **NOT** is an operator that excludes documents that contain the term after NOT.
 65: Example: to search for documents that must contain Invoice but not ERS use the query: Invoice NOT ERS.
 66: Note that the NOT operator cannot be used with just one term.
 67: 
 68: * **“-“** is a prohibit operator that excludes documents that contain the term after the “-“ symbol.
 69: Example: to search for documents that contain Approval but not Invoicing use the query: Approval -Invoicing.
 70: 
 71: === Grouping ===
 72: You can **group** terms and operators using parentheses to force how a complex search is to be done.
 73: 
 74: For example, to search for anything to do with approvals but excluding information on budgets or price quotes, use the query: Approvals AND NOT (budget* OR “price quote”).
 75: 
 76: == Navigating ==
 77: 
 78: |[[image:2.1.6-LinksPanel.png]]|(((
 79: The Links Panel has two areas:
 80: 
 81: **Related Areas** - links to PECOS Help pages within other groupings.
 82: 
 83: Click on the name of the page to navigate to that page.
 84: 
 85: 
 86: **Structure** - represents the hierarchical grouping of the pages.
 87: 
 88: The current page and its siblings are displayed along with the parent pages.
 89:   
 90: Clicking on a Page will navigate to that page.
 91: 
 92: When a page has additional pages a ‘+’ symbol will appear. Click to expand.
 93: 
 94: If a ’-‘ symbol appears, the tree elements can be collapsed.
 95: )))
 96: 
 97: == Page Actions ==
 98: Help pages can be exported in a number of formats. Only the content of the page will be exported: side panels will be excluded.
 99: 
100: * **Export**: This will transform the page content into a desktop format that can be downloaded for printing. Supported formats are: PDF, HTML and RTF.
101: * **More Actions**: This allows you to see a clean print preview of the help text in your browser and also allows the page source to be viewed.