swext/mediawiki/help/wiki.xhp

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--***********************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2008 by Sun Microsystems, Inc.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * $RCSfile: wiki.xhp,v $
  11  * $Revision: 1.2 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************ -->
  31
  32 <helpdocument version="1.0">
  33 <meta>
  34 <topic id="comsunstarwikiMediaWikiwikixml" indexer="include" status="PUBLISH">
  35 <title id="tit" xml-lang="en-US">@WIKIEXTENSIONPRODUCTNAME@</title>
  36 <filename>/@WIKIEXTENSIONID@/wiki.xhp</filename>
  37 </topic>
  38 <history>
  39 <created date="2008-02-08T12:13:25"/>
  40 <lastedited date="2008-02-08T14:28:08"/>
  41 </history>
  42 </meta>
  43 <body>
  44 <bookmark xml-lang="en-US" branch="hid/vnd.com.sun.star.wiki:aboutbox" id="bm_id3159252" localize="false"/>
  45 <bookmark xml-lang="en-US" branch="index" id="bm_id3154408"><bookmark_value>Wiki;@WIKIEXTENSIONPRODUCTNAME@</bookmark_value>
  46 <bookmark_value>@WIKIEXTENSIONPRODUCTNAME@</bookmark_value>
  47 <bookmark_value>extensions;MediaWiki</bookmark_value>
  48 </bookmark>
  49 <paragraph role="heading" id="hd_id5993530" xml-lang="en-US" level="1" l10n="NEW">@WIKIEXTENSIONPRODUCTNAME@</paragraph>
  50 <paragraph role="paragraph" id="par_id9647511" xml-lang="en-US" l10n="NEW"><ahelp hid=".">By using the @WIKIEXTENSIONPRODUCTNAME@ you can upload your current Writer text document to a MediaWiki server. After uploading, all Wiki users can read your document on the Wiki.</ahelp></paragraph>
  51 <bookmark xml-lang="en-US" branch="hid/vnd.com.sun.star.wiki:send" id="bm_id3159253" localize="false"/>
  52 <paragraph role="paragraph" id="par_id6468703" xml-lang="en-US" l10n="NEW"><ahelp hid=".">Choose <item type="menuitem">File - Send - To MediaWiki</item> to upload the current Writer document to a MediaWiki server.</ahelp></paragraph>
  53 <paragraph role="heading" id="hd_id4554582" xml-lang="en-US" level="2" l10n="NEW">System Requirements</paragraph>
  54 <list type="unordered">
  55 <listitem>
  56 <paragraph role="paragraph" id="par_id2597430" xml-lang="en-US" l10n="NEW">StarOffice/StarSuite 9</paragraph>
  57 </listitem>
  58 <listitem>
  59 <paragraph role="paragraph" id="par_id8430738" xml-lang="en-US" l10n="NEW">OpenOffice.org 3.0</paragraph>
  60 </listitem>
  61 <listitem>
  62 <paragraph role="paragraph" id="par_id9340495" xml-lang="en-US" l10n="NEW">Java Runtime Environment 1.4</paragraph>
  63 </listitem>
  64 <listitem>
  65 <paragraph role="paragraph" id="par_id7387615" xml-lang="en-US" l10n="NEW">A Wiki account on a supported <link href="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</link> server</paragraph>
  66 </listitem>
  67 </list>
  68 <paragraph role="heading" id="hd_id8047120" xml-lang="en-US" level="2" l10n="NEW">Installing @WIKIEXTENSIONPRODUCTNAME@</paragraph>
  69 <paragraph role="paragraph" id="par_id4277169" xml-lang="en-US" l10n="NEW">Before you install the @WIKIEXTENSIONPRODUCTNAME@, ensure that %PRODUCTNAME uses a Java Runtime Environment (JRE). To check the status of the JRE, choose <item type="menuitem">Tools - Options - %PRODUCTNAME - Java</item>. Ensure that "Use a Java runtime environment" is marked and that a Java runtime folder is selected in the big listbox. If no JRE was activated, then activate a JRE 1.4 or later and restart %PRODUCTNAME.</paragraph>
  70 <paragraph role="heading" id="hd_id567339" xml-lang="en-US" level="3" l10n="NEW">To Install the @WIKIEXTENSIONPRODUCTNAME@</paragraph>
  71 <list type="ordered">
  72 <listitem>
  73 <paragraph role="paragraph" id="par_id1732230" xml-lang="en-US" l10n="NEW">In a Writer window, choose <item type="menuitem">Tools - Extension Manager</item>.</paragraph>
  74 </listitem>
  75 <listitem>
  76 <paragraph role="paragraph" id="par_id4338511" xml-lang="en-US" l10n="NEW">In the Extension Manager dialog, click Add.</paragraph>
  77 </listitem>
  78 <listitem>
  79 <paragraph role="paragraph" id="par_id5882442" xml-lang="en-US" l10n="NEW">Locate the @WIKIEXTENSIONFILENAME@.oxt file, click Open, and then click Close. </paragraph>
  80 </listitem>
  81 <listitem>
  82 <paragraph role="paragraph" id="par_id4008911" xml-lang="en-US" l10n="NEW">Close %PRODUCTNAME, and close also the Quickstarter if enabled.</paragraph>
  83 </listitem>
  84 <listitem>
  85 <paragraph role="paragraph" id="par_id265511" xml-lang="en-US" l10n="NEW">Restart the software, open a text document, then choose <item type="menuitem">Tools - Options - Internet - MediaWiki</item> to enter your Wiki settings. See "To Connect To a Wiki" below.</paragraph>
  86 </listitem>
  87 </list>
  88 <paragraph role="heading" id="hd_id3569444" xml-lang="en-US" level="3" l10n="NEW">To Remove the @WIKIEXTENSIONPRODUCTNAME@</paragraph>
  89 <list type="ordered">
  90 <listitem>
  91 <paragraph role="paragraph" id="par_id2655110" xml-lang="en-US" l10n="NEW">In a Writer window, choose <item type="menuitem">Tools - Extension Manager</item>.</paragraph>
  92 </listitem>
  93 <listitem>
  94 <paragraph role="paragraph" id="par_id9504379" xml-lang="en-US" l10n="NEW">Click the plus sign (+) in front of My Extensions.</paragraph>
  95 </listitem>
  96 <listitem>
  97 <paragraph role="paragraph" id="par_id8431348" xml-lang="en-US" l10n="NEW">Select the extension, click Remove, and then click Close.</paragraph>
  98 </listitem>
  99 </list>
 100 <paragraph role="heading" id="hd_id5316019" xml-lang="en-US" level="2" l10n="NEW">To Connect to a Wiki</paragraph>
 101 <paragraph role="paragraph" id="par_id2381969" xml-lang="en-US" l10n="NEW">Note: You can store your user name and password for all respective dialogs inside %PRODUCTNAME. The password will be stored in a secure way, where access is maintained by a master password. To enable the master password, choose <item type="menuitem">Tools - Options - %PRODUCTNAME - Security</item>.</paragraph>
 102 <paragraph role="paragraph" id="par_id3751640" xml-lang="en-US" l10n="NEW">Note: If you connect to the web using a proxy server, enter the proxy information to <item type="menuitem">Tools - Options - Internet - Proxy</item>, and restart the software.</paragraph>
 103 <list type="ordered">
 104 <listitem>
 105 <paragraph role="paragraph" id="par_id9533677" xml-lang="en-US" l10n="NEW">Open a Writer document, and choose <item type="menuitem">Tools - Options - Internet - MediaWiki</item>.</paragraph>
 106 </listitem>
 107 <listitem>
 108 <paragraph role="paragraph" id="par_id368968" xml-lang="en-US" l10n="NEW">In the <link href="@WIKIEXTENSIONID@/wikisettings.xhp">Options</link> dialog, click Add.</paragraph>
 109 </listitem>
 110 <listitem>
 111 <paragraph role="paragraph" id="par_id6962187" xml-lang="en-US" l10n="NEW">In the <link href="@WIKIEXTENSIONID@/wikiaccount.xhp">MediaWiki</link> dialog, enter the account information for the Wiki.</paragraph>
 112 </listitem>
 113 </list>
 114 <list type="ordered">
 115 <listitem>
 116 <paragraph role="paragraph" id="par_id5328836" xml-lang="en-US" l10n="NEW">In the URL textbox, enter the address of a Wiki that you want to connect to.</paragraph>
 117 <paragraph role="paragraph" id="par_id389416" xml-lang="en-US" l10n="NEW">You can copy the URL from a web browser and paste it into the textbox.</paragraph>
 118 </listitem>
 119 <listitem>
 120 <paragraph role="paragraph" id="par_id5906552" xml-lang="en-US" l10n="NEW">In the Username box, enter your user ID for your Wiki account.</paragraph>
 121 <paragraph role="paragraph" id="par_id9297158" xml-lang="en-US" l10n="NEW">If the Wiki allows anonymous write access, you can leave the Username and Password boxes empty.</paragraph>
 122 </listitem>
 123 <listitem>
 124 <paragraph role="paragraph" id="par_id8869594" xml-lang="en-US" l10n="NEW">In the Password box, enter the password for your Wiki account, then click OK.</paragraph>
 125 </listitem>
 126 </list>
 127 <paragraph role="paragraph" id="par_id292062" xml-lang="en-US" l10n="NEW">Optionally enable "Save password" to save the password between sessions. A master password is used to maintain access to all saved passwords. Choose <item type="menuitem">Tools - Options - %PRODUCTNAME - Security</item> to enable the master password. "Save password" is unavailable when the master password is not enabled.</paragraph>
 128 <paragraph role="heading" id="hd_id7044892" xml-lang="en-US" level="2" l10n="NEW">To Create a New Wiki Page</paragraph>
 129 <list type="ordered">
 130 <listitem>
 131 <paragraph role="paragraph" id="par_id3514206" xml-lang="en-US" l10n="NEW">Open a Writer document.</paragraph>
 132 </listitem>
 133 <listitem>
 134 <paragraph role="paragraph" id="par_id944853" xml-lang="en-US" l10n="NEW">Write the content of the Wiki page. You can use formatting like text formats, headings, footnotes, and more. See the <link href="@WIKIEXTENSIONID@/wikiformats.xhp">list of supported formats</link>.</paragraph>
 135 </listitem>
 136 <listitem>
 137 <paragraph role="paragraph" id="par_id4566484" xml-lang="en-US" l10n="NEW">Choose <item type="menuitem">File - Send - To MediaWiki</item>.</paragraph>
 138 </listitem>
 139 <listitem>
 140 <paragraph role="paragraph" id="par_id228278" xml-lang="en-US" l10n="NEW">In the <link href="@WIKIEXTENSIONID@/wikisend.xhp">Send to MediaWiki</link> dialog, specify the settings for your entry.</paragraph>
 141 </listitem>
 142 </list>
 143 <paragraph role="paragraph" id="par_id2564165" xml-lang="en-US" l10n="NEW">
 144 <emph>MediaWiki server</emph>: Select the Wiki.</paragraph>
 145 <paragraph role="paragraph" id="par_id5566576" xml-lang="en-US" l10n="NEW">
 146 <emph>Title</emph>: Type the title of your page. Type the title of an existing page to overwrite the page with your current text document. Type a new title to create a new page on the Wiki.</paragraph>
 147 <paragraph role="paragraph" id="par_id9688711" xml-lang="en-US" l10n="NEW">
 148 <emph>Summary</emph>: Enter an optional short summary of your page.</paragraph>
 149 <paragraph role="paragraph" id="par_id4123661" xml-lang="en-US" l10n="NEW">
 150 <emph>This is a minor edit</emph>: Check this box to mark the uploaded page as a minor edit of the already existing page with the same title.</paragraph>
 151 <paragraph role="paragraph" id="par_id452284" xml-lang="en-US" l10n="NEW">
 152 <emph>Show in web browser</emph>: Check this box to open your system web browser and show the uploaded Wiki page.</paragraph>
 153 <list type="ordered" startwith="5">
 154 <listitem>
 155 <paragraph role="paragraph" id="par_id8346812" xml-lang="en-US" l10n="NEW">Click Send.</paragraph>
 156 </listitem>
 157 </list>
 158 </body>
 159 </helpdocument>