Help text wiki

From Plex-XML
Jump to: navigation, search

Tutorial workflow: Plex-XML tutorial main pagePreparing your environmentExtract the tutorial from CVSRestore the tutorial DBTutorial PlexTutorial EclipseTutorial application user guideTutorial debugTutorial LogHelp text Wiki



By default Plex-XML generates a help link into the upper right corner of every web page. You can see one example in the pictures below.


ChangeRecord.png


This feature can be used to address a help text wiki. Plex-XML is using the Plex internal surrogate number which is unique for each function. Using this number we can address one help text wiki page for each function.

If you click on the "Help" link a wiki page with the name of the Plex surrogate number will be opened in a new window.


HelpTutorialSurrogate.png


While the name of the page is not very easy to remember it might be a good practice to create an automatic redirect from this page to a page with a nicer name withing the wiki. There you can show your help text, let the user change the text in a collaborative approach and you will have an additional discussion section where your user can discuss upcoming features or problems.


HelpTutorialPageLong.png

Personal tools