Difference between revisions of "Documentation/Dashboard/Introducing OOoAuthors"

From Apache OpenOffice Wiki
Jump to: navigation, search
(→‎Mailing lists: fixing ML subscription links)
m
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:Introducing OOoAuthors}}
+
{{DISPLAYTITLE:Introducing ODFAuthors}}
  
 +
{{Hurrah}}
 +
This document should be read in conjunction with [[Documentation/Dashboard/Producing_User_Guides|Producing {{AOo}} User Guides]].
  
−
This document should be read in conjunction with [[Documentation/Dashboard/Producing_User_Guides|Producing {{OOo}} User Guides]].
+
== What was ODFAuthors? ==
 +
ODFAuthors was a group of volunteers who produced ''user guides'' for the OpenOffice.org (OOo) office suite in several languages. These guides were then made available in various forms (ODT, PDF, MediaWiki) through the OOo Documentation Project and the relevant language groups at OOo. The guides could also be used, with minor modifications, by other projects including LibreOffice, Go-OO, NeoOffice, and others.
  
 +
Other forms of AOo user documentation (FAQs, HowTos, tutorials, training materials) may be produced by the former ODFAuthors group or by other people. Documentation for developers and system administrators is produced by other people within the {{AOo}} community.
  
−
== What is OOoAuthors? ==
+
Soon after the transition from Oracle to Apache the ODFAuthors group of volunteers broke up and does no longer exists as a separate entity.
−
OOoAuthors is a group of volunteer who produce ''user guides'' for the OpenOffice.org (OOo) office suite in several languages. These guides are then made available in various forms (ODT, PDF, MediaWiki) through the OOo Documentation Project and the relevant language groups at OOo. The guides can also be used, with minor modifications, by other projects including LibreOffice, Go-OO, NeoOffice, and others.
+
  
