Using XWord

Using XWord

The Ribbon

After you have installed XWord you should be able to see a new tab in your Word Ribbon UI. The ribbon is the new Microsoft Office user interface, added for the first time in Version 12 of Office(2007). The next version, Office 2010, will have the ribbon implemented in all it's products. XWord extends the ribbon by displaying a new tab, that offers you the ability to work with XWiki.

• The XE buttons group offers functionality for adding a new page, saving, and editing a page. It also has a button that toggles the Wiki Explorer
• The file actions group buttons are only active when you have selected a page or attachment in the Wiki Explorer

• The "Wiki Explorer" group has buttons that allow you to:
  • Add a page to the selected space
  • Edit the selected page
  • Upload the active Word Document to the selected page
  • Download the selected attachment
  • Download and open the selected attachment
  • Show pages for the selected space
  • Show attachments for the selected page
  • View the selected page in the default browser
• XWord Options is the place where you can setup you connection options and the syntax that will be used when saving pages

The Wiki Explorer

This is the most efficient way of using XWord as it provides fast saving and allows you to focus on your editing. The Wiki Explorer is located on the right side of the screen, and contains a tree view with the spaces and pages on your wiki server.

Each node in the tree view has a context menu, that works in a similar manner to the Wiki Explorer group in the ribbon.

How To

Create new pages or spaces

To create a page you need to:

• Press the first Add page button on the ribbon or select a space in the Wiki Explorer then right click and press Create new page

• The Add page window should be visible now. If you want to create a new space then select New Space and fill in the name of the space, then the name and title of the new page

• Press Add Page
• You should see a new Word html document. Edit the content and then press Publish Document in the ribbon and wait while the data is being saved

• Navigate to the wiki. You have your new page now :)

Export a Word document to XWiki

• Open and edit your document
• Save the document
• Press the Publish document button in the Ribbon
• Wait while the data is saved to the wiki
• Navigate to the wiki. Your document is online now :)

Connect to a XWiki server

• Go to the XWord tab
• Press XWord options

• In the Connection settings tab fill in your server url, username, and password

• Optional: Select a connectivity method. Eg: XML-RPC or Velocity services
  • Xml-Rpc(default - needs XWiki 2.0.4 or above))
    • Doesn't require any additional setup on the server
    • Does not support custom encoding
  • Velocity Services(Deprecated)
    • Allows you to save wiki pages both in XHTML and XWiki 2.0 syntaxes
    • Works only on XWiki 1.8

Look at the Wiki Explorer, you should see the spaces of the server you just connected to.

Open and edit a wiki page in Word

• Use Wiki Explorer to select the page you wish to edit
• Right click and select Edit this page

• Wait while the data is downloaded and a Word html document is created and opened. Start editing the new document
• When you want to publish the document, go to the XWord tab and press Publish document

• Wait while the data is saved to the server
• If you need to continue editing the document you can do that. Just go back to step 4 until you feel the job is done

Download an attachment

• Use Wiki Explorer to select the page that carries the attachment you wish to download
• Double click on the page name
• Click on the attachment you wish to download
• Right click on the same attachment
• Click on "Download file" or "Download and open file"

• Set the location where the file will be downloaded to
• Click save and you are done