xref: /trunk/main/swext/mediawiki/help/wiki.xhp (revision 19f38498)
1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="comsunstarwikiMediaWikiwikixml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">@WIKIEXTENSIONPRODUCTNAME@</title>
28<filename>/@WIKIEXTENSIONID@/wiki.xhp</filename>
29</topic>
30</meta>
31<body>
32<bookmark xml-lang="en-US" branch="hid/vnd.com.sun.star.wiki:aboutbox" id="bm_id3159252" localize="false"/>
33<bookmark xml-lang="en-US" branch="index" id="bm_id3154408"><bookmark_value>Wiki;@WIKIEXTENSIONPRODUCTNAME@</bookmark_value>
34<bookmark_value>@WIKIEXTENSIONPRODUCTNAME@</bookmark_value>
35<bookmark_value>extensions;MediaWiki</bookmark_value>
36</bookmark>
37<paragraph role="heading" id="hd_id5993530" xml-lang="en-US" level="1" l10n="NEW">@WIKIEXTENSIONPRODUCTNAME@</paragraph>
38<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>
39<bookmark xml-lang="en-US" branch="hid/vnd.com.sun.star.wiki:send" id="bm_id3159253" localize="false"/>
40<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>
41<paragraph role="heading" id="hd_id4554582" xml-lang="en-US" level="2" l10n="NEW">System Requirements</paragraph>
42<list type="unordered">
43<listitem>
44<paragraph role="paragraph" id="par_id2597430" xml-lang="en-US" l10n="NEW">OpenOffice.org 3.x</paragraph>
45</listitem>
46<listitem>
47<paragraph role="paragraph" id="par_id8430738" xml-lang="en-US" l10n="NEW">Apache OpenOffice 4.x</paragraph>
48</listitem>
49<listitem>
50<paragraph role="paragraph" id="par_id9340495" xml-lang="en-US" l10n="NEW">Java Runtime Environment 1.6</paragraph>
51</listitem>
52<listitem>
53<paragraph role="paragraph" id="par_id7387615" xml-lang="en-US" l10n="NEW">A Wiki account on a supported <link href="https://www.mediawiki.org/wiki/MediaWiki">MediaWiki</link> server</paragraph>
54</listitem>
55</list>
56<paragraph role="heading" id="hd_id8047120" xml-lang="en-US" level="2" l10n="NEW">Installing @WIKIEXTENSIONPRODUCTNAME@</paragraph>
57<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.6 or later and restart %PRODUCTNAME.</paragraph>
58<paragraph role="heading" id="hd_id567339" xml-lang="en-US" level="3" l10n="NEW">To Install the @WIKIEXTENSIONPRODUCTNAME@</paragraph>
59<list type="ordered">
60<listitem>
61<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>
62</listitem>
63<listitem>
64<paragraph role="paragraph" id="par_id4338511" xml-lang="en-US" l10n="NEW">In the Extension Manager dialog, click Add.</paragraph>
65</listitem>
66<listitem>
67<paragraph role="paragraph" id="par_id5882442" xml-lang="en-US" l10n="NEW">Locate the @WIKIEXTENSIONFILENAME@.oxt file, click Open, and then click Close. </paragraph>
68</listitem>
69<listitem>
70<paragraph role="paragraph" id="par_id4008911" xml-lang="en-US" l10n="NEW">Close %PRODUCTNAME, and close also the Quickstarter if enabled.</paragraph>
71</listitem>
72<listitem>
73<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>
74</listitem>
75</list>
76<paragraph role="heading" id="hd_id3569444" xml-lang="en-US" level="3" l10n="NEW">To Remove the @WIKIEXTENSIONPRODUCTNAME@</paragraph>
77<list type="ordered">
78<listitem>
79<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>
80</listitem>
81<listitem>
82<paragraph role="paragraph" id="par_id9504379" xml-lang="en-US" l10n="NEW">Click the plus sign (+) in front of My Extensions.</paragraph>
83</listitem>
84<listitem>
85<paragraph role="paragraph" id="par_id8431348" xml-lang="en-US" l10n="NEW">Select the extension, click Remove, and then click Close.</paragraph>
86</listitem>
87</list>
88<paragraph role="heading" id="hd_id5316019" xml-lang="en-US" level="2" l10n="NEW">To Connect to a Wiki</paragraph>
89<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>
90<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>
91<list type="ordered">
92<listitem>
93<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>
94</listitem>
95<listitem>
96<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>
97</listitem>
98<listitem>
99<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>
100</listitem>
101</list>
102<list type="ordered">
103<listitem>
104<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>
105<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>
106</listitem>
107<listitem>
108<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>
109<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>
110</listitem>
111<listitem>
112<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>
113</listitem>
114</list>
115<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>
116<paragraph role="heading" id="hd_id7044892" xml-lang="en-US" level="2" l10n="NEW">To Create a New Wiki Page</paragraph>
117<list type="ordered">
118<listitem>
119<paragraph role="paragraph" id="par_id3514206" xml-lang="en-US" l10n="NEW">Open a Writer document.</paragraph>
120</listitem>
121<listitem>
122<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>
123</listitem>
124<listitem>
125<paragraph role="paragraph" id="par_id4566484" xml-lang="en-US" l10n="NEW">Choose <item type="menuitem">File - Send - To MediaWiki</item>.</paragraph>
126</listitem>
127<listitem>
128<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>
129</listitem>
130</list>
131<paragraph role="paragraph" id="par_id2564165" xml-lang="en-US" l10n="NEW">
132<emph>MediaWiki server</emph>: Select the Wiki.</paragraph>
133<paragraph role="paragraph" id="par_id5566576" xml-lang="en-US" l10n="NEW">
134<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>
135<paragraph role="paragraph" id="par_id9688711" xml-lang="en-US" l10n="NEW">
136<emph>Summary</emph>: Enter an optional short summary of your page.</paragraph>
137<paragraph role="paragraph" id="par_id4123661" xml-lang="en-US" l10n="NEW">
138<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>
139<paragraph role="paragraph" id="par_id452284" xml-lang="en-US" l10n="NEW">
140<emph>Show in web browser</emph>: Check this box to open your system web browser and show the uploaded Wiki page.</paragraph>
141<list type="ordered" startwith="5">
142<listitem>
143<paragraph role="paragraph" id="par_id8346812" xml-lang="en-US" l10n="NEW">Click Send.</paragraph>
144</listitem>
145</list>
146</body>
147</helpdocument>
148