Difference between revisions of "OpenOffice.org Add-on"

From OpenKM Documentation
Jump to: navigation, search
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== OpenOffice AddOn ==
+
== OpenOffice Add-In ==
  
OpenOffice Add On is compatible from OpenOffice version 3.2 and OpenKM repository 4.x
+
OpenOffice Add-In is compatible from OpenOffice version 3.2 and OpenKM repository 4.x
  
After installing OpenOffice Add On it'll appears new "OpenKM" toolbar menu options.  
+
After installing OpenOffice Add-In, "OpenKM" appears as a new toolbar. It usually appears in the top-left of the OpenOffice window.
  
  
Line 9: Line 9:
  
  
Detail of the functions according to their icons:
+
Details of the functions according to their icons:
  
* [[File:Configuration_16.png]] → Add On configuration
+
* [[File:Configuration_16.png]] → Add-in configuration
 
* [[File:Add_16.png]] → Add new document
 
* [[File:Add_16.png]] → Add new document
 
* [[File:Edit_16.png]] → Document edit ( check-out )
 
* [[File:Edit_16.png]] → Document edit ( check-out )
Line 18: Line 18:
 
* [[File:Help_16.png]] → Help
 
* [[File:Help_16.png]] → Help
  
 
+
== Configure OpenKM Add-In ==
== Configure OpenKM Add On ==
+
First you must select the OpenKM tool bar option to set your configuration values to access OpenKM from the client computer. If you've got the OpenKM Add-In already installed, this may not be needed.
First you must select OpenKM tool bar option to setting your configurations values for remote OpenKM accessing from client computer. If you've got other OpenKM AddIn yet installed it's not needed.
 
  
  
Line 26: Line 25:
  
  
When you setting your configuration values is created '''OpenKM folder''' in your '''user home'''. Into OpenKM folder is created a configuration file called '''openkm.xml''' and other file called '''document.xml''' that OpenKM Add On uses to store some document editing information, you might not editing or deleting this file.
+
When you set your configuration values, a folder called '''OpenKM''' is created in your user '''My documents folder'''. In this OpenKM folder, a configuration file called '''openkm.xml''' and another file called '''document.xml''' are created that the OpenKM Add-in uses to store some document editing information. You should not edit or delete these files.
  
  
 
[[File:Okm_user_guide_088.jpeg‎|center]]
 
[[File:Okm_user_guide_088.jpeg‎|center]]
 
  
 
== Uploading a new file ==
 
== Uploading a new file ==
After making a click in [[File:Add_16.png]] adding new document button, it'll appears a tree browser view. You must select the folder where you want to uploading the file.
+
Before you begin, make sure the file you wish to upload is a) saved to disk (or OpenKM with throw an error) and b) has the file name you wish it to have within the OpenKM repository otherwise you will have to go through the OpenKM web interface to change the filename (true up to at least OpenKM 5.0)).  After clicking on the '''add new document''' button - [[File:Add_16.png]], a folder tree window appears. You must select a folder within this window before you are allowed to upload the file.
  
 +
[[File:Okm_user_guide_089.jpeg‎|center]]
  
[[File:Okm_user_guide_089.jpeg‎|center]]
 
  
 +
