Enterprise Edition:Help pages: Difference between revisions
From CoPlanner 11
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
CoPlanner offers the possibility that users can create their own help pages with specific information. | |||
== | ==Required Objects== | ||
For using help pages these steps have to be executed: | |||
# | # Download and unpack this file [http://copsupport.coplanner.com/files/wiki/Hilfeseiten.zip] | ||
# | # Create an application property with the name REST_HELP_LINK. This property includes the URL to the online help. The value consists of „<http|https>://<Adress of server>:<Port of rest service>/<Path of CoPlanner application>/prototype/#/help/“. For a local rest server using http on port 8080 the value would be <nowiki>http://localhost:8080/coplanner/prototype/#/help/</nowiki> | ||
# | # Tables HelpContent and COP_Help_Links and procedure sp_HelpContent_initialisieren are needed in the database. In the downloaded folder you can find the script SQL_Objekte_Hilfeseiten.sql. When you execute this script tables and procedure will be created. | ||
# | # Table HelpIssues, formula HelpIssues_link and macro HelpContent_initialisieren_mak are needed. In the downloaded folder you can also find Objekte_Hilfeseiten.zip. Import this file in the object administration and execute macro CreateViews. | ||
After performing these steps all required objects are installed. | |||
==Create help pages== | |||
To create a new help page open table HelpIssues. | |||
Create one or more new data records via button "Create new record" in the ribbon and type in the title of the help page in the column HelpIssue. Column link has not to be filled manually because afterwards a formula will fill this column. | |||
Save your records. | |||
Execute macro HelpContent_initialisieren_mak to finally create your new pages. | |||
If you click on a link in the table HelpIssues you will be forwarded to the new help page. | |||
[[Image:Hilfeseite_Neu.JPG|thumb|center|Help page]] | |||
==Edit help pages== | |||
To add a link to the help page press hot key Ctrl + e. | |||
Now you have on the left side the functionality to add links via a drop down and you also can see the symbol [[Image:Button_Hilfeseite_Editieren.JPG]]. A click on this symbol opens the editor for the layout of the help text. | |||
[[Image:Hilfeseite_Editieren.JPG|thumb|center|Edit help page]] | |||
[[Image:Hilfeseiten_Editieren_Funktionen.png|thumb|center|Edit help page, Functions]] | |||
In the drop down "Add links" existing help pages can be linked. Selected pages will be shown in the drop down. To delete a linking move the mouse over this linking. A recycle bin symbol is being shown to delete the entry. A click on this symbol deletes the link. | |||
On the right side you can type in and edit your text and rework your layout. | |||
Texts can be inserted at each position. Texts can be formatted with options of the editor. | |||
{| {{Bausteindesign1}} | {| {{Bausteindesign1}} | ||
|- | |- | ||
| <span style="color: darkblue;">''' | | <span style="color: darkblue;">'''Hint'''</span> Do not forget to save your changes with the grey disk symbol. | ||
|} | |} | ||
== | ==Invocation of help pages== | ||
Help pages can be invoked via CopLinks. | |||
Example for such a link in which 'Hauptseite' is the name of the help page: | |||
cop://&name=Hilfe: Hauptseite&aktion=Sonstige&p1=Browserwindow&p2=@REST_HELP_LINK@Hauptseite?SessionID=@Session_ID@&p3=Details&p4=Work&frmlocation=Work | cop://&name=Hilfe: Hauptseite&aktion=Sonstige&p1=Browserwindow&p2=@REST_HELP_LINK@Hauptseite?SessionID=@Session_ID@&p3=Details&p4=Work&frmlocation=Work | ||
Latest revision as of 10:37, 8 February 2017
CoPlanner offers the possibility that users can create their own help pages with specific information.
Required Objects
For using help pages these steps have to be executed:
- Download and unpack this file [1]
- Create an application property with the name REST_HELP_LINK. This property includes the URL to the online help. The value consists of „<http|https>://<Adress of server>:<Port of rest service>/<Path of CoPlanner application>/prototype/#/help/“. For a local rest server using http on port 8080 the value would be http://localhost:8080/coplanner/prototype/#/help/
- Tables HelpContent and COP_Help_Links and procedure sp_HelpContent_initialisieren are needed in the database. In the downloaded folder you can find the script SQL_Objekte_Hilfeseiten.sql. When you execute this script tables and procedure will be created.
- Table HelpIssues, formula HelpIssues_link and macro HelpContent_initialisieren_mak are needed. In the downloaded folder you can also find Objekte_Hilfeseiten.zip. Import this file in the object administration and execute macro CreateViews.
After performing these steps all required objects are installed.
Create help pages
To create a new help page open table HelpIssues.
Create one or more new data records via button "Create new record" in the ribbon and type in the title of the help page in the column HelpIssue. Column link has not to be filled manually because afterwards a formula will fill this column.
Save your records.
Execute macro HelpContent_initialisieren_mak to finally create your new pages.
If you click on a link in the table HelpIssues you will be forwarded to the new help page.
Edit help pages
To add a link to the help page press hot key Ctrl + e.
Now you have on the left side the functionality to add links via a drop down and you also can see the symbol 
. A click on this symbol opens the editor for the layout of the help text.
In the drop down "Add links" existing help pages can be linked. Selected pages will be shown in the drop down. To delete a linking move the mouse over this linking. A recycle bin symbol is being shown to delete the entry. A click on this symbol deletes the link.
On the right side you can type in and edit your text and rework your layout.
Texts can be inserted at each position. Texts can be formatted with options of the editor.
| Hint Do not forget to save your changes with the grey disk symbol. |
Invocation of help pages
Help pages can be invoked via CopLinks. Example for such a link in which 'Hauptseite' is the name of the help page:
cop://&name=Hilfe: Hauptseite&aktion=Sonstige&p1=Browserwindow&p2=@REST_HELP_LINK@Hauptseite?SessionID=@Session_ID@&p3=Details&p4=Work&frmlocation=Work