−
Other forms of OOo user documentation (FAQs, HowTos, tutorials, training materials) may be produced by the OOoAuthors group or by other people. Documentation for developers and system administrators is produced by other people within the OpenOffice.org community.
+
The AOO wiki, [https://wiki.openoffice.org/wiki/Documentation/ https://wiki.openoffice.org/wiki/Documentation/] is the current home for most AOO documentation. Some materials are maintained on the wiki; others are maintained elsewhere and made available through the wiki. The wiki was also used for collaborative planning and tracking of work, including the user guides. See [[#Using the OOo wiki|Using the AOO wiki]].
  
−
This diagram shows the relationship between OOoAuthors and the OpenOffice.org Documentation Project.
+
The {{AOo}} website, [https://www.openoffice.org/documentation/ https://www.openoffice.org/documentation/] is mainly a pointer to the location of available documentation and a repository for some historical material. The entire AOO website is moved to a new platform, providing the opportunity to reorganize current material and archive out of date material. Most contributors do not interact with this website very often; only a few people have write-access to any of its pages.
  
−
[[Image:oooa-fig1.png|thumb|none|600px|''Production and distribution of documentation'']]
+
We recommend having a login for the main AOO website (so you can file issues—bugs—if you find them while using the product) and joining the AOO Documentation project and its mailing list.
−
 
+
−
The OOoAuthors website, [http://www.oooauthors.org/ http://www.oooauthors.org/] is where most of the work on the user guides takes place. See [[#Using the OOoAuthors website|Using the OOoAuthors website]].
+
−
 
+
−
The OOo wiki, [http://wiki.services.openoffice.org/wiki/Documentation/ http://wiki.services.openoffice.org/wiki/Documentation/] is the current home for most OOo documentation. Some materials are maintained on the wiki; others are maintained elsewhere and made available through the wiki. The wiki is also used for collaborative planning and tracking of work including the user guides. See [[#Using the OOo wiki|Using the OOo wiki]].
+
−
 
+
−
The OpenOffice.org website, [http://documentation.openoffice.org/ http://documentation.openoffice.org/] is mainly a pointer to the location of available documentation and a respository for some historical material. The entire OOo website is being moved to a new platform, providing the opportunity to reorganize current material and archive out of date material. Most contributors do not interact with this website very often; only a few people have write-access to any of its pages.
+
−
 
+
−
== Joining OOoAuthors ==
+
−
To read published documents on the wiki, the OOo website, or the OOoAuthors website, you do not need to get a login or join a mailing list. However, to participate fully in OOoAuthors, you need to have a login for both the OOoAuthors website and the OOo wiki and you need to join our mailing list.
+
−
 
+
−
We also recommend having a login for the main OOo website (so you can file issues—bugs—if you find them while using the product) and joining the OOo Documentation project and its mailing list.
+
  
 
=== Logins ===
 
=== Logins ===
−
You can use the same login name for all the websites, but you must register separately at each of them. In each case, you will find a '''Register''' link in the upper right of the web page. Fill in the form that appears. Your registration is effective immediately.
+
You can use the same login name for all the websites, but you must register separately at each of them.  
  
−
'''OOoAuthors website'''
+
'''AOO wiki'''
  
−
Go to [http://www.oooauthors.org/ http://www.oooauthors.org/].
+
Go to [https://wiki.openoffice.org/wiki/Documentation/ https://wiki.openoffice.org/wiki/Documentation/]. You will find a '''Register''' link in the upper right of the web page. Fill in the form that appears. Your registration is effective immediately.
  
−
'''OOo wiki'''
+
'''{{AOo}} website'''
  
−
Go to [http://wiki.services.openoffice.org/wiki/Documentation/ http://wiki.services.openoffice.org/wiki/Documentation/].
+
Go to [https://documentation.openoffice.org/ https://documentation.openoffice.org/] or any page on the {{AOo}} website. You will find a '''Register''' link in the upper right of the web page. Fill in the form that appears. Your registration is effective immediately.
−
 
+
−
'''OpenOffice.org website'''
+
−
 
+
−
Go to [http://documentation.openoffice.org/ http://documentation.openoffice.org/] or any page on the openoffice.org website.
+
−
 
+
−
'''Joining the Documentation Project'''
+
−
 
+
−
Go to [http://documentation.openoffice.org/ http://documentation.openoffice.org/]. In the boxed section titled ''Welcome to the Documentation Project!'', click on the link '''signing up'''. On the ''Request project role'' page, one choice is available: ''Observer''. Click '''Submit request'''. Requests must be approved. In most cases this happens within a day or two, but lack of approval does not stop you from participating.
+
  
 
=== Mailing lists ===
 
=== Mailing lists ===
−
We have two main mailing lists:
+
After the transition of OpenOffice.org from Oracle to Apache, we have two main mailing lists:
  
−
* [mailto:dev@documentation.openoffice.org dev@documentation.openoffice.org], for discussions related to project infrastructure and policy.
+
* [mailto:dev@openoffice.apache.org dev@openoffice.apache.org] (Apache-OOo) for discussions related to {{AOo}} (not just Documentation) project infrastructure and policy.
−
* [mailto:authors@documentation.openoffice.org authors@documentation.openoffice.org], where writers, editors, reviewers, and others discuss documents they are working on.
+
* [mailto:doc@openoffice.apache.org doc@openoffice.apache.org] (AOO), where writers, editors, reviewers, and others discuss documents they are working on.
  
−
We recommend you subscribe to each of these mailing lists. If you do not subscribe, any message you send will be delayed while a moderator finds time to approve them, and you will not see any replies to your messages. Thus you will not be able to participate effectively with the team.
+
We recommend you subscribe to each of these mailing lists. The doc-list is essential: if you do not subscribe, any message you send will be delayed while a moderator finds time to approve it, and you will not see any replies to your messages. Thus, you will not be able to participate effectively with the team.
  
−
{{Documentation/Note|The lists are public and messages posted to them can be found through Google and other archives. Some people choose to use pseudonyms on the mailing lists for this reason.}}
+
{{Note|The lists are public and messages posted to them can be found through Google and other archives. Some people choose to use pseudonyms or list-specific email addresses on the mailing lists for this reason.}}
  
 
'''Join a list'''
 
'''Join a list'''
  
−
To join the Documentation list, send a blank email to [mailto:dev@documentation.openoffice.org dev@documentation.openoffice.org?subject=subscribe dev]
+
To join the AOO dev-list, send a blank email to [mailto:dev-subscribe@openoffice.apache.org dev-subscribe@openoffice.apache.org].
  
−
To join the Authors list, send a blank email to [mailto:authors@documentation.openoffice.org authors@documentation.openoffice.org?subject=subscribe authors]
+
To join the AOO doc-list, send a blank email to [mailto:doc-subscribe@openoffice.apache.org doc-subscribe@openoffice.apache.org].
  
 
In each case, you will receive a confirmation email. You must respond to this email to confirm your subscription.
 
In each case, you will receive a confirmation email. You must respond to this email to confirm your subscription.
Line 64: Line 48:
 
'''Post to a list'''
 
'''Post to a list'''
  
−
To post to one of the lists, send an email to [mailto:authors@documentation.openoffice.org authors@documentation.openoffice.org] (Authors) or[mailto:dev@documentation.openoffice.org dev@documentation.openoffice.org] (Docs)
+
To post to one of the lists, send an email to one of the addresses given.
  
 
Please send an email to the list to introduce yourself.
 
Please send an email to the list to introduce yourself.
Line 70: Line 54:
 
'''Read list archives'''
 
'''Read list archives'''
  
−
To read the archives of the Authors list, go to [http://documentation.openoffice.org/servlets/SummarizeList?listName=authors http://documentation.openoffice.org/servlets/SummarizeList?listName=authors]
+
Archives of the former ODFAuthors list are no longer available.
 +
 
 +
To read the archives of the AOO dev-list, go to [https://lists.apache.org/list.html?dev@openoffice.apache.org https://lists.apache.org/list.html?dev@openoffice.apache.org]
 +
 
 +
To read the archives of the AOO doc-list, go to [https://lists.apache.org/list.html?doc@openoffice.apache.org https://lists.apache.org/list.html?doc@openoffice.apache.org]
  
−
To read the archives of the Docs list, go to [http://documentation.openoffice.org/servlets/SummarizeList?listName=dev http://documentation.openoffice.org/servlets/SummarizeList?listName=dev]
 
  
 
'''Unsubscribe from a list'''
 
'''Unsubscribe from a list'''
  
−
If you need to unsubscribe from either list, send an email from the subscribed address to [mailto:authors-unsubscribe@documentation.openoffice.org authors-unsubscribe@documentation.openoffice.org] or [mailto:dev-unsubscribe@documentation.openoffice.org dev-unsubscribe@documentation.openoffice.org]  
+
If you need to unsubscribe from either list, send a blank email from the subscribed address to  
 +
[mailto:dev-unsubscribe@openoffice.apache.org dev-unsubscribe@openoffice.apache.org] (AOO dev) or  
 +
[mailto:doc-unsubscribe@openoffice.apache.org doc-unsubscribe@openoffice.apache.org] (AOO doc).
  
−
In each case, you will receive a confirmation email. You must respond to this email to confirm your unsubscription.
+
In each case, you will receive a confirmation email. You must respond to this email to confirm your cancelling the subscription.
  
−
== First steps with OOoAuthors ==
+
== First steps ==
 
Once that you have a website login and have joined the mailing list and introduced yourself, we recommend the following steps:
 
Once that you have a website login and have joined the mailing list and introduced yourself, we recommend the following steps:
  
 
# Read about the licenses we apply to any work contributed to the user guides and be sure you are comfortable with these licenses:
 
# Read about the licenses we apply to any work contributed to the user guides and be sure you are comfortable with these licenses:
−
#* Creative Commons Attribution License, version 3.0 or later [http://creativecommons.org/licenses/by/3.0/ http://creativecommons.org/licenses/by/3.0/]  
+
#* Creative Commons Attribution License, version 3.0 or later [https://creativecommons.org/licenses/by/3.0/ https://creativecommons.org/licenses/by/3.0/]  
−
#* GNU General Public License, version 3 or later [http://www.gnu.org/licenses/gpl.html http://www.gnu.org/licenses/gpl.html]
+
#* GNU General Public License, version 3 or later [https://www.gnu.org/licenses/gpl.html https://www.gnu.org/licenses/gpl.html]
−
# Write to the Authors list and ask for the Author role. Mention the real name you gave when registering so we can find you in the list of members. Without the Author role, your access is limited to published documents and you will not see the list of documents awaiting review nor any of the draft documents themselves. With the Author role, you can view and download files at the internal draft or published internally stages and also add files to the OOoAuthors website.
+
# Write to the doc list. Mention the real name you gave when registering so we can find you in the list of members.
 
# Read these reference documents:
 
# Read these reference documents:
 
#* Contributors’ Guide (this document)
 
#* Contributors’ Guide (this document)
−
#* Style Guide [http://www.oooauthors.org/english/userguide3/res3/ http://www.oooauthors.org/english/userguide3/res3/][http://www.oooauthors.org/english/userguide3/res3/style_guide_V3.odt style_guide_V3.odt]
+
#* Style Guide [https://wiki.openoffice.org/wiki/File:Style_Guide_V3.odt Style_guide_V3.odt]
−
#* Writer’s Guide [http://www.oooauthors.org/english/userguide3/res3/ http://www.oooauthors.org/english/userguide3/res3/][http://www.oooauthors.org/english/userguide3/res3/Writing_OOo Writing_OOo][http://www.oooauthors.org/english/userguide3/res3/Writing_OOo_Guides_v3.odt _Guides_v3.odt]
+
#* Writer’s Guide [https://wiki.openoffice.org/wiki/File:Writing_OOo_Guides_v3.odt Writing_Guides_v3.odt]
−
#* Word list [http://wiki.services.openoffice.org/wiki/Documentation/ http://wiki.services.openoffice.org/wiki/Documentation/][http://wiki.services.openoffice.org/wiki/Documentation/Dashboard/ Dashboard/][http://wiki.services.openoffice.org/wiki/Documentation/Dashboard/Word_List_for_User_Guides Word_List_for_User_Guides]
+
#* Word list [https://wiki.openoffice.org/wiki/Documentation/Dashboard/Word_List_for_User_Guides Word_List_for_User_Guides]
−
# Get the latest stable version of OOo from the first page of the OOo website, [http://www.openoffice.org/ http://www.openoffice.org/]
+
# Get the latest stable version of {{AOo}} from the first page of the AOO website, [https://www.openoffice.org/ https://www.openoffice.org/]
−
# Get the latest Developer Snapshot of the next version of OOo from [http://download.openoffice.org/next/index.html http://download.openoffice.org/next/index.html]
+
# Get the latest Developer Snapshot of the next version of AOO from [https://www.openoffice.org/download/devbuilds.html https://www.openoffice.org/download/devbuilds.html]
−
# Check the user guide task list to find things that interest you or have a high priority need for help, [http://wiki.services.openoffice.org/wiki/Documentation/Dashboard/User_Guides http://wiki.services.openoffice.org/wiki/Documentation/Dashboard/User_Guides]
+
# Check the user guide task list to find things that interest you or have a high priority need for help, [https://wiki.openoffice.org/wiki/Documentation/Dashboard/User_Guides https://wiki.openoffice.org/wiki/Documentation/Dashboard/User_Guides]
−
# Check the Review List on the OOoAuthors website. This list is visible when you are logged in and have the Author role.
+
−
 
+
−
== Using the OOoAuthors website ==
+
−
The OOoAuthors website uses a content management system called Plone. It is quite easy to use once you become familiar with it.
+
−
 
+
−
{{Documentation/Note|You must be logged in and have the Author role to be able to use the features discussed in this section.}}
+
−
 
+
−
Our workflow in the English section of OOoAuthors is shown below.
+
−
 
+
−
[[Image:oooa-fig2.png|thumb|none|600px|''Workflow'']]
+
−
 
+
−
The English section of the OOoAuthors has this hierarchy:
+
−
 
+
−
[[Image:oooa-fig3.png|thumb|none|600px|''Hierarchy of folders'']]
+
−
 
+
−
=== How to retract a document ===
+
−
''Retracting'' a document removes a submitted file from the Review List. If you are reviewing a chapter, please retract the chapter so others know it is being worked on and don’t duplicate your work. Sometimes the author will request multiple simultaneous reviews; in that case, do not retract the document.
+
−
 
+
−
To retract a document:
+
−
 
+
−
# On the OOoAuthors website, go to the folder containing the document.
+
−
# Click on the filename to go to the View page for the file.
+
−
# Click on the down-arrow by ''state: pending review'' and select '''retract''' from the drop-down list. The state will change to ''internal draft''.
+
−
# To download the file from that same page, click on its name. A download box opens. If your browser gives you a choice of ''Open with OpenOffice.org'' or ''Save File'', choose '''Save File'''.
+
−
 
+
−
:[[Image:retract.png|thumb|none|600px|''Retracting a document'']]
+
−
 
+
−
=== How to upload a document ===
+
−
# On the OOoAuthors website, go to the correct folder for the book you’re working on: Drafts if you’re writing a chapter; Feedback if you’re reviewing or editing it.
+
−
# On the View page of the folder, click '''add new > file'''.
+
−
# On the Add File page, type a name for the document (for example, ''How to Upload a Document'') in the Title box and type an optional description.
+
−
# Click the '''Browse''' button, find the file on your computer, select it, and click '''Save'''. The upload process should complete within a few minutes. There is no progress indicator.
+
−
# If the file is in the Feedback folder, you are done.
+
−
 
+
−
:[[Image:addnewfile.png|thumb|none|600px|''Uploading a document'']]
+
−
 
+
−
If the file is in the Drafts folder and needs to be reviewed or edited, go to “How to submit a document” below.
+
−
 
+
−
=== How to submit a document ===
+
−
''Submitting a document'' means that it is ready for others to review or edit. When a document is submitted, it shows up in the Review List.
+
−
 
+
−
To submit a document:
+
−
 
+
−
# If you have just uploaded the document, you should be on the View page for the file. Otherwise, go to the folder containing the document and click on the filename to go to the View page for the file.
+
−
# Click on the down-arrow by ''state: internal draft'' in the upper right-hand corner of the page. Select ''submit for publication'' from the drop-down list.
+
−
 
+
−
:[[Image:submit.png|thumb|none|600px|''Submitting a document for review'']]
+
  
−
== Using the OOo wiki ==
+
== Using the AOO wiki ==
−
The OOoAuthors group uses the OOo Documentation wiki, [http://wiki.services.openoffice.org/wiki/Documentation/ http://wiki.services.openoffice.org/wiki/Documentation/] for collaborative planning and tracking of work on the user guides. Published user guides produced by OOoAuthors are made available through the wiki.
+
The group of volunteers uses the AOO Documentation wiki, [https://wiki.openoffice.org/wiki/Documentation/ https://wiki.openoffice.org/wiki/Documentation/], as well as [https://github.com/apache/openoffice-docs GitHub] for collaborative planning and tracking of work on the user guides. Published user guides are made available through the wiki.
  
 
=== Editing wiki pages ===
 
=== Editing wiki pages ===

Latest revision as of 12:48, 18 August 2023


HURRAH!!    We've moved! We're here!

_______________________________________

This document should be read in conjunction with Producing Apache OpenOffice User Guides.

What was ODFAuthors?

ODFAuthors was a group of volunteers who produced user guides for the OpenOffice.org (OOo) office suite in several languages. These guides were then made available in various forms (ODT, PDF, MediaWiki) through the OOo Documentation Project and the relevant language groups at OOo. The guides could also be used, with minor modifications, by other projects including LibreOffice, Go-OO, NeoOffice, and others.

Other forms of AOo user documentation (FAQs, HowTos, tutorials, training materials) may be produced by the former ODFAuthors group or by other people. Documentation for developers and system administrators is produced by other people within the Apache OpenOffice community.

Soon after the transition from Oracle to Apache the ODFAuthors group of volunteers broke up and does no longer exists as a separate entity.

The AOO wiki, https://wiki.openoffice.org/wiki/Documentation/ is the current home for most AOO documentation. Some materials are maintained on the wiki; others are maintained elsewhere and made available through the wiki. The wiki was also used for collaborative planning and tracking of work, including the user guides. See Using the AOO wiki.

The Apache OpenOffice website, https://www.openoffice.org/documentation/ is mainly a pointer to the location of available documentation and a repository for some historical material. The entire AOO website is moved to a new platform, providing the opportunity to reorganize current material and archive out of date material. Most contributors do not interact with this website very often; only a few people have write-access to any of its pages.

We recommend having a login for the main AOO website (so you can file issues—bugs—if you find them while using the product) and joining the AOO Documentation project and its mailing list.

Logins

You can use the same login name for all the websites, but you must register separately at each of them.

AOO wiki

Go to https://wiki.openoffice.org/wiki/Documentation/. You will find a Register link in the upper right of the web page. Fill in the form that appears. Your registration is effective immediately.

Apache OpenOffice website

Go to https://documentation.openoffice.org/ or any page on the Apache OpenOffice website. You will find a Register link in the upper right of the web page. Fill in the form that appears. Your registration is effective immediately.

Mailing lists

After the transition of OpenOffice.org from Oracle to Apache, we have two main mailing lists:

  • dev@openoffice.apache.org (Apache-OOo) for discussions related to Apache OpenOffice (not just Documentation) project infrastructure and policy.
  • doc@openoffice.apache.org (AOO), where writers, editors, reviewers, and others discuss documents they are working on.

We recommend you subscribe to each of these mailing lists. The doc-list is essential: if you do not subscribe, any message you send will be delayed while a moderator finds time to approve it, and you will not see any replies to your messages. Thus, you will not be able to participate effectively with the team.

Documentation note.png The lists are public and messages posted to them can be found through Google and other archives. Some people choose to use pseudonyms or list-specific email addresses on the mailing lists for this reason.

Join a list

To join the AOO dev-list, send a blank email to dev-subscribe@openoffice.apache.org.

To join the AOO doc-list, send a blank email to doc-subscribe@openoffice.apache.org.

In each case, you will receive a confirmation email. You must respond to this email to confirm your subscription.

Post to a list

To post to one of the lists, send an email to one of the addresses given.

Please send an email to the list to introduce yourself.

Read list archives

Archives of the former ODFAuthors list are no longer available.

To read the archives of the AOO dev-list, go to https://lists.apache.org/list.html?dev@openoffice.apache.org

To read the archives of the AOO doc-list, go to https://lists.apache.org/list.html?doc@openoffice.apache.org


Unsubscribe from a list

If you need to unsubscribe from either list, send a blank email from the subscribed address to dev-unsubscribe@openoffice.apache.org (AOO dev) or doc-unsubscribe@openoffice.apache.org (AOO doc).

In each case, you will receive a confirmation email. You must respond to this email to confirm your cancelling the subscription.

First steps

Once that you have a website login and have joined the mailing list and introduced yourself, we recommend the following steps:

  1. Read about the licenses we apply to any work contributed to the user guides and be sure you are comfortable with these licenses:
  2. Write to the doc list. Mention the real name you gave when registering so we can find you in the list of members.
  3. Read these reference documents:
  4. Get the latest stable version of Apache OpenOffice from the first page of the AOO website, https://www.openoffice.org/
  5. Get the latest Developer Snapshot of the next version of AOO from https://www.openoffice.org/download/devbuilds.html
  6. Check the user guide task list to find things that interest you or have a high priority need for help, https://wiki.openoffice.org/wiki/Documentation/Dashboard/User_Guides

Using the AOO wiki

The group of volunteers uses the AOO Documentation wiki, https://wiki.openoffice.org/wiki/Documentation/, as well as GitHub for collaborative planning and tracking of work on the user guides. Published user guides are made available through the wiki.

Editing wiki pages

[To be written]

Using the Discussion tab

[To be written]

Wiki templates

[To be written]


Content on this page is licensed under the Creative Common Attribution 3.0 license (CC-BY).
Retrieved from "https://wiki.openoffice.org/w/index.php?title=Documentation/Dashboard/Introducing_OOoAuthors&oldid=257096"
Personal tools