View source for Documentation/Dashboard/Wiki Editing Policy

From Apache OpenOffice Wiki

← Documentation/Dashboard/Wiki Editing Policy

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in the group: Users.
• You must confirm your email address before editing pages. Please set and validate your email address through your user preferences.

---

You can view and copy the source of this page:

[[ru:RU/wiki_editing_policy|Политика Wiki-редактирования]] [[fr:FR/Documentation/Dashboard/Wiki_Editing_Policy]] [[oc:OC/Documentation/TableuBord/Organizacion|Estructura del Wiki Documentacion]] [[es:ES/AyudaWiki/Plantillas]] {{DocBanner}} {{DISPLAYTITLE:Wiki Editing Policy}} 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 [mailto:doc@openoffice.apache.org doc@openoffice.apache.org]. = Project-independent ruleset = {{Note|See the general project-independent rules at [[OOo_Wiki_Contribution_Rules|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. # Click on '''Log in / create account''' in the upper right corner of the screen and enter the required bits. # 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. {{Warn | 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. #When you are logged in, your username shows at the top of the page, <span style="color:#9F0000"> in red,</span> until you create your user page. Click on your username to do that. #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 [mailto:doc@openoffice.apache.org doc@openoffice.apache.org] to be sure that they get noticed. To add a comment to a page # 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 (<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 ( https://wiki.openoffice.org/w/skins/common/images/button_sig.png ) on the toolbar. # Click '''Save Page'''. 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= 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 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: {|border=1 style="border-collapse:collapse;" cellpadding=3 cellspacing=4 |- !Subpage!!Description |- |[[Documentation/Dashboard]] |High-level tracking of documentation sub-projects and content deliverables |- |[[Documentation/Administration Guide]] |Guide that describes how to administer an {{AOo}} 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 {{AOo}} (in progress) |- |[[Documentation/BASIC Guide]] |Guide that provides an introduction to programming with {{AOo}} BASIC |- |[[Documentation/Building Guide]] |Guide that describes how to build the {{AOo}} software yourself, from source. |- |[[Documentation/DevGuide]] |Guide that describes how to program with {{AOo}} using the component technology UNO (Universal Network Objects) with {{AOo}}. |- |[[Documentation/Reference]] |Collection of reference material. References on this page should show up under '''Reference Lists''' at the Documentation main page. |} =Creating new Pages= {{Warn | 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: <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. {{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 [https://www.mediawiki.org/wiki/Help:Starting_a_new_page 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 # Click '''Special pages''' in the toolbox on the left side. # Click '''Categories''' in the Special pages link list. # Choose a Category name that makes sense, and apply it by adding <tt><nowiki>[[Category:''Category Name'']]</nowiki></tt> at the end of the page. {{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 [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: # Create a Category named after the current chapter. # Add the new Category tag to all pages of that chapter # 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 [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 [https://meta.wikimedia.org/wiki/Help:Category#Using_templates_to_populate_categories Using templates to populate categories]. =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== <section begin=addingtemplate /> * If you create a new template to be used in the wiki documentation, name it as a subpage of '''Documentation'''. ** wrong: <tt>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 [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. <section end=addingtemplate /> {{Spacer|30}} == List of Existing Documentation Templates == <section begin="doctemplates" /> This is a list of Documentation templates and their usage {| cellspacing="4" cellpadding="3" border="1" style="border-collapse: collapse;" |- ! Template Name ! Usage ! Example |- | [[Template:Mt]] | Service template for marking multilingual templates. {{Tlp|Mt|EN}} '''This template itself is also multilanguage.''' Displays the following message: | {{Mt|EN}} |- | [[Template:Revision]] | {{Mt|EN}} This template is intended to mark pages that need revision. {{Tlp|Revision|EN}} | {{Revision|EN}} |- | [[Template:DocBanner]] | Puts the Documentation Project "Banner" at the top right of the page {{Tlp|DocBanner}} | [[Image:Docbanner.png]] |- | [[Template:OOoLogo]] | Displays an OpenOffice.org logo {{Tlp|OOoLogo}} | {{OOoLogo}} |- | [[Template:PDF]] | {{Tlp|PDF}} | {{PDF}} |- | [[Template:PRODUCTNAME]] | A variable for displaying the string '''OpenOffice.org'''. {{Tlp|PRODUCTNAME}} | {{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]] | A variable for displaying the string '''Apache OpenOffice''' {{Tlp|AOo}} | {{AOo}} |- | [[Template:Bar]] | Used to draw horizontal bars for simplistic bar charts {{Tlp|Bar|100|10|#3333FF}}<br> {{Tlp|Bar|57|10|#33FF33}}<br> {{Tlp|Bar|112|10|#FF3333}} | {{Bar|100|10|#3333FF}} {{Bar|57|10|#33FF33}} {{Bar|112|10|#FF3333}} |- | [[Template:BeingEdited]] | {{Mt|EN}} 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 <tt><code><nowiki>~~~~</nowiki></code></tt> as parameter: {{Tlp|BeingEdited|EN|[[User:Sancho|А. Е. Харламенков]] ([[User talk:Sancho|talk]]) 10:40, 6 July 2018 (UTC)|1}} | {{BeingEdited|EN|[[User:Fpe|Fpe]] 17:54, 7 February 2008 (CET)|1}} |- | [[Template:NeedsRework]] | {{Mt|EN}} Marking an article to check for accuracy and consistency with the style. {{Tlp|NeedsRework|EN}} | {{NeedsRework|EN|1}} |- | [[Template:HelpNeeded]] | {{Mt|EN}} {{Tlp|HelpNeeded|EN|Check the spelling}} | {{HelpNeeded|EN|Check the spelling|1}} |- | [[Template:Old]] | {{Mt|EN}} Identifies a page that is obsolete {{Tlp|Old|EN}} | {{Old|EN|1}} |- | [[Template:DraftPage]] | {{Mt|EN}} Marks up pages that are in a draft state {{Tlp|DraftPage|EN}} | {{DraftPage|EN|1}} |- | [[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! {{Tlp|CoreCriticalTemplate}} | {{CoreCriticalTemplate|1}} |- | [[Template:Imported]] | {{Mt|EN}} {{Tlp|Imported|EN|Author Name|Contributor Names}} | {{Imported|EN|Author Name|Contributor Names}} |- | [[Template:Win]] | Displays a Windows logo and allows to enter Windows specific content. {{Tlp|Win|Windows related content}} | {{Win|Windows related content}} |- | [[Template:Lin]] | Displays a Linux logo and allows to enter Linux specific content. {{Tlp|Lin|Linux related content}} | {{Lin|Linux related content}} |- | [[Template:Mac]] | Displays an Apple/OSX logo and allows to enter OSX specific content {{Tlp|Mac | Mac related content}} | {{Mac | Mac related content}} |- | [[Template:Bug]] | Links to Bugzilla issue. {{Tlp|Bug|123456}} | {{Bug|123456}} |- | [[Template:Note]] | Takes sections containing notes, i.e. related, reinforcing information, for example, an explanation or comment. {{Tlp|Note|Notable stuff}} | {{Note|Notable stuff}} |- | [[Template:Tip]] | Takes sections containing tips, i.e. useful non-crucial information, for example, a keyboard shortcut. {{Tlp|Tip|Right-click opens the context menu}} | {{Tip|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. {{Tlp|Warn|Always switch off power before opening the case.}} | {{Warn|Always switch off power before opening the case.}} |- | [[Template:SeeAlso]] | {{Mt|EN}} {{Tlp|SeeAlso|EN| * [[Documentation/OOo3_User_Guides/Getting_Started|Getting Started with OpenOffice.org 3.x]] * DevGuide/SeeAlso version is used in the Developer's Guide and is set to be excluded from generated PDF and ODT books.}} | {{SeeAlso|EN| * [[Documentation/OOo3_User_Guides/Getting_Started|Getting Started with OpenOffice.org 3.x]] * DevGuide/SeeAlso version is used in the Developer's Guide and is set to be excluded from generated PDF and ODT books. }} |- | [[Template:HeaderBlock]] | Ornamental template. Designed to process the most important links in the form of the similarity of a button. {{Tlp|HeaderBlock|[[Documentation]]}} | {{HeaderBlock|[[Documentation]]}} |- | [[Template:FromForum]] | {{Mt|EN}} {{Tlp|FromForum|EN}} | {{FromForum|EN}} |- | Template:Documentation/*TOC | Several tables of content based on [[Template:Documentation/MasterTOC]] used in guides. | See, for example, the [[Template:Documentation/BASICGuideTOC/v2|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]] | {{Mt|EN}} 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. {{Tlp|OOoVersion|EN|1.1.x}} | {{OOoVersion|EN|1.1.x}} |- | [[Template:AOoVersion]] | {{Mt|EN}} This template is used to insert an Apache OpenOffice version box on a page. {{Tlp|AOoVersion|EN|4.1.x}} | {{AOoVersion|EN|4.1.x}} |- | [[Template:OOoW]] | This template is used to insert an '''{{OOoW}}''' string in text. {{Tlp|OOoW}}<br>{{Tlp|OOoW|1}} | {{OOoW}}<br>{{OOoW|1}} |- | [[Template:OOoC]] | This template is used to insert an '''{{OOoC}}''' string in text. {{Tlp|OOoC}}<br>{{Tlp|OOoC|1}} | {{OOoC}}<br>{{OOoC|1}} |- | [[Template:OOoCh]] | This template is used to insert an '''{{OOoCh}}''' string in text. {{Tl|OOoCh}}<br>{{Tlp|OOoCh|1}} | {{OOoCh}}<br>{{OOoCh|1}} |- | [[Template:OOoI]] | This template is used to insert an '''{{OOoI}}''' string in text. {{Tlp|OOoI}}<br>{{Tlp|OOoI|1}} | {{OOoI}}<br>{{OOoI|1}} |- | [[Template:OOoD]] | This template is used to insert an '''{{OOoD}}''' string in text. {{Tlp|OOoD}}<br>{{Tlp|OOoD|1}} | {{OOoD}}<br>{{OOoD|1}} |- | [[Template:OOoB]] | This template is used to insert an '''{{OOoB}}''' string in text. {{Tlp|OOoB}}<br>{{Tlp|OOoB|1}} | {{OOoB}}<br>{{OOoB|1}} |- | [[Template:OOoM]] | This template is used to insert an '''{{OOoM}}''' string in text. {{Tlp|OOoM}}<br>{{Tlp|OOoM|1}} | {{OOoM}}<br>{{OOoM|1}} |- | [[Template:POOo]] | This template is used to insert an '''{{POOo}}''' string in text. {{Tlp|POOo}} | {{POOo}} |- | [[Template:SRB]] | This template is used to insert an '''{{SRB}}''' string in text. {{Tlp|SRB}}<br>{{Tlp|SRB|1}} | {{SRB}}<br>{{SRB|1}} |- | [[Template:MSO]] | This template is used to insert an '''Microsoft Office''' string in text. {{Tlp|MSO}} | {{MSO}} |- | [[Template:MSO2003]] | This template is used to insert an '''Microsoft Office 2003''' string in text. {{Tlp|MSO2003}}<br>{{Tlp|MSO2003|1}} | {{MSO2003}}<br>{{MSO2003|1}} |- | [[Template:MSO2010]] | This template is used to insert an '''Microsoft Office 2010''' string in text. {{Tlp|MSO2010}}<br>{{Tlp|MSO2010|1}} | {{MSO2010}}<br>{{MSO2010|1}} |- | [[Template:MSW]] | This template is used to insert an '''MS Word''' string in text. {{Tlp|MSW}}<br>{{Tlp|MSW|1}} | {{MSW}}<br>{{MSW|1}} |- | [[Template:MSE]] | This template is used to insert an '''MS Excel''' string in text. {{Tlp|MSE}}<br>{{Tlp|MSE|1}} | {{MSE}}<br>{{MSE|1}} |- | [[Template:MSA]] | This template is used to insert an '''MS Access''' string in text. {{Tlp|MSA}}<br>{{Tlp|MSA|1}} | {{MSA}}<br>{{MSA|1}} |- | [[Template:MSPP]] | This template is used to insert an '''MS Power Point''' string in text. {{Tlp|MSPP}}<br>{{Tlp|MSPP|1}} | {{MSPP}}<br>{{MSPP|1}} |- | [[Template:MSEq]] | This template is used to insert an '''MS Equation''' string in text. {{Tlp|MSEq}}<br>{{Tlp|MSEq|1}} | {{MSEq}}<br>{{MSEq|1}} |- | [[Template:MSV]] | This template is used to insert an '''{{MSV}}''' string in text. {{Tlp|MSV}}<br>{{Tlp|MSV|1}} | {{MSV}}<br>{{MSV|1}} |- | [[Template:Key]] | This template is used to insert keycodes in text. {{Tlp|Key|Ctrl|Shift|>}} | {{Key|Ctrl|Shift|>}} |- | [[Template:Button]] | This template is used to insert an article in the notation of buttons on-screen dialogues. {{Tlp|Button|Ok}} | {{Button|Ok}} |- | [[Template:QuoteEn]] | The template is designed for inserting quotations in the text. {{Tlp|QuoteEn|quote&#61;OpenOffice.org 3 is the leading open-source office software suite for word processing, spreadsheets, presentations, graphics, databases and more. |author&#61;why.openoffice.org}} | {{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}} |- | [[Template:Menu]] | This template is designed to insert text anywhere in the chain menu. {{Tlp|Menu|File|Open|Print|4|5|6|7|8|9|10}} | {{Menu|File|Open|Print|4|5|6|7|8|9|10}} |- | [[Template:Path]] | This template using to format file system path. {{Tlp|Path|C:\Program files(x86)\OpenOffice 4}} | {{Path|C:\Program files (x86)\OpenOffice 4}} |} <section end="doctemplates" /> =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 = '''Doc'''umentation image, used in the '''mig'''ration guide, depicting the '''data'''base '''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. # In the sidebar, under '''toolbox''', click '''Upload file'''. The image description page will appear. # 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 <tt><nowiki>[[Image:''image.png|thumb|position|size|Image caption'']]</nowiki></tt>, 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 <tt><nowiki>[[Image:LoadSaveOptions_AOO.png|thumb|none|500px|An example image caption]]</nowiki></tt> [[Image:LoadSaveOptions_AOO.png|thumb|none|500px|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 [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 [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. =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 [[Documentation/Dashboard/Help_Style_Guide | 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: {|border=1 style="border-collapse:collapse;" cellpadding=3 cellspacing=4 |- valign=top | {{Old|EN|1}} | This label means that an article is outdated as a whole and needs to be revised completely. |- valign=top | {{HelpNeeded|EN|works for OOo 2, needs to be confirmed for OOo 3|1}} | If an article is partly outdated or inaccurate you may find this label asking for specific help. |- valign=top | {{NeedsRework|EN|1}} | You can find a collection of pages with this label if you click on [[:Category:NeedsRework|Pages that Need Help! ]] on the Wiki main page. |} When you have selected a page to work on #test whether the described procedures are still valid for the current version of {{AOo}}. #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 [[Documentation/Dashboard/Wiki Editing Policy#List_of_Existing_Documentation_Templates|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: {{HelpNeeded|EN|Check the spelling|1}} {{NeedsRework|EN|1}} You can find a collection of articles with the latter label if you click on [[:Category:NeedsRework | 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 <tt><nowiki>[[ISO_Lang_code:Page_Title]]</nowiki></tt>. <br> For example, <tt><nowiki>[[zh:Zh/Documentation/DevGuide/OpenOffice.org_Developers_Guide]]</nowiki></tt> 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. <br> The Wiki Syntax is: <tt><nowiki> {{Documentation/DevGuideLanguages|Page_Title}}</nowiki></tt> where Page_Title is the current Wiki page name. <br> For example, <tt><nowiki>{{Documentation/DevGuideLanguages|Documentation/DevGuide/OpenOffice.org Developers Guide}}</nowiki></tt> will add the localized page links for the first page in the Developer's Guide. <br> 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 <tt><nowiki>[[nl:NL/{{{1}}}]]</nowiki></tt>. 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 [mailto:dev@openoffice.apache.org the dev@ list]. 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= 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: <ol> <li> 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.</li> <li> Scroll down to the Insert New FAQ listbox.</li> <li> Replace the text in the listbox after the last slash '/' with your question.</li> <li> Click '''Add New FAQ'''<br>A new wiki page will be created and preloaded with a template for a Q/A pair: <source lang="text"> {{{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>]] </source> </li> <li> Replace <tt>(INSERT FAQ TITLE)</tt> 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.</li> <li> Replace <tt><INSERT QUESTION></tt> with the actual question.</li> <li> Replace <tt><INSERT ANSWER></tt> with the actual answer.</li> <li> Replace <tt><INSERT FAQ SECTION></tt> with the current FAQ section name. This category assignment determines where this wiki page will appear. Please use the following section names:</li> {|class="prettytable sortable" |- !FAQ section !!section name in category |-valign=top |General||General |-valign=top |Installation||Installation |-valign=top |Word Processing||Writer |-valign=top |Automatic Functions||Writer/AutomaticFunctions |-valign=top |Document Management||Writer/DocumentManagement |-valign=top |Formatting Pages and Docs||Writer/FormattingPagesAndDocuments |-valign=top |Formatting Text||Writer/FormattingText |-valign=top |Graphics, Frames & Objects||Writer/GraphicsFramesObjects |-valign=top |Indexes, Tables of Contents||Writer/IndexToc |-valign=top |Printing and Mail Merge||Writer/Printing |-valign=top |Spreadsheets||Calc |-valign=top |Drawings||Draw |-valign=top |Presentations||Impress |-valign=top |Formula Editor||Formula |-valign=top |Database||Databases |-valign=top |Macros||Macros |} <li>Click '''Save Page'''.</li> </ol> =Working on How Tos= If you want to create a new How To # Go to the [[Documentation/How_Tos | How Tos section]] and open the edit window. # Identify the adequate subsection and enter the title of your How To as a link. # Click '''Save Page''' to make the link visible. # 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 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: * <tt><nowiki>[[Category:Documentation/How Tos/Installation]]</nowiki></tt> * <tt><nowiki>[[Category:Documentation/How Tos/Writer]]</nowiki></tt> * <tt><nowiki>[[Category:Documentation/How Tos/Impress]]</nowiki></tt> * <tt><nowiki>[[Category:Documentation/How Tos/Calc]]</nowiki></tt> * <tt><nowiki>[[Category:Documentation/How Tos/Database]]</nowiki></tt> 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 [[Documentation/Dashboard/Wiki_Editing_Policy#List_of_Existing_Documentation_Templates | Templates]] section above, and click '''Save page'''. Do not forget to notify [mailto:doc@openoffice.apache.org doc@openoffice.apache.org] about your work on the How Tos. =Working on Guides= Currently, there are the following guides on the wiki: * [[Documentation/Administration_Guide|The Administration Guide]] * [[Documentation/BASIC_Guide|The BASIC Programming Guide]] * [[Documentation/Building_Guide|The Building Guide (AOO from source)]] * [[Documentation/DevGuide/OpenOffice.org_Developers_Guide|The Developer's Guide]] * [[Documentation/OOoAuthors_User_Manual|The User Guides for OpenOffice.org 2.x]] * [[Documentation/OOo3_User_Guides|The User Guides for OpenOffice.org 3.x]] 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. =Localizing Content= {{#lst:Help:Translating|translating}} {{PDL1}} [[Category:Help]] [[Category:How to]] [[Category:Guidelines]] [[Category:Localization]] [[Category:Documentation/Dashboard]]

Return to Documentation/Dashboard/Wiki Editing Policy.