Using and adding to the Orixa Help System 

If you have an Orixa App with an integrated Help System, you also control the content of Your App's Help System, and can add topics and content as you extend your own App. All the basic Help items will be present, but you can add extra topics, and they can be linked to elements in your App via tags, so users can read them via the local access to Help in App. This means users can be given context-based help on how to use their App, and you can author it.

These topics will be present internally in your Orixa App, and can be published to the Orixa website help-index if you wish, or kept private.

Hopefully  you will find writing documents using the Help system reasonably intuative. Review the names of the documents in the Help Treeview, and read / scan through those you find useful. It is usually best to add a new "root" element in the tree for your App, and add your Help topics underneath this.

Images have been included throughout to make explanation as straight-forward as possible.

Many Components (visual elements) in the Orix framework are directly linked to pieces of help. If you right-click on an item in your App and see a "Show Help for ..." choice, clicking on it will take you direct to context-sensitive help for that specific item. This context sensitive help works with "class name tags", if you add something to an App which has its own class-name, you can then write a Help topic with that name and the App should find it.

Note that the "tree structure" of the Help system should mean that nearby items to the one you are reading may also be of interest, for example if context-sensitive help takes you to a particular help-item, you should definitely check other items which are "above" and "below" the one you are taken to, in order to get a fuller picture.

Navigation around the in-App Help System

    

Content Navigator	Using the "TOC" Table Of Contents listing Click on the down arrow beside "TOC" in the tool-bar. Click on any item in the table-of-contents and the viewer will automatically  scroll  to that point.
Search Highlighter	Highlighting text so you can find it in a document Type any word into the highlighter (in the example the text "Syst" has been typed). All the occurances of this word will appear highlighted in yellow in the main window.
Tree Search or Filter	Using the Tree-view search box to find topics Type any text into the search box above the Help-tree. Help records whos titles contain the search-text will be shown, all other help records will be filtered out.
Help Items Treeview Recent Items	The "Recent Items" tool-button Click here to see a list of recently viewed Help-items.  This makes it easy to go "back" and view records you have recently viewed, just click on the items  in the list and you should jump to that content.

Extending the Help Yourself

The Help is part of your App. Data in the Help system is stored just like data anywhere else in the system, and can be edited in exactly the same way. 

Users with Developer security levels can access the Edit Form for the Help-Items data-table simply by "Double-clicking" on any item in the Help Tree View. Once an item is open they can type into the "Content" field to edit or add to the Help.

Developers can also add new records to the help, and fill them with useful content. They can use the "CodeClassName" and "TagsList" fields  to help users find a topic. Entries added in these fields are used to allow users to locate help items.

Help Items Parent Items list	Newly added items will always be added "below" the "ParentID" that is selected for them. Please try to follow the simple heirarchy that has been created for items, with separate entries for "Users" "Developers" and "Programmers" when adding items that would fit into these categories. You may want to add a heading dedicated to your own App if needed.
Help Items Code Class Names list	Pick an item from the "CodeClassName" List in the HelpItems Edit Form to link the item you have written or edited to a BusinessObject or component in the system. Note that if you add new BusinessObjects to a system new entries for these will appear on this list, allowing you to write specific Help documents for each one. Also if you add custom data-viewers to the system their "class names" will appear in this list, also allowing you to create dedicated help which users can access direct from the screen. The "TagsList" field can be filled with any text. When a user filters the Help-items tree data entered into the TagsList is used to control the filter-process.
Help Items Order Field	When adding new records you can set the order in which they will be listed in the Help-tree. Be sure to try to use the "Order" field in the Help Items to ensure that items appear in a sensible order. Note that new items will naturally be given an Order value to try to help you to do this, but that you have to manually correct ordering if you start adding multiple items or want to re-order subsequent to the initial authoring.

Shortcut Keys in the Help Editor

The help editor includes a set of "shortcut keys", combinations of [CTRL] + number keys, which make it easier and quicker to edit text.
It also includes a Popup-Menu with additional features.

To review the Help Editor's Short-cut keys check this link