Difference between revisions of "Word Addin"

From OpenKM Documentation
Jump to: navigation, search
(Created page with 'After installing Word 2003 Adding it'll appears new "OpenKM". center')
 
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
After installing Word 2003 Adding it'll appears new "OpenKM".  
+
Office Add-ins are compatible from version 2000 to version 2007.
 +
 
 +
After installing the Word add-in, a new menu item "OpenKM" will appear in Word.  
  
  
 
[[File:Okm_user_guide_080.jpg|center]]
 
[[File:Okm_user_guide_080.jpg|center]]
 +
 +
 +
Detail of the functions according to their icons:
 +
 +
* [[File:Okm_user_guide_084.jpg]] → Addin configuration
 +
* [[File:Add_document.gif]] → Add new document
 +
* [[File:Checkout.gif]] → Document edit ( check-out )
 +
* [[File:Checkin.gif]] → Upload modified document (check-in)
 +
* [[File:Cancel_checkout.gif]] → Cancel document edit
 +
* [[File:Okm_user_guide_085.jpg]] → 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 other OpenKM Add-Ins already installed, this may not be needed.
 +
 +
 +
[[File:Okm_user_guide_077.jpeg|center]]
 +
 +
 +
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_078.jpeg|600px|center]]
 +
 +
 +
== Uploading a new file ==
 +
After clicking on the [[File:Add_document.gif]] add new document button, a folder tree view will appear. You must select the folder where you want to upload the file.
 +
 +
 +
[[File:Okm_user_guide_081.jpg|center]]
 +
 +
 +
Click on the '''Send''' Button and after that the document will be uploaded to OpenKM and a notification message will appear.
 +
 +
 +
[[File:Okm_user_guide_082.jpg|center]]
 +
 +
 +
== Editing an OpenKM document ==
 +
After clicking on the [[File:Checkout.gif]] document edit button, a folder navigator will appear. You must navigate across folders and select a document that you want to edit.
 +
 +
 +
[[File:Okm_user_guide_083.jpg|center|737px]]
 +
 +
 +
 +
When you've got some OpenKM document opened, the [[File:Checkin.gif]] '''Upload modified document''' (check-in) and [[File:Cancel_checkout.gif]] '''Cancel document edit''' toolbar options will be enabled.
 +
 +
* '''To upload modified document''', use the [[File:Checkin.gif]] Upload modified document (check-in) toolbar button.
 +
 +
* '''To cancel document editing''', use the [[File:Cancel_checkout.gif]] Cancel document edit toolbar button.
 +
 +
{{Warning|After editing, your local document copy will be deleted to prevent user confusion.}}
 +
 +
{{Note|OpenKM Word Add-in runs with OpenKM 4.1 or higher.}}
 +
 +
[[Category: User Guide]]

Latest revision as of 11:47, 31 October 2011

Office Add-ins are compatible from version 2000 to version 2007.

After installing the Word add-in, a new menu item "OpenKM" will appear in Word.


Okm user guide 080.jpg


Detail of the functions according to their icons:

  • Okm user guide 084.jpg → Addin configuration
  • Add document.gif → Add new document
  • Checkout.gif → Document edit ( check-out )
  • Checkin.gif → Upload modified document (check-in)
  • Cancel checkout.gif → Cancel document edit
  • Okm user guide 085.jpg → 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 other OpenKM Add-Ins already installed, this may not be needed.


Okm user guide 077.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 078.jpeg


Uploading a new file

After clicking on the Add document.gif add new document button, a folder tree view will appear. You must select the folder where you want to upload the file.


Okm user guide 081.jpg


Click on the Send Button and after that the document will be uploaded to OpenKM and a notification message will appear.


Okm user guide 082.jpg


Editing an OpenKM document

After clicking on the Checkout.gif 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 083.jpg


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

  • To upload modified document, use the Checkin.gif Upload modified document (check-in) toolbar button.
  • To cancel document editing, use the Cancel checkout.gif 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 Word Add-in runs with OpenKM 4.1 or higher.