Difference between revisions of "Documentation/Dashboard/Wiki Editing Policy"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
(20 intermediate revisions by 3 users not shown)
Line 11: Line 11:
  
 
= Project-independent ruleset =
 
= Project-independent ruleset =
−
{{Note|See the general project-independent rules at [[OOo_Wiki_Contribution_Rules]] first!}}
+
{{Note|See the general project-independent rules at [[OOo_Wiki_Contribution_Rules|AOO_Wiki_Contribution_Rules]] first!}}
  
 
= Prerequisites for Editing =
 
= Prerequisites for Editing =
Line 43: Line 43:
 
#* If you are starting a new topic click on the '''+''' sign to the right of the '''edit''' tab at the top, fill in the subject line and write your comment in the main text box.
 
#* If you are starting a new topic click on the '''+''' sign to the right of the '''edit''' tab at the top, fill in the subject line and write your comment in the main text box.
 
#* If you want to add a comment to an existing discussion leave it after the existing comments and indent it by putting one or more colons (<code>:</code>) at the beginning of each paragraph.
 
#* If you want to add a comment to an existing discussion leave it after the existing comments and indent it by putting one or more colons (<code>:</code>) at the beginning of each paragraph.
−
# Sign your username with four tildes (<code><nowiki>~~~~</nowiki></code>). You can do this automatically with the '''signature with timestamp''' button ( http://wiki.services.openoffice.org/w/skins/common/images/button_sig.png ) on the toolbar.
+
# Sign your username with four tildes (<code><nowiki>~~~~</nowiki></code>). You can do this automatically with the '''signature with timestamp''' button ( https://wiki.openoffice.org/w/skins/common/images/button_sig.png ) on the toolbar.
 
# Click '''Save Page'''.
 
# Click '''Save Page'''.
  
