Difference between revisions of "Template:WikiInstructions"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Created template so that instructions are consistent across projects, and so you only have to change them in one place!)
 
(*tweak*)
Line 1: Line 1:
 
== Navigating the {{{PROJECTNAME}}} Project Wiki ==
 
== Navigating the {{{PROJECTNAME}}} Project Wiki ==
To navigate to different pages in the {{{{PROJECTNAME}}} Project Wiki, click on the links in the sidebar on the top right of most {{{PROJECTNAME}}} Project pages.
+
To navigate to different pages in the {{{PROJECTNAME}}} Project Wiki, click on the links in the sidebar on the top right of most {{{PROJECTNAME}}} Project pages.  
 
+
'''Key Pages''' are the pages that have significance to the Project, or help organize the wiki.
+
  
 
By clicking on a '''category''', you will view all the pages that have been added to that category.  
 
By clicking on a '''category''', you will view all the pages that have been added to that category.  
 +
 +
'''Pages''' are the Project's main pages, or help organize the wiki.
 +
  
 
=== Notes about using the Wiki ===
 
=== Notes about using the Wiki ===
Line 34: Line 35:
 
=== Creating a new page ===
 
=== Creating a new page ===
 
* Before creating the page make sure there isn't a similar page in the [[:Category:{{{CATEGORYNAME}}}|{{{CATEGORYNAME}}} category]].
 
* Before creating the page make sure there isn't a similar page in the [[:Category:{{{CATEGORYNAME}}}|{{{CATEGORYNAME}}} category]].
* The best way to create a new page is to click on the "edit" button at the bottom of the box on the top right part of this page, and under the "Key pages" header, add a link that looks like this:
+
* If the page is a subpage of an existing page, create a link to the new page on the existing page. If it is an altogether new page for the {{{PROJECTNAME}}} Project, click on the "edit" button at the bottom of the box on the top right part of this page, and under the "Key pages" header, add a link that looks like this:
  
 
  <nowiki>* [[PAGENAME]] </nowiki>
 
  <nowiki>* [[PAGENAME]] </nowiki>

Revision as of 07:15, 25 February 2006

Navigating the {{{PROJECTNAME}}} Project Wiki

To navigate to different pages in the {{{PROJECTNAME}}} Project Wiki, click on the links in the sidebar on the top right of most {{{PROJECTNAME}}} Project pages.

By clicking on a category, you will view all the pages that have been added to that category.

Pages are the Project's main pages, or help organize the wiki.


Notes about using the Wiki

  • Each page has both an Article tab and a Discussion tab (although the "Discussion" tab may not have any content). The Article tab is for the content in development. The Discussion tab is for commentary on the content.
  • Red links or tabs indicate pages that do not exist.
  • You must be registered and logged in to edit the Wiki (we recommend using the same username as on the OpenOffice.org website). This prevents spamming, the cleaning of which takes away from our time spent contributing!


Contributing to the {{{PROJECTNAME}}} Project Wiki

Contributing to an existing page

  • First, find out what the page is about and what type of contribution you are making.
  • If you want to comment on the page's content, do so in the Discussion tab:
  1. Click on the Discussion tab at the top of the page
  2. If there is already discussion on what you want to say, click on the "edit" button for that section and leave a comment after the existing comments. You can indent your comments by putting a colon (":") at the beginning of each paragraph. This is helpful when replying to previous comments.
  3. If you are starting a new topic, click on the "+" sign near the edit tab at the top. Write the subject of your comment in the "Subject/Headline" box, and write your comment in the main text box.
  4. Always sign your username in discussions. Do this automatically with four tildes ("~~~~")
  • If you want to change or add to the page's content, do so in the Article tab:
  1. Click on the "edit" button for the section you would like to edit, or click on the Edit tab at the top to edit the whole page (note: very long pages may get cut off by your browser. Use the section edit button whenever possible!)
  2. Make the changes. Please use these Wiki Editing Guidelines as a formatting guide.
  • ALWAYS PREVIEW your work before you save it! After you've previewed it, click on "Save Page" to save your work.
  • Don't select the "This is a minor edit" box unless all you've done is fixed the spelling, grammar, or some MINOR formatting.
  • If you keep "Watch this page" selected, it will be added to your watchlist (no, you won't be sent e-mails when they are updated, unless you ask it to in your preferences).
  • Announce the changes to the {{{MAILINGLISTADDRESS}}} mailing list (send a completely blank e-mail to {{{MAILINGLISTSUBSCRIBEADDRESS}}} address to subscribe) or to the people who are working on the page (by clicking on their user name, then on the "e-mail this user" link on the left column of their user page).
  • Keep an eye on your contributions. If they are reverted, it is probably for a reason. Find out why so you don't make the same mistake again. If they are kept, then you're doing good things!


Creating a new page

  • Before creating the page make sure there isn't a similar page in the [[:Category:{{{CATEGORYNAME}}}|{{{CATEGORYNAME}}} category]].
  • If the page is a subpage of an existing page, create a link to the new page on the existing page. If it is an altogether new page for the {{{PROJECTNAME}}} Project, click on the "edit" button at the bottom of the box on the top right part of this page, and under the "Key pages" header, add a link that looks like this:
* [[PAGENAME]] 
  • In the "Summary" box below the text edit box, add a note indicating what you've done to modify the list page (in this case "Added PAGENAME to list of pages" is a good summary).
  • Scroll down and find the red link that you just created. Click on it to start editing.
  • Index the new page in the Marketing catgory by placing the following code in the First line:
 {{Marketing}} 
  • If this page belongs to any other categories, add a tag in the following format:
 [[Category:XXXX]]  ("XXXX" is the EXACT category name)
  • Then add 2-3 lines of empty space and start writing. Check out existing pages to see how they are organized and formatted.
  • What to write: a short mission statement for the new page, then write the proposed contents for the page. When done, give a clear description to your changes in the "summary" box.
  • ALWAYS PREVIEW your work before you save it! After you've previewed it, click on "Save Page" to save your work.
  • Don't select the "This is a minor edit" box unless all you've done is fixed the spelling, grammar, or some MINOR formatting.
  • If you keep "Watch this page" selected, it will be added to your watchlist (no, you won't be sent e-mails when they are updated, unless you ask it to in your preferences).
  • Announce the changes to the {{{MAILINGLISTADDRESS}}} mailing list (send a completely blank e-mail to {{{MAILINGLISTSUBSCRIBEADDRESS}}} address to subscribe) or to the people who are working on the page (by clicking on their user name, then on the "e-mail this user" link on the left column of their user page).
  • Keep an eye on your contributions. If they are reverted, it is probably for a reason. Find out why so you don't make the same mistake again. If they are kept, then you're doing good things!

Wiki editing tools and resources


Final Note on Contributing

Wiki is intended for collaborative work and for immediate access to start writing. Because the wiki is new and lots of dicussion still takes place on the mailing list, we strongly encourage you to announce new pages or major changes to the list.

We hope you don't find this too complicated, and that you do find it fun to work on the {{{PROJECTNAME}}} Project!

Personal tools