In order to create an online help translation, you have to be logged in as an Administrator or as a member of the Administrators group. Here is a detailed description of the basic steps:
For the Online Help, you need the base module org.opencms.help
and the English Online Help module org.opencms.help.en
which serves as a master for your new Online Help. You can download these modules at the OpenCms website http://www.opencms.org. Now you have to upload those modules in the Backoffice of OpenCms:
Switch back to an offline project and create a new module. Fill out the dialog as follows (this example is for the Italian "it" locale):
Click "ok".
You have now created the new module which should be displayed in the modules overview page. Next step is to add a property to the new created module.
You should now see the "Module properties" dialog again, and it should list the new entry for "additionalresources" as you have just entered it.
/system/modules/
folder.org.opencms.help.it
in this example. Open this folder.classes
, default_bodies
, elements
, lib
and templates
. Delete all folders in the module./system/workplace/help/
. Lock the subfolder en/
. Use the folders context menu to copy the folder. Enter a folder /system/workplace/help/it
(where it
stands for the Italian example) as destination of the "copy to..." field. The entire contents of the english Online Help are now copied to this new subfolder.You can navigate through the copied help pages in the Explorer view of OpenCms and edit them either with the WYSIWYG editor or the Sourcecode editor of OpenCms just like any page. Replace the english content with your translation.
To create new help pages you have to change the visibility of the master template which is needed for the Online Help pages.
To do that, switch to the folder /system/modules/org.opencms.help/templates/
and change the permissions of the file help_default
to rwvrwvr-v-
(i.e. just add the "v" flags). Now you should see the template "Online help default template" in the "New page" dialog of OpenCms. Select this template to create new help pages in the subfolders of /system/workplace/help/it/
, where it
is an example for the Italian locale.
Please mind to add the new pages to the navigation, your chosen page title will be displayed as navigation text.
The last step is to export the Online Help module. To do so just switch to the "Adminstration" -> "Module management" screen again.
Click on the icon left to your module name and select "Export" and confirm with "Ok". Your module should now be exported. You might check if the files and the subfolders of /system/workplace/help/it
(for the Italian help) are listed as exported in the output.
Confirm with "Ok" after the export is finished.
Now your module has been written to {$TOMCAT_HOME}/opencms/WEB-INF/export/modules
, in our example with the filename org.opencms.help.it_1.zip
.
You can now import that module to other OpenCms servers by switching to the "Online" project in the OpenCms workplace on another server and selecting the "Upload module from" option on top of the screen.
Note: You always have to upload the base module org.opencms.help
for your localized online help to work.
Of course, it would be great if you contribute your online help translation so that others can use it as well. If you want to do so, please send your exported module to contributions@opencms.org. We will make it available for download on the OpenCms website. You or your company will of course be mentioned as the translator.
]]>In order to create an online help translation, you have to be logged in as an Administrator or as a member of the Administrators group. Here is a detailed description of the basic steps:
For the Online Help, you need the base module org.opencms.help
and the English Online Help module org.opencms.help.en
which serves as a master for your new Online Help.
You can download these modules at the OpenCms website http://www.opencms.org.
Now you have to upload those modules in the Backoffice of OpenCms:
Switch back to an offline project and create a new module. Fill out the dialog as follows (this example is for the Italian "it" locale):
Click "ok".
You have now created the new module which should be displayed in the modules overview page. Next step is to add a property to the new created module.
You should now see the "Module properties" dialog again, and it should list the new entry for "additionalresources" as you have just entered it.
/system/modules/
folder.
org.opencms.help.it
in this example. Open this folder.
classes
, default_bodies
, elements
, lib
and templates
.
Delete all folders in the module.
/system/workplace/help/
.
Lock the subfolder en/
. Use the folders context menu to copy the folder.
Enter a folder /system/workplace/help/it
(where it
stands for the Italian example) as destination
of the "copy to..." field. The entire contents of the english Online Help are
now copied to this new subfolder.You can navigate through the copied help pages in the Explorer view of OpenCms and edit them either with the WYSIWYG editor or the Sourcecode editor of OpenCms just like any page. Replace the english content with your translation.
To create new help pages you have to change the visibility of the master template which is needed for the Online Help pages.
To do that, switch to the folder /system/modules/org.opencms.help/templates/
and change the permissions of the file help_default
to rwvrwvr-v-
(i.e. just add the "v" flags).
Now you should see the template "Online help default template" in the "New page" dialog of OpenCms.
Select this template to create new help pages in the subfolders of /system/workplace/help/it/
,
where it
is an example for the Italian locale.
Please mind to add the new pages to the navigation, your chosen page title will be displayed as navigation text.
The last step is to export the Online Help module. To do so just switch to the "Adminstration" -> "Module management" screen again.
Click on the icon left to your module name and select "Export" and
confirm with "Ok". Your module should now be exported. You might check
if the files and the subfolders of /system/workplace/help/it
(for the Italian help) are listed as exported in the
output.
Confirm with "Ok" after the export is finished.
Now your module has been written to
{$TOMCAT_HOME}/opencms/WEB-INF/export/modules
,
in our example with the filename org.opencms.help.it_1.zip
.
You can now import that module to other OpenCms servers by switching to the "Online" project in the OpenCms workplace on another server and selecting the "Upload module from" option on top of the screen.
Note: You always have to upload the base module org.opencms.help
for your localized online help to work.
Of course, it would be great if you contribute your online help translation so that others can use it as well. If you want to do so, please send your exported module to contributions@opencms.org. We will make it available for download on the OpenCms website. You or your company will of course be mentioned as the translator.
]]>