You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

if you are a user of the system and would like to contribute text for the help screens, login to the ofbiz document system and create the pages in the 'wiki' and notify of this event in the mailing list or create a 'jira' issue (http://jira.apache.org)

If you are a contributor you can create the help screens the following way:

1. make sure the 'main-decorator' of the affected component contains the following statement:
<property-map resource="ComponentNameHelpUrls" map-name="helpUrlsMap" global="true"/>
2. Create or modify the file config/ComponentNameHelpUrls.xml to make the link between the request and the actual page name in the correct language within Confluence at docs.ofbiz.org. To see the nameof the request uncomment the indicated line in 'helpLink.ftl'
3. goto docs.ofbiz.org -> OFBIZENDUSER -> Ofbiz End user.
4. from the page in number 3 go down the tree until you find the document which is the parent of the new page.
5. click the edit button and then click the 'add page' button to create a child page.
6. Make the title of the page the same as the language title you have created in point 2 and enter the help text on that page

If the request name however is 'showPortalPage' a slightly different approach is implemented. When the system displays a portal page, it will first show a portlet selection list and after that show the help of the portlet.
The help page name is still translated in one of the *HelpUrls.xml file but the propertyname in this case is 'PORTLET_portalPortletId' Please check the endof the file PortalPageForms.xml.

  • No labels