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