[Phpgroupware-cvs] manual/doc README

[Sigurd Nes]

CVSROOT:        /sources/phpgroupware
Module name:    manual
Changes by:     Sigurd Nes <sigurdne>   07/04/08 17:37:15

Added files:
        doc            : README 

Log message:
        

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/manual/doc/README?cvsroot=phpgroupware&rev=1.1

Patches:
Index: README
===================================================================
RCS file: README
diff -N README
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ README      8 Apr 2007 17:37:15 -0000       1.1
@@ -0,0 +1,7 @@
+Place your helpfiles (in .odt-format) in <application>/help/<uppercase(lang)>/
+Name your files as <class>.<function>.odt
+Do not keep the 'ui'-prefix from classnames.
+example: helpfile for the function 'index' in the class 'uiproject' will be 
named as 'project.index.odt'
+One can override the default helpfile with (inside the function in question):
+  $GLOBALS['phpgw_info']['apps']['manual']['app'] - to fetch help files for a 
choosen application
+  $GLOBALS['phpgw_info']['apps']['manual']['section'] - to spesify the 
helpfile <section>.odt