Once you've found the correct folder, highlight it and click the '''Add''' Button, and the document will be uploaded to OpenKM. Once the process is complete a notification window will pop-up.
  
Click on '''Add''' Button, and after document it'll be uploaded to OpenKM it'll appears a notification message.
 
  
 +
[[File:Okm_user_guide_091.jpeg‎|center]]
  
== Edit OpenKM document ==
+
== Edit an OpenKM document ==
After making a click in [[File:Edit_16.png]] document edit button, it'll appear a navigator browser. You must navigate across folders and select a document that you want to edit.
+
After clicking on the [[File:Edit_16.png]] document edit button, a folder navigator will appear. You must navigate across folders and select a document that you want to edit.
  
  
Line 50: Line 49:
  
  
When you've got some OpenKM document opened, it'll be enabled [[File:Update_16.png]] '''Upload modified document''' (check-in) and [[File:Cancel_16.png]] '''Cancel document edit''', toolbar option.
+
When you've got some OpenKM document opened, the [[File:Update_16.png]] '''Upload modified document''' (check-in) and [[File:Cancel_16.png]] '''Cancel document edit''' toolbar options will be enabled.
  
 
* '''To upload modified document''', use the [[File:Update_16.png]] Upload modified document (check-in) toolbar button.
 
* '''To upload modified document''', use the [[File:Update_16.png]] Upload modified document (check-in) toolbar button.
Line 56: Line 55:
 
* '''To cancel document editing''', use the [[File:Cancel_16.png]] Cancel document edit toolbar button.
 
* '''To cancel document editing''', use the [[File:Cancel_16.png]] Cancel document edit toolbar button.
  
{{Warning|After editing your local document copy will be deleted to prevent user confusion.}}
+
{{Warning|After editing, your local document copy will be deleted to prevent user confusion.}}
 +
 
 +
{{Note|OpenKM Open Office Add-in runs with OpenKM 5.x or higher.}}
  
{{Note|OpenKM Word Addin runs with OpenKM 4.x or upper.}}
+
==Troubleshooting ==
 +
Linux users must remember to install the following packages:
 +
openoffice.org-java-common
 +
openoffice.org-java
  
 
[[Category: User Guide]]
 
[[Category: User Guide]]

Latest revision as of 12:51, 31 October 2011

OpenOffice Add-In

OpenOffice Add-In is compatible from OpenOffice version 3.2 and OpenKM repository 4.x

After installing OpenOffice Add-In, "OpenKM" appears as a new toolbar. It usually appears in the top-left of the OpenOffice window.


Okm user guide 086.jpeg


Details of the functions according to their icons:

  • Configuration 16.png → Add-in configuration
  • Add 16.png → Add new document
  • Edit 16.png → Document edit ( check-out )
  • Update 16.png → Upload modified document (check-in)
  • Cancel 16.png → Cancel document edit
  • Help 16.png → Help

Configure OpenKM Add-In

First you must select the OpenKM tool bar option to set your configuration values to access OpenKM from the client computer. If you've got the OpenKM Add-In already installed, this may not be needed.


Okm user guide 087.jpeg


When you set your configuration values, a folder called OpenKM is created in your user My documents folder. In this OpenKM folder, a configuration file called openkm.xml and another file called document.xml are created that the OpenKM Add-in uses to store some document editing information. You should not edit or delete these files.


Okm user guide 088.jpeg

Uploading a new file

Before you begin, make sure the file you wish to upload is a) saved to disk (or OpenKM with throw an error) and b) has the file name you wish it to have within the OpenKM repository otherwise you will have to go through the OpenKM web interface to change the filename (true up to at least OpenKM 5.0)). After clicking on the add new document button - Add 16.png, a folder tree window appears. You must select a folder within this window before you are allowed to upload the file.

Okm user guide 089.jpeg


Once you've found the correct folder, highlight it and click the Add Button, and the document will be uploaded to OpenKM. Once the process is complete a notification window will pop-up.


Okm user guide 091.jpeg

Edit an OpenKM document

After clicking on the Edit 16.png document edit button, a folder navigator will appear. You must navigate across folders and select a document that you want to edit.


Okm user guide 090.jpeg


When you've got some OpenKM document opened, the Update 16.png Upload modified document (check-in) and Cancel 16.png Cancel document edit toolbar options will be enabled.

  • To upload modified document, use the Update 16.png Upload modified document (check-in) toolbar button.
  • To cancel document editing, use the Cancel 16.png Cancel document edit toolbar button.

Nota advertencia.png After editing, your local document copy will be deleted to prevent user confusion.


Nota clasica.png OpenKM Open Office Add-in runs with OpenKM 5.x or higher.

Troubleshooting

Linux users must remember to install the following packages:

openoffice.org-java-common
openoffice.org-java