−
To learn more about comments see the [http://www.mediawiki.org/wiki/Help:Talk_pages Mediawiki help about talk pages]
+
To learn more about comments see the [https://www.mediawiki.org/wiki/Help:Talk_pages Mediawiki help about talk pages]
  
 
=Structure of the [[Documentation]] Section of the Wiki=
 
=Structure of the [[Documentation]] Section of the Wiki=
  
−
The Documentation section is only part of the large OpenOffice.org Wiki. The doc.oo.o project
+
The Documentation section is just one part of the large {{AOo}} Wiki. The project
 
tries to present the information in this section in a way that it is easily accessible and
 
tries to present the information in this section in a way that it is easily accessible and
 
has a structure that allows straightforward navigation for both users and contributors.
 
has a structure that allows straightforward navigation for both users and contributors.
Line 56: Line 56:
 
All documentation pages are subpages of the main Documentation page. A further substructure
 
All documentation pages are subpages of the main Documentation page. A further substructure
 
presents sections as subpages containing further subpages. Think of it as a hierarchical
 
presents sections as subpages containing further subpages. Think of it as a hierarchical
−
representation, just like a file system. Every subpage is automatically linked back to the main page.
+
representation, just like a filesystem. Every subpage is automatically linked back to the main page.
  
 
The current wiki page tree looks like this:
 
The current wiki page tree looks like this:
Line 67: Line 67:
 
|-
 
|-
 
|[[Documentation/Administration Guide]]
 
|[[Documentation/Administration Guide]]
−
|Guide that describes how to administer an OpenOffice.org network installation
+
|Guide that describes how to administer an {{AOo}} network installation
 
|-
 
|-
 
|[[Documentation/FAQ]]
 
|[[Documentation/FAQ]]
Line 80: Line 80:
 
|[[Documentation/OOo3 User Guides]]
 
|[[Documentation/OOo3 User Guides]]
 
|Collection of OpenOffice.org 3 User Guides from OOoAuthors
 
|Collection of OpenOffice.org 3 User Guides from OOoAuthors
 +
|-
 +
|[[Documentation/AOO4_User_Guides/AOO4.1_User_Guide_Chapters]]
 +
|Collection of Apache OpenOffice User Guides
 
|-
 
|-
 
|[[Documentation/Tutorials]]
 
|[[Documentation/Tutorials]]
Line 88: Line 91:
 
|-
 
|-
 
|[[Documentation/Setup Guide]]
 
|[[Documentation/Setup Guide]]
−
|Sub-project page in order to provide a guide through the setup process of OpenOffice.org (in progress)
+
|Sub-project page in order to provide a guide through the setup process of {{AOo}} (in progress)
 
|-
 
|-
 
|[[Documentation/BASIC Guide]]
 
|[[Documentation/BASIC Guide]]
−
|Guide that provides an introduction to programming with OpenOffice.org BASIC
+
|Guide that provides an introduction to programming with {{AOo}} BASIC
 
|-
 
|-
 
|[[Documentation/Building Guide]]
 
|[[Documentation/Building Guide]]
−
|Guide that describes how to build the {{OOo}} software yourself, from source.
+
|Guide that describes how to build the {{AOo}} software yourself, from source.
 
|-
 
|-
 
|[[Documentation/DevGuide]]
 
|[[Documentation/DevGuide]]
−
|Guide that describes how to program with OpenOffice.org using the component technology UNO (Universal Network Objects) with OpenOffice.org.
+
|Guide that describes how to program with {{AOo}} using the component technology UNO (Universal Network Objects) with {{AOo}}.
 
|-
 
|-
 
|[[Documentation/Reference]]
 
|[[Documentation/Reference]]
Line 109: Line 112:
 
* If the new page can be a subpage of an existing page simply go to the existing page and create a link to the new page. After saving the page with the link you can click the link and start writing on your new page.
 
* If the new page can be a subpage of an existing page simply go to the existing page and create a link to the new page. After saving the page with the link you can click the link and start writing on your new page.
  
−
* If you want to create a really new page for the Documentation project, you can use the wiki's URL for creating a new page. You should observe the wiki page tree when you create a new page in this way. The URL to a wiki page is then something like this: <br>  <tt><nowiki> http://wiki.services.openoffice.org/wiki/documentation/</nowiki>''Page Name''</tt>  
+
* If you want to create a really new page for the Documentation project, you can use the wiki's URL for creating a new page. You should observe the wiki page tree when you create a new page in this way. The URL to a wiki page is then something like this: <br>  <tt><nowiki> https://wiki.openoffice.org/wiki/Documentation/</nowiki>''Page Name''</tt>  
 
* However, the recommended method is to search for the desired page name (in the Search field above left), and when the page does not exist, you will be offered to "create this page" by clicking on a link on the Search Results Page.  
 
* However, the recommended method is to search for the desired page name (in the Search field above left), and when the page does not exist, you will be offered to "create this page" by clicking on a link on the Search Results Page.  
  
 
{{Note | The URL approach is only useful if you link the page later to other pages. Otherwise it will be hidden in the wiki.}}
 
{{Note | The URL approach is only useful if you link the page later to other pages. Otherwise it will be hidden in the wiki.}}
  
−
For more information about new pages see the [http://www.mediawiki.org/wiki/Help:Starting_a_new_page Mediawiki help about new pages]
+
For more information about new pages see the [https://www.mediawiki.org/wiki/Help:Starting_a_new_page Mediawiki help about new pages]
  
 
=Using Categories=
 
=Using Categories=
Line 127: Line 130:
 
{{Warn | Do not create duplicate Categories for the same topic. Each Category must be unique. Otherwise it will be difficult to use the Categories for searching the wiki.}}
 
{{Warn | Do not create duplicate Categories for the same topic. Each Category must be unique. Otherwise it will be difficult to use the Categories for searching the wiki.}}
  
−
Look at [http://www.mediawiki.org/wiki/Help:Categories MediaWiki Help:Categories] if you want to know more about Wiki Categories.
+
Look at [https://www.mediawiki.org/wiki/Help:Categories MediaWiki Help:Categories] if you want to know more about Wiki Categories.
  
 
A simple example of how to use Categories in Wiki books:
 
A simple example of how to use Categories in Wiki books:
Line 136: Line 139:
 
The reader can then view the book Category.  The book Category shows all the chapters in the book.  If the reader clicks on a chapter Category, they can see all of the pages in that chapter (in alphabetical order).
 
The reader can then view the book Category.  The book Category shows all the chapters in the book.  If the reader clicks on a chapter Category, they can see all of the pages in that chapter (in alphabetical order).
  
−
Do not add a category and its subcategory to the same wiki page. For more information see the MediaWiki Help:Category section on [http://meta.wikimedia.org/wiki/Help:Category#Category_considerations Category considerations].
+
Do not add a category and its subcategory to the same wiki page. For more information see the MediaWiki Help:Category section on [https://meta.wikimedia.org/wiki/Help:Category#Category_considerations Category considerations].
  
−
You can use Templates to add a common category to a large group of pages, but it is not recommended.  It may appear to save time, but "adding or deleting a category tag in the template does not add or delete the listings on the category page of pages that use the template, until some edit is made in the page that uses the template."  For more information, see the MediaWiki Help:Category section on [http://meta.wikimedia.org/wiki/Help:Category#Using_templates_to_populate_categories Using templates to populate categories].
+
You can use Templates to add a common category to a large group of pages, but it is not recommended.  It may appear to save time, but "adding or deleting a category tag in the template does not add or delete the listings on the category page of pages that use the template, until some edit is made in the page that uses the template."  For more information, see the MediaWiki Help:Category section on [https://meta.wikimedia.org/wiki/Help:Category#Using_templates_to_populate_categories Using templates to populate categories].
  
 
=Templates=
 
=Templates=
  
−
Look at the [http://www.mediawiki.org/wiki/Help:Templates Templates help] if you are unfamiliar with mediawiki templates.
+
Look at the [https://www.mediawiki.org/wiki/Help:Templates Templates help] if you are unfamiliar with mediawiki templates.
  
 
==Adding a new Documentation Template==
 
==Adding a new Documentation Template==
Line 150: Line 153:
 
** right: <tt>Documentation/mytemplate</tt>
 
** right: <tt>Documentation/mytemplate</tt>
  
−
* Add a description of the template purpose and usage to the template itself using the <code><noinclude></code> element as described in [http://meta.wikimedia.org/wiki/Help:Template#Noinclude.2C_includeonly.2C_and_onlyinclude MediaWiki help: Template].
+
* Add a description of the template purpose and usage to the template itself using the <code><noinclude></code> element as described in [https://meta.wikimedia.org/wiki/Help:Template#Noinclude.2C_includeonly.2C_and_onlyinclude MediaWiki help: Template].
  
 
* Add the template to the list of templates below.
 
* Add the template to the list of templates below.
Line 173: Line 176:
 
Displays the following message:
 
Displays the following message:
 
| {{Mt|EN}}
 
| {{Mt|EN}}
 +
|-
 +
| [[Template:Revision]]
 +
|  {{Mt|EN}}
 +
This template is intended to mark pages that need revision. {{Tlp|Revision|EN}}
 +
| {{Revision|EN}}
 
|-
 
|-
 
| [[Template:DocBanner]]  
 
| [[Template:DocBanner]]  
Line 190: Line 198:
 
| {{PDF}}
 
| {{PDF}}
 
|-
 
|-
−
| [[Template:OOo]]  
+
| [[Template:PRODUCTNAME]]  
 
| A variable for displaying the string '''OpenOffice.org'''.  
 
| A variable for displaying the string '''OpenOffice.org'''.  
−
{{Tlp|OOo}}
+
{{Tlp|PRODUCTNAME}}
  
−
| {{OOo}}
+
| {{PRODUCTNAME}}
 +
|-
 +
| [[Template:OOo]]
 +
| A variable for displaying the string '''Apache OpenOffice'''.
 +
{{Tlp|OOo}} - '''Do not use anymore, use <nowiki>{{AOo}}</nowiki> instead'''
 +
| {{OOo}}  
 
|-
 
|-
 
| [[Template:AOo]]
 
| [[Template:AOo]]
−
| A variable for displyaing the string '''Apache OpenOffice'''
+
| A variable for displaying the string '''Apache OpenOffice'''
 
{{Tlp|AOo}}
 
{{Tlp|AOo}}
 
| {{AOo}}
 
| {{AOo}}
Line 267: Line 280:
 
|-
 
|-
 
| [[Template:Bug]]  
 
| [[Template:Bug]]  
−
| Links to Issuezilla issue.  
+
| Links to Bugzilla issue.  
 
{{Tlp|Bug|123456}}
 
{{Tlp|Bug|123456}}
 
| {{Bug|123456}}
 
| {{Bug|123456}}
 
|-
 
|-
 
| [[Template:Note]]  
 
| [[Template:Note]]  
−
| Takes sections containing notes,i.e. related, reinforcing information, for example, an explanation or comment.  
+
| Takes sections containing notes, i.e. related, reinforcing information, for example, an explanation or comment.  
 
{{Tlp|Note|Notable stuff}}
 
{{Tlp|Note|Notable stuff}}
 
| {{Note|Notable stuff}}
 
| {{Note|Notable stuff}}
Line 313: Line 326:
 
|-
 
|-
 
| [[Template:Documentation/MasterTOC]]  
 
| [[Template:Documentation/MasterTOC]]  
−
| This is the master template that is used to create tables of content. For usage click the template name.  
+
| This is the master template that is used to create tables of content. For usage, click the template name.  
 
|  
 
|  
 
|-
 
|-
Line 324: Line 337:
 
| [[Template:AOoVersion]]  
 
| [[Template:AOoVersion]]  
 
| {{Mt|EN}}
 
| {{Mt|EN}}
−
This template is used to insert an ApacheOpenOffice version box on a page.  
+
This template is used to insert an Apache OpenOffice version box on a page.  
 
{{Tlp|AOoVersion|EN|4.1.x}}
 
{{Tlp|AOoVersion|EN|4.1.x}}
 
| {{AOoVersion|EN|4.1.x}}
 
| {{AOoVersion|EN|4.1.x}}
Line 442: Line 455:
 
| [[Template:Path]]  
 
| [[Template:Path]]  
 
| This template using to format file system path.  
 
| This template using to format file system path.  
−
{{Tlp|Path|C:\Program files\OpenOffice.org}}
+
{{Tlp|Path|C:\Program files(x86)\OpenOffice 4}}
−
| {{Path|C:\Program files\OpenOffice.org}}
+
| {{Path|C:\Program files (x86)\OpenOffice 4}}
  
 
|}
 
|}
Line 464: Line 477:
  
  
−
To place the image on a page you can use the MediaWiki Image thumbnail feature which "wraps" your illustrations in an image box.  This image box includes a spot for an image caption.  The syntax is <tt>[[Image:''image.png|thumb|position|size|Image caption'']]</tt>, where:
+
To place the image on a page you can use the MediaWiki Image thumbnail feature which "wraps" your illustrations in an image box.  This image box includes a spot for an image caption.  The syntax is <tt><nowiki>[[Image:''image.png|thumb|position|size|Image caption'']]</nowiki></tt>, where:
 
* thumb = thumbnail the image and wrap in an image box
 
* thumb = thumbnail the image and wrap in an image box
 
* position = position on page. "none" places the image on the left of the frame with no text wrapping. "left" and "right" places the image on the left or right of the page with full text wrapping.
 
* position = position on page. "none" places the image on the left of the frame with no text wrapping. "left" and "right" places the image on the left or right of the page with full text wrapping.
Line 470: Line 483:
 
If you do not declare a position and size, the image is scaled to a small thumbnail, and defaults to the right hand side of the page with full text wrapping.
 
If you do not declare a position and size, the image is scaled to a small thumbnail, and defaults to the right hand side of the page with full text wrapping.
  
−
Here is an example using <tt><nowiki>[[Image:LoadSaveOptions.png|thumb|none|500px|An example image caption]]</nowiki></tt>
+
Here is an example using <tt><nowiki>[[Image:LoadSaveOptions_AOO.png|thumb|none|500px|An example image caption]]</nowiki></tt>
  
−
[[Image:LoadSaveOptions.png|thumb|none|500px|An example image caption]]
+
[[Image:LoadSaveOptions_AOO.png|thumb|none|500px|An example image caption]]
  
 
* How to handle image and table numbering?
 
* How to handle image and table numbering?
Line 478: Line 491:
 
=Linking=
 
=Linking=
  
−
Although the editing window offers assistence in writing internal and external links look at the [http://www.mediawiki.org/wiki/Help:Links MediaWiki help page about links] for a better understanding of how links are working in wikis.
+
Although the editing window offers assistence in writing internal and external links look at the [https://www.mediawiki.org/wiki/Help:Links MediaWiki help page about links] for a better understanding of how links are working in wikis.
  
−
There is another MediaWiki help page if you need some [http://meta.wikimedia.org/wiki/Help:Wikitext_examples#Links  examples].
+
There is another MediaWiki help page if you need some [https://meta.wikimedia.org/wiki/Help:Wikitext_examples#Links  examples].
  
 
When creating link text consider the guidelines for [[Documentation/Dashboard/Help_Style_Guide#Using_Links | using links]] in our style guide.
 
When creating link text consider the guidelines for [[Documentation/Dashboard/Help_Style_Guide#Using_Links | using links]] in our style guide.
Line 506: Line 519:
 
When you have selected a page to work on  
 
When you have selected a page to work on  
  
−
#test whether the described procedures are still valid for the current version of OpenOffice.org.  
+
#test whether the described procedures are still valid for the current version of {{AOo}}.  
 
#log in and make the necessary corrections.
 
#log in and make the necessary corrections.
  
Line 546: Line 559:
  
 
There is also a [[Special:Listusers/sysop|list of Wiki Sysops]] (people who can delete pages). If you want to have pages deleted, you can either ask someone from that list, or better, add the Wiki Syntax <tt><nowiki>{{delete}}</nowiki></tt> anywhere on the page you want to be deleted. This will add the page to the "Candidates for speedy deletion" category, and the page will be deleted by someone with Sysop privileges, or by WikiBot maintenance.
 
There is also a [[Special:Listusers/sysop|list of Wiki Sysops]] (people who can delete pages). If you want to have pages deleted, you can either ask someone from that list, or better, add the Wiki Syntax <tt><nowiki>{{delete}}</nowiki></tt> anywhere on the page you want to be deleted. This will add the page to the "Candidates for speedy deletion" category, and the page will be deleted by someone with Sysop privileges, or by WikiBot maintenance.
 +
 +
It is a good idea to indicate the reason for deleting a page; the Wiki Syntax is <tt><nowiki>{{delete|justification}}</nowiki></tt>.
  
 
=Working on FAQs=
 
=Working on FAQs=
Line 625: Line 640:
 
# Click the link to your How To and start writing by using the rules of the [[Documentation/Dashboard/Help_Style_Guide | style guide]]. If you are not sure about how to implement the style guide, have a look at the Writer How To [[Documentation/How_Tos/Getting_a_Picture_into_the_Gallery | Getting a Picture Into the Gallery]].
 
# Click the link to your How To and start writing by using the rules of the [[Documentation/Dashboard/Help_Style_Guide | style guide]]. If you are not sure about how to implement the style guide, have a look at the Writer How To [[Documentation/How_Tos/Getting_a_Picture_into_the_Gallery | Getting a Picture Into the Gallery]].
  
−
{{Note|Always put the licence link at the end of your article: Simply insert <tt><nowiki>{{PDL1}}</nowiki></tt>. }}
+
{{Note|Always put the license link at the end of your article: Simply insert <tt><nowiki>{{PDL1}}</nowiki></tt>. }}
  
 
You can also create How Tos by writing a new page like <tt>Documentation/How Tos/''Page Name''</tt> with one or more specific categories. The newly created How To page will then be assigned to the corresponding How To sections. The available categories for that are the following:
 
You can also create How Tos by writing a new page like <tt>Documentation/How Tos/''Page Name''</tt> with one or more specific categories. The newly created How To page will then be assigned to the corresponding How To sections. The available categories for that are the following:
Line 643: Line 658:
 
When you have finished, mark the page with the label "Checked for technical accuracy" as described in the [[Documentation/Dashboard/Wiki_Editing_Policy#List_of_Existing_Documentation_Templates | Templates]] section above, and click '''Save page'''.
 
When you have finished, mark the page with the label "Checked for technical accuracy" as described in the [[Documentation/Dashboard/Wiki_Editing_Policy#List_of_Existing_Documentation_Templates | Templates]] section above, and click '''Save page'''.
  
−
Do not forget to notify [mailto:dev@documentation.openoffice.org dev@documentation.openoffice.org] about your work on the How Tos.
+
Do not forget to notify [mailto:doc@openoffice.apache.org doc@openoffice.apache.org] about your work on the How Tos.
  
 
=Working on Guides=
 
=Working on Guides=
Line 649: Line 664:
 
* [[Documentation/Administration_Guide|The Administration Guide]]
 
* [[Documentation/Administration_Guide|The Administration Guide]]
 
* [[Documentation/BASIC_Guide|The BASIC  Programming Guide]]
 
* [[Documentation/BASIC_Guide|The BASIC  Programming Guide]]
−
* [[Documentation/Building_Guide|The Building Guide (OO.o from source)]]
+
* [[Documentation/Building_Guide|The Building Guide (AOO from source)]]
 
* [[Documentation/DevGuide/OpenOffice.org_Developers_Guide|The Developer's Guide]]
 
* [[Documentation/DevGuide/OpenOffice.org_Developers_Guide|The Developer's Guide]]
 
* [[Documentation/OOoAuthors_User_Manual|The User Guides for OpenOffice.org 2.x]]
 
* [[Documentation/OOoAuthors_User_Manual|The User Guides for OpenOffice.org 2.x]]
 
* [[Documentation/OOo3_User_Guides|The User Guides for OpenOffice.org 3.x]]
 
* [[Documentation/OOo3_User_Guides|The User Guides for OpenOffice.org 3.x]]
−
 
−
If you want to work on the User Guides for OpenOffice.org please contact the [http://www.oooauthors.org OOoAuthors group].
 
  
 
There is some help available about [[Documentation/DevGuide/Contributing_to_the_Developers_Guide|Contributing to the Developer's Guide]] which may also be useful for the Administration Guide and the BASIC Programming Guide.
 
There is some help available about [[Documentation/DevGuide/Contributing_to_the_Developers_Guide|Contributing to the Developer's Guide]] which may also be useful for the Administration Guide and the BASIC Programming Guide.

Latest revision as of 17:01, 11 September 2022

doc OOo


This article helps you to contribute effectively to the Documentation part of the wiki. We strongly encourage you to announce new pages or major changes to the mailing list doc@openoffice.apache.org.


Project-independent ruleset

Documentation note.png See the general project-independent rules at AOO_Wiki_Contribution_Rules first!

Prerequisites for Editing

You must be registered and logged in before you can edit the Wiki. Registration is easily done.

  1. Click on Log in / create account in the upper right corner of the screen and enter the required bits.
  2. Subsequently you have to validate your email address.

For further logins you use the same entry point, enter Username and Password, and click the Log in button.

Documentation caution.png To combat vandalism, newly registered users cannot edit any page or create a new page until a four (4) day "cooling off period" has elapsed.

The next step could be to tell the Community about yourself. There is definitely no harm and it is a good way of getting comfortable with the Wiki.

  1. When you are logged in, your username shows at the top of the page, in red, until you create your user page. Click on your username to do that.
  2. On your page, add some sections as given below, as it is your profile on the OpenOffice Wiki;
    • About yourself
    • OpenOffice and you
    • Your contributions
    • Work in progress
    • Any future plans?
    • Reference (optional)
    • Contact

So, this is somewhat of a template, for creating a profile. You may or may not need to follow this template, you may have sections of your choice. This is done to make a uniform profile for all the new users.

Adding Comments

Important comments should be announced on the mailing list doc@openoffice.apache.org to be sure that they get noticed.

To add a comment to a page

  1. Click the Discussion tab on the top of the page.
    • If you are starting a new topic click on the + sign to the right of the edit tab at the top, fill in the subject line and write your comment in the main text box.
    • If you want to add a comment to an existing discussion leave it after the existing comments and indent it by putting one or more colons (:) at the beginning of each paragraph.
  2. Sign your username with four tildes (~~~~). You can do this automatically with the signature with timestamp button ( button_sig.png ) on the toolbar.
  3. Click Save Page.

To learn more about comments see the Mediawiki help about talk pages

Structure of the Documentation Section of the Wiki

The Documentation section is just one part of the large Apache OpenOffice Wiki. The project tries to present the information in this section in a way that it is easily accessible and has a structure that allows straightforward navigation for both users and contributors.

All documentation pages are subpages of the main Documentation page. A further substructure presents sections as subpages containing further subpages. Think of it as a hierarchical representation, just like a filesystem. Every subpage is automatically linked back to the main page.

The current wiki page tree looks like this:

Subpage Description
Documentation/Dashboard High-level tracking of documentation sub-projects and content deliverables
Documentation/Administration Guide Guide that describes how to administer an Apache OpenOffice network installation
Documentation/FAQ Collection of FAQs.
Documentation/How Tos Link collection of How Tos
Documentation/OOoAuthors User Manual Collection of OpenOffice.org 2.x User Guides from OOoAuthors
Documentation/OOo3 User Guides Collection of OpenOffice.org 3 User Guides from OOoAuthors
Documentation/AOO4_User_Guides/AOO4.1_User_Guide_Chapters Collection of Apache OpenOffice User Guides
Documentation/Tutorials Tutorial collections from different contributors
Documentation/Samples, Templates and Clipart Sub-project page in order to provide usable templates for business and personal use (draft)
Documentation/Setup Guide Sub-project page in order to provide a guide through the setup process of Apache OpenOffice (in progress)
Documentation/BASIC Guide Guide that provides an introduction to programming with Apache OpenOffice BASIC
Documentation/Building Guide Guide that describes how to build the Apache OpenOffice software yourself, from source.
Documentation/DevGuide Guide that describes how to program with Apache OpenOffice using the component technology UNO (Universal Network Objects) with Apache OpenOffice.
Documentation/Reference Collection of reference material. References on this page should show up under Reference Lists at the Documentation main page.

Creating new Pages

Documentation caution.png Before creating a page make sure that there is not already an existing page with a similar topic.
  • If the new page can be a subpage of an existing page simply go to the existing page and create a link to the new page. After saving the page with the link you can click the link and start writing on your new page.
  • If you want to create a really new page for the Documentation project, you can use the wiki's URL for creating a new page. You should observe the wiki page tree when you create a new page in this way. The URL to a wiki page is then something like this:
    https://wiki.openoffice.org/wiki/Documentation/Page Name
  • However, the recommended method is to search for the desired page name (in the Search field above left), and when the page does not exist, you will be offered to "create this page" by clicking on a link on the Search Results Page.
Documentation note.png The URL approach is only useful if you link the page later to other pages. Otherwise it will be hidden in the wiki.

For more information about new pages see the Mediawiki help about new pages

Using Categories

The Categories that are assigned to a page are usually listed at the bottom of the page. Click on a Category, and you will view a topic page with all the pages that have been classified in that Category. This way, a Category tag in a page gives you the opportunity to look up related contents. The bigger the page the more Category tags might be inserted

To add a Category tag to a page

  1. Click Special pages in the toolbox on the left side.
  2. Click Categories in the Special pages link list.
  3. Choose a Category name that makes sense, and apply it by adding [[Category:''Category Name'']] at the end of the page.
Documentation caution.png Do not create duplicate Categories for the same topic. Each Category must be unique. Otherwise it will be difficult to use the Categories for searching the wiki.

Look at MediaWiki Help:Categories if you want to know more about Wiki Categories.

A simple example of how to use Categories in Wiki books:

  1. Create a Category named after the current chapter.
  2. Add the new Category tag to all pages of that chapter
  3. Add the Category tag for the book to the newly created Category page.

The reader can then view the book Category. The book Category shows all the chapters in the book. If the reader clicks on a chapter Category, they can see all of the pages in that chapter (in alphabetical order).

Do not add a category and its subcategory to the same wiki page. For more information see the MediaWiki Help:Category section on Category considerations.

You can use Templates to add a common category to a large group of pages, but it is not recommended. It may appear to save time, but "adding or deleting a category tag in the template does not add or delete the listings on the category page of pages that use the template, until some edit is made in the page that uses the template." For more information, see the MediaWiki Help:Category section on Using templates to populate categories.

Templates

Look at the Templates help if you are unfamiliar with mediawiki templates.

Adding a new Documentation Template

  • If you create a new template to be used in the wiki documentation, name it as a subpage of Documentation.
    • wrong: mytemplate
    • right: Documentation/mytemplate
  • Add a description of the template purpose and usage to the template itself using the element as described in MediaWiki help: Template.
  • Add the template to the list of templates below.

List of Existing Documentation Templates

This is a list of Documentation templates and their usage
Template Name Usage Example
Template:Mt Service template for marking multilingual templates. {{Mt|EN}}

This template itself is also multilanguage.

Displays the following message:

Multilingual template

Go to the template page to view available localizations.


Template:Revision

Multilingual template

Go to the template page to view available localizations.


This template is intended to mark pages that need revision. {{Revision|EN}}

Template:DocBanner Puts the Documentation Project "Banner" at the top right of the page

{{DocBanner}}

Docbanner.png
Template:OOoLogo Displays an OpenOffice.org logo

{{OOoLogo}}

Ooo.png
Template:PDF {{PDF}} Pdf.png
Template:PRODUCTNAME A variable for displaying the string OpenOffice.org.

{{PRODUCTNAME}}

OpenOffice.org
Template:OOo A variable for displaying the string Apache OpenOffice.

{{OOo}} - Do not use anymore, use {{AOo}} instead

Apache OpenOffice
Template:AOo A variable for displaying the string Apache OpenOffice

{{AOo}}

Apache OpenOffice
Template:Bar Used to draw horizontal bars for simplistic bar charts

{{Bar|100|10|#3333FF}}
{{Bar|57|10|#33FF33}}
{{Bar|112|10|#FF3333}}

Template:BeingEdited

Multilingual template

Go to the template page to view available localizations.


Marks a page as currently being edited to avoid conflicting changes. Use this template when you perform larger edits on a file that may even take more than one session to finish. Be sure to add name and date of "locking" by adding a ~~~~ as parameter: {{BeingEdited|EN|А. Е. Харламенков (talk) 10:40, 6 July 2018 (UTC)|1}}

Documentation beingedited.png This page is currently being edited Fpe 17:54, 7 February 2008 (CET)

 

Template:NeedsRework

Multilingual template

Go to the template page to view available localizations.


Marking an article to check for accuracy and consistency with the style. {{NeedsRework|EN}}

Edit-find-replace.png This article should be checked for accuracy and conformity to style.

Template:HelpNeeded

Multilingual template

Go to the template page to view available localizations.


{{HelpNeeded|EN|Check the spelling}}

Documentation needshelp.png This article needs help

Check the spelling

 

Template:Old

Multilingual template

Go to the template page to view available localizations.


Identifies a page that is obsolete {{Old|EN}}

Book-old.png    This article is outdated.    
 
Template:DraftPage

Multilingual template

Go to the template page to view available localizations.


Marks up pages that are in a draft state {{DraftPage|EN}}

Editing.png This page is in a DRAFT stage.

 

Template:CoreCriticalTemplate This template is intended to mark the Core Critical Template, unconsidered intervention in the template may result in the destruction of the entire project!

{{CoreCriticalTemplate}}

CoreCriticalTemplate.png  Критически важный опорный шаблон    —    Core Critical Template.  

Необдуманное вмешательство в шаблон может повлечь за собой разрушение всего проекта! Unconsidered intervention in the template may result in the destruction of the entire project!

 

Template:Imported

Multilingual template

Go to the template page to view available localizations.


{{Imported|EN|Author Name|Contributor Names}}

This article was imported from another document. Original author: Author Name - Previous contributors: Contributor Names
Template:Win Displays a Windows logo and allows to enter Windows specific content.

{{Win|Windows related content}}

Documentation windows.png Windows related content
Template:Lin Displays a Linux logo and allows to enter Linux specific content.

{{Lin|Linux related content}}

Documentation linux.png Linux related content
Template:Mac Displays an Apple/OSX logo and allows to enter OSX specific content

{{Mac | Mac related content}}

Documentation Mac Logo 40.png Mac related content
Template:Bug Links to Bugzilla issue.

{{Bug|123456}}

Issue 123456
Template:Note Takes sections containing notes, i.e. related, reinforcing information, for example, an explanation or comment.

{{Note|Notable stuff}}

Documentation note.png Notable stuff
Template:Tip Takes sections containing tips, i.e. useful non-crucial information, for example, a keyboard shortcut.

{{Tip|Right-click opens the context menu}}

Tip.png Right-click opens the context menu
Template:Warn Takes sections containing warnings, i.e. information that is potentially harmful in some way, for example, data loss.

{{Warn|Always switch off power before opening the case.}}

Documentation caution.png Always switch off power before opening the case.
Template:SeeAlso

Multilingual template

Go to the template page to view available localizations.


{{SeeAlso|EN|

See Also


Template:HeaderBlock Ornamental template.

Designed to process the most important links in the form of the similarity of a button. {{HeaderBlock|Documentation}}

Template:FromForum

Multilingual template

Go to the template page to view available localizations.


{{FromForum|EN}}

Contents of this article derived from the OpenOffice User Forum.

Template:Documentation/*TOC Several tables of content based on Template:Documentation/MasterTOC used in guides. See, for example, the Basic Guide TOC
Template:Documentation/MasterTOC This is the master template that is used to create tables of content. For usage, click the template name.
Template:OOoVersion

Multilingual template

Go to the template page to view available localizations.


This template is used to insert an OpenOffice.org version box on a page. Multilingual templates. This template is designed to be inserted into the article notes about the version of OpenOffice.org, to which the article. {{OOoVersion|EN|1.1.x}}

Version Apache OpenOffice 1.1.x

Template:AOoVersion

Multilingual template

Go to the template page to view available localizations.


This template is used to insert an Apache OpenOffice version box on a page. {{AOoVersion|EN|4.1.x}}

Version Apache OpenOffice 4.1.x

Template:OOoW This template is used to insert an Apache OpenOffice Writer string in text.

{{OOoW}}
{{OOoW|1}}

Apache OpenOffice Writer
Writer
Template:OOoC This template is used to insert an Apache OpenOffice Calc string in text.

{{OOoC}}
{{OOoC|1}}

Apache OpenOffice Calc
Calc
Template:OOoCh This template is used to insert an Apache OpenOffice Chart string in text.

{{OOoCh}}
{{OOoCh|1}}

Apache OpenOffice Chart
Chart
Template:OOoI This template is used to insert an Apache OpenOffice Impress string in text.

{{OOoI}}
{{OOoI|1}}

Apache OpenOffice Impress
Impress
Template:OOoD This template is used to insert an Apache OpenOffice Draw string in text.

{{OOoD}}
{{OOoD|1}}

Apache OpenOffice Draw
Draw
Template:OOoB This template is used to insert an Apache OpenOffice Base string in text.

{{OOoB}}
{{OOoB|1}}

Apache OpenOffice Base
Base
Template:OOoM This template is used to insert an Apache OpenOffice Math string in text.

{{OOoM}}
{{OOoM|1}}

Apache OpenOffice Math
Math
Template:POOo This template is used to insert an Portable OpenOffice.org

string in text. {{POOo}}

Portable OpenOffice.org
Template:SRB This template is used to insert an 'Sun Report Builder' string in text.

{{SRB}}
{{SRB|1}}

Sun Report Builder
Sun Report Builder
Template:MSO This template is used to insert an Microsoft Office string in text.

{{MSO}}

Microsoft Office
Template:MSO2003 This template is used to insert an Microsoft Office 2003 string in text.

{{MSO2003}}
{{MSO2003|1}}

Microsoft Office 2003
MSO 2003
Template:MSO2010 This template is used to insert an Microsoft Office 2010 string in text.

{{MSO2010}}
{{MSO2010|1}}

Microsoft Office 2010
MSO 2010
Template:MSW This template is used to insert an MS Word string in text.

{{MSW}}
{{MSW|1}}

MS Word
Word
Template:MSE This template is used to insert an MS Excel string in text.

{{MSE}}
{{MSE|1}}

MS Excel
Excel
Template:MSA This template is used to insert an MS Access string in text.

{{MSA}}
{{MSA|1}}

MS Access
Access
Template:MSPP This template is used to insert an MS Power Point string in text.

{{MSPP}}
{{MSPP|1}}

MS Power Point
Power Point
Template:MSEq This template is used to insert an MS Equation string in text.

{{MSEq}}
{{MSEq|1}}

MS Equation
Equation
Template:MSV This template is used to insert an MS Visio string in text.

{{MSV}}
{{MSV|1}}

MS Visio
Visio
Template:Key This template is used to insert keycodes in text.

{{Key|Ctrl|Shift|>}}

 Ctrl  +  ⇧ Shift  +  → 
Template:Button This template is used to insert an article in the notation of buttons on-screen dialogues.

{{Button|Ok}}

 Ok 
Template:QuoteEn The template is designed for inserting quotations in the text.

{{QuoteEn|quote=OpenOffice.org 3 is the leading open-source office software suite for word processing, spreadsheets, presentations, graphics, databases and more.|author=why.openoffice.org}}

Quote bg.pngOpenOffice.org 3 is the leading open-source office software suite for word processing, spreadsheets, presentations, graphics, databases and more.

why.openoffice.orgQuote bg2.png

Template:Menu This template is designed to insert text anywhere in the chain menu.

{{Menu|File|Open|Print|и т. д.}}

File → Open → Print → 4 → 5 → 6 → 7 → 8 → 9 → 10
Template:Path This template using to format file system path.

{{Path|C:\Program files(x86)\OpenOffice 4}}

C:\Program files (x86)\OpenOffice 4


Graphical Content

General guidelines for images are:

  • Use a descriptive and unique title. The filename should be constructed in a way so it shows the usage, e.g. Doc_mig_icon_data.png = Documentation image, used in the migration guide, depicting the database icon.
  • If possible, do not pre-scale the images you are uploading. You can use the MediaWiki image thumbnail feature to scale the image.
  • Edit the image if necessary to make sure that the important part is clear and visible.
  • Keep in mind that people may be translating the page where you are placing an image. Try not to include callouts or other extra text on the image.
  • JPG is usually best for photos, SVG, for icons, logos etc, and PNG for screen captures. Try not to use BMP.


Before you can insert your well prepared image in a wiki page you have to upload it.

  1. In the sidebar, under toolbox, click Upload file. The image description page will appear.
  2. Use the image description page to describe an image and copyright status (if any).


To place the image on a page you can use the MediaWiki Image thumbnail feature which "wraps" your illustrations in an image box. This image box includes a spot for an image caption. The syntax is [[Image:''image.png|thumb|position|size|Image caption'']], where:

  • thumb = thumbnail the image and wrap in an image box
  • position = position on page. "none" places the image on the left of the frame with no text wrapping. "left" and "right" places the image on the left or right of the page with full text wrapping.
  • size = max width in pixels for the image. If the image is larger than this value it is scaled down. If the image is smaller it is left as is.

If you do not declare a position and size, the image is scaled to a small thumbnail, and defaults to the right hand side of the page with full text wrapping.

Here is an example using [[Image:LoadSaveOptions_AOO.png|thumb|none|500px|An example image caption]]

An example image caption
  • How to handle image and table numbering?

Linking

Although the editing window offers assistence in writing internal and external links look at the MediaWiki help page about links for a better understanding of how links are working in wikis.

There is another MediaWiki help page if you need some examples.

When creating link text consider the guidelines for using links in our style guide.

General Editing Work

Editing is only possible after login. You can start editing the whole page after clicking the edit tab at the top. But usually it is more comfortable to edit individual sections of a page by clicking one of the [edit] links on the right side. If you make changes, please consider the rules of the style guide to assure a consistent writing style. Click the Show preview button before you save the page finally.

Fixing inappropriate, inaccurate, or outdated content

Contents that are not up to date are usually marked by one of the following labels:

Book-old.png    This article is outdated.    
  		This label means that an article is outdated as a whole and needs to be revised completely.

Documentation needshelp.png This article needs help

works for OOo 2, needs to be confirmed for OOo 3

 

If an article is partly outdated or inaccurate you may find this label asking for specific help.

Edit-find-replace.png This article should be checked for accuracy and conformity to style.

You can find a collection of pages with this label if you click on Pages that Need Help! on the Wiki main page.

When you have selected a page to work on

  1. test whether the described procedures are still valid for the current version of Apache OpenOffice.
  2. log in and make the necessary corrections.

This works best when you open two tabs in the browser, one for reading the procedures and another for editing.

When you have finished, remove the above label(s), mark the page with the label "Checked for technical accuracy" (as described in the Templates section above), and click Save page.

Fixing minor errors and typos

If you detect minor errors like typos, just log in and edit the article. Before clicking on the Save page button you might check the This is a minor edit box above.

Fixing graphics and screenshots

To edit a graphic in the wiki, right-click the graphic and choose Save image as. When you have edited the graphic on your computer, go back to the wiki page, click the graphic, and in the image description page choose Upload a new version of this file.

If you have created a new version of a screenshot, directly click the corresponding screenshot in the wiki and then Upload a new version of this file in the image description page.

Fixing Style and Language

Articles that need improvement in style and language might be recognized by the following labels:

Documentation needshelp.png This article needs help

Check the spelling

 


Edit-find-replace.png This article should be checked for accuracy and conformity to style.

You can find a collection of articles with the latter label if you click on Pages that Need Help! on the Wiki main page.

To improve such an article, just log in, click on the edit tab and make the necessary corrections. Then remove the label(s) and click on Save page.

Linking to localized pages

  • Link the various languages to each other using the Interwiki links syntax [[ISO_Lang_code:Page_Title]].
    For example, [[zh:Zh/Documentation/DevGuide/OpenOffice.org_Developers_Guide]] adds a link to the Chinese translation of the first page of the Developer's Guide. This link shows in the left column, under the heading "In other languages". This may be more practical to do with Wiki Templates as more languages are added.
  • In the Developer's guide we use a template to link translated pages.
    The Wiki Syntax is: {{Documentation/DevGuideLanguages|Page_Title}} where Page_Title is the current Wiki page name.
    For example, {{Documentation/DevGuideLanguages|Documentation/DevGuide/OpenOffice.org Developers Guide}} will add the localized page links for the first page in the Developer's Guide.
    If you want to see a link to your language at the Developer's Guide wiki pages simply add your language to the template Template:Documentation/DevGuideLanguages. For example, for Dutch you would have to add [[nl:NL/{{{1}}}]]. Make sure the template is referenced correctly in each of the translated pages.

Validating Content

Fixing Spam / Deleting Pages

If you detect spam you can send an email to the dev@ list.

There is also a list of Wiki Sysops (people who can delete pages). If you want to have pages deleted, you can either ask someone from that list, or better, add the Wiki Syntax {{delete}} anywhere on the page you want to be deleted. This will add the page to the "Candidates for speedy deletion" category, and the page will be deleted by someone with Sysop privileges, or by WikiBot maintenance.

It is a good idea to indicate the reason for deleting a page; the Wiki Syntax is {{delete|justification}}.

Working on FAQs

Every question together with its answer is displayed on one single wiki page.

If you want to insert a new FAQ entry, that is, a pair of a question together with the corresponding answer:

  1. Select a FAQ section on the main page of the Documentation Wiki. In Writer and Calc you have to select another subpage until you reach a final FAQ section.
  2. Scroll down to the Insert New FAQ listbox.
  3. Replace the text in the listbox after the last slash '/' with your question.
  4. Click Add New FAQ
    A new wiki page will be created and preloaded with a template for a Q/A pair: 
    {{{DISPLAYTITLE: (INSERT FAQ TITLE)}}

<section begin=question/>
<INSERT QUESTION>
<section end=question/>

<section begin=answer/>
<INSERT ANSWER>
<section end=answer/>

[[Category:Documentation/FAQ/<INSERT FAQ SECTION>]]
  5. Replace (INSERT FAQ TITLE) with the title of the FAQ to be displayed on the page. This may be a short version of the question or the question itself.
  6. Replace <INSERT QUESTION> with the actual question.
  7. Replace <INSERT ANSWER> with the actual answer.
  8. Replace <INSERT FAQ SECTION> with the current FAQ section name. This category assignment determines where this wiki page will appear. Please use the following section names:
    9. FAQ section section name in category
    General General
    Installation Installation
    Word Processing Writer
    Automatic Functions Writer/AutomaticFunctions
    Document Management Writer/DocumentManagement
    Formatting Pages and Docs Writer/FormattingPagesAndDocuments
    Formatting Text Writer/FormattingText
    Graphics, Frames & Objects Writer/GraphicsFramesObjects
    Indexes, Tables of Contents Writer/IndexToc
    Printing and Mail Merge Writer/Printing
    Spreadsheets Calc
    Drawings Draw
    Presentations Impress
    Formula Editor Formula
    Database Databases
    Macros Macros
  9. Click Save Page.

Working on How Tos

If you want to create a new How To

  1. Go to the How Tos section and open the edit window.
  2. Identify the adequate subsection and enter the title of your How To as a link.
  3. Click Save Page to make the link visible.
  4. Click the link to your How To and start writing by using the rules of the style guide. If you are not sure about how to implement the style guide, have a look at the Writer How To Getting a Picture Into the Gallery.
Documentation note.png Always put the license link at the end of your article: Simply insert {{PDL1}}.

You can also create How Tos by writing a new page like Documentation/How Tos/Page Name with one or more specific categories. The newly created How To page will then be assigned to the corresponding How To sections. The available categories for that are the following:

  • [[Category:Documentation/How Tos/Installation]]
  • [[Category:Documentation/How Tos/Writer]]
  • [[Category:Documentation/How Tos/Impress]]
  • [[Category:Documentation/How Tos/Calc]]
  • [[Category:Documentation/How Tos/Database]]


If you want to revise existing How Tos, watch for the label "This article needs to be checked for accuracy and style."

  • Test whether the described procedures are still valid for the current version of OpenOffice.org,
  • check whether the rules of the style guide are applied,
  • check for grammar and spelling mistakes,

and make the necessary corrections in the edit window.

When you have finished, mark the page with the label "Checked for technical accuracy" as described in the Templates section above, and click Save page.

Do not forget to notify doc@openoffice.apache.org about your work on the How Tos.

Working on Guides

Currently, there are the following guides on the wiki:

There is some help available about Contributing to the Developer's Guide which may also be useful for the Administration Guide and the BASIC Programming Guide.

Localizing Content

Here are some general guidelines for translations:

  • If possible, follow the same structure as the original page.
  • If possible, do not translate the Wiki page names. Use the {{DISPLAYTITLE:Page title}} to localize the page name. Using the same page name makes it easier to identify translated pages and easier to automatically link from one page to another
  • Use a subpage naming structure that clearly indicates the language of the page. For example, the Swedish version of a page could use SV/Pagename/. See Help:Page naming
Documentation note.png If possible, try to always use all-caps for the ISO language code.
  • Communicate with the L10N and NLC communities and let them know what you're doing.
  • If in doubt, ask. The Documentation, and NLC communities are here to help you.

The Apache OpenOffice L10N community is working on a process and toolset for translating Wiki pages.

Translation steps

There are (currently) no tools or mechanisms in place in the Wiki to assist with translations. The basic translation process is:

  1. Identify a page that is to be translated.
  2. Click Edit on that page.
  3. Select all Wiki text in that page and copy it.
  4. Cancel the edit.
  5. Start a new page with the right page name for the new translated article (see Help:Page naming).
  6. Paste in the copied original language text.
  7. Click Save Page to give yourself a start point.
  8. Translate the text on the newly created page.


Content on this page is licensed under the Public Documentation License (PDL).
Retrieved from "https://wiki.openoffice.org/w/index.php?title=Documentation/Dashboard/Wiki_Editing_Policy&oldid=250751"
Personal tools