Difference between revisions of "Documentation/Dashboard"

From Apache OpenOffice Wiki
Jump to: navigation, search
(HOW_TO)
 
(66 intermediate revisions by 8 users not shown)
Line 1: Line 1:
This page will serve as Dashboard for the Documentation project to allow high-level tracking
+
{{DocBanner}} {{DISPLAYTITLE:Documentation Dashboard}} This page will serve as Dashboard for the Documentation project to allow high-level tracking of documentation sub-projects and content deliverables.  
of documentation sub-projects and content deliverables.
+
  
For now, this is a description of the "status quo" of the documentation project,
+
*[[Documentation/Dashboard/2013 Plan|Doc Projects for 2013]]
that should serve as input for further discussions about a geeral reorganization of
+
*[[Documentation/Dashboard/Who is Who|Who is who in the documentation team]]
the project (see also [[Documentation/Project_DocOOo_Structure | here]]).
+
  
==Website Content==
+
=== Documentation Bits  ===
  
The [http://documentation.openoffice.org documentation web site] repository contains a total
+
{| cellspacing="0" cellpadding="5" border="1" width="80%" style="border-color: rgb(51, 51, 51); border-collapse: collapse;"
of around 5700 files organized into different subdirectories. The following list is an incomplete
+
|- style="background-color: rgb(222, 222, 222);"
tree of the documentation/www repository:
+
! Project
 
+
! Status
.
+
! Owner  
|-- HOW_TO
+
! Help Wanted
|-- Samples_Templates
+
|-- articles
+
|-- book_reviews
+
|-- contests
+
|-- faqs
+
|-- id
+
|-- it
+
|-- manuals
+
|-- online_help
+
|-- quickstart
+
|-- setup_guide2
+
|-- testdir
+
|-- tutorials
+
|-- user_faq
+
`-- zh
+
 
+
 
+
===HOW_TO===
+
 
+
HOW_TO is divided into the following subsections:
+
 
+
{| border=1 cellpadding=4 style="border-collapse:collapse;"
+
|- style="background-color: #DADAFF;"
+
! Document
+
! Title
+
! Format(s) !! Size !! Age[1] !! License
+
! Owner/Author
+
! Notes
+
! Up-to-date?
+
! Recommendation
+
|- style="background-color: #DDDDDD;"
+
| colspan=10 | Section '''data_source'''
+
 
|-
 
|-
| SQLite
+
| Installation Guide (formerly [[Documentation/Dashboard/Setup Guide|Setup Guide]])
| Using SQLite Database with OpenOffice.org
+
| Completed for OOoV3.2.1
| PDF, SXW || 27p || 2.8 y || PDLv1 
+
| TBD
| Yves Chaufour (French version)
+
| Update as needed for AOOv3.4; rebrand
| translated by Gerry Singleton
+
|
+
|
+
 
|-
 
|-
| data1_EN
+
| [[Documentation/Dashboard/User Manuals|User Guides]]
| How to Create a Data Source from Scratch
+
| In progress
| HTML, SXW || 11p || 2.5 y || PDLv1
+
| [mailto:jeanweber@apache.org Jean]
| Scott Carr
+
| Rebrand for AOO. Update source documents; plan improvements to existing books. See [[Documentation/Dashboard/User Guides|task list for user guides]].
|
+
See also [[Documentation/Dashboard/Producing User Guides|guide for producing user guides]]. Source docs are developed at [http://www.odfauthors.org/openoffice.org/english/ ODFAuthors website].
|
+
 
|
+
 
|-
 
|-
| how_to_link_tables_using_named_parameters
+
| Developer's Guide
| How to Link Tables Using SQL Named Parameters
+
| Transferred to [[Documentation/DevGuide/OpenOffice.org Developers Guide|wiki]]
| PDF, SXW, HTML || 42 || 4.6 y || PDLv1
+
| TBD
| Scott Carr
+
| Review/Ongoing - needs to have each chapter reviewed and verified for accuracy.<br>
|
+
|
+
|
+
|- style="background-color: #DDDDDD;"
+
| colspan=10 | Section '''drawing_graphics'''
+
 
|-
 
|-
| documentationdraw_en
+
| BASIC Programming Guide
| How to get to grips with OpenOffice.org Draw
+
| Transferred to [[Documentation/BASIC Guide|wiki]]
| PDF, SXW || 125p || 1.7 y || none specified
+
| TBD
| Michel Pinquier
+
| Stable for 3.x release<br>
| PDF is corrupt
+
|
+
|  
+
 
|-
 
|-
| draw1_EN
+
| Administration Guide
| How To Compose a Document with Simple Geometric Shapes, to Change their Attributes (color, size, position, ...) and to Print the Result.
+
| Transferred to [[Documentation/Administration Guide|wiki]]
| PDF, HTML || 13p || 5 y || none specified
+
TBD
| Gianluca Turconi
+
| Rewrite started.&nbsp; Admin Guide contents are very old and apply to 2.x and even earlier in some cases.
|
+
|
+
|
+
|- style="background-color: #DDDDDD;"
+
| colspan=10 | Section '''drawing_graphics'''
+
 
|-
 
|-
| Formula_CommandRef0_4_1
+
| [[Documentation/Dashboard/How Tos|How Tos]]
| Formula Command Reference
+
| Transferred to [[Documentation/How_Tos|wiki]]
| PDF, SXW || 15p || 2.6 y || LGPLv2.1
+
| TBD
| Fred Saalbach
+
| Update as needed
|  
+
|  
+
|
+
 
|-
 
|-
| Formula_HowTo_1_0
+
| [[Documentation/Dashboard/FAQ|FAQ]]
| Formula
+
| Transferred to [[Documentation/FAQ|wiki]] 
| PDF, SXW || 18p || 1.9 y || LGPLv2.1
+
| TBD
| Fred Saalbach, Harald Schilly (German original)
+
| Consolidate and update FAQs from several sources<br> Clean up [[Documentation/FAQ|FAQs]]
|
+
|
+
|  
+
|- style="background-color: #DDDDDD;"
+
| colspan=10 | Section '''impress'''
+
 
|-
 
|-
| HowToInsertNotes
+
| [[Documentation/Dashboard/Application Online Help|Application Online Help]]
| How to Insert Notes In an Impress Presentation
+
| Proposed
| PDF, SXW, ODT || 8p || 2 y || PDLv1
+
| Uwe?
| Steven Allen
+
| <br>
|  
+
|  
+
|
+
 
|-
 
|-
| InsertNewSlide
+
| [[Documentation/Dashboard/Samples, Templates and Clipart|Samples, Templates and Clipart]]
| How to Insert a New Slide in Impress
+
| in progress
| PDF, SXW, ODT || 9p || 2 y || PDLv1
+
| Martina?
| Steven Allen
+
| <br>
|  
+
|  
+
|
+
 
|-
 
|-
| NewImpressUsingTemplate_revised
+
| [[Documentation/Dashboard/Tutorials|Tutorials]]
| How To Create a New Impress Document Using a Template
+
| Proposed
| PDF, SXW, ODT || 11p || 2 y|| PDLv1
+
| [mailto:jeanweber@apache.org Jean]
| Steven Allen
+
| Create tutorials targeted at specific audiences; see [[Documentation/Dashboard/Tutorials|this page]] for details.
|  
+
|
+
|
+
 
|-
 
|-
| fs_impress2_0
+
| Update Doc Project webpages<br>
| First Steps in Impress
+
| In progress
| PDF, ODT || 39p || 1.5 y || PDLv1
+
| [mailto:jeanweber@apache.org Jean]
| Andreas Mantke
+
 
|  
 
|  
|
+
Specific pages in need of help:
|
+
 
 +
[http://documentation.openoffice.org/setup_guide2/ SetupGuide v2]<br>
 +
 
 +
[http://download.openoffice.org/common/instructions.html Common install instructions]<br>
 +
 
 
|-
 
|-
| movies_without_java
+
| Information for advanced users
| Using Movies in Impress on Linux without the need for Java Software
+
 
| PDF, ODT || 39p || 1.4 y || PDLv1
+
Details, which do not directly belong to programming.
| Max Weber
+
| In progress
|  
+
 
|
 
|
|
 
|- style="background-color: #DDDDDD;"
 
| colspan=10 | Section '''misc'''
 
|-
 
| AverCrossRef
 
| Label Format Cross-Reference
 
| PDF || 11p || 10.6 mo || PDLv1
 
| Russell Ossendryver
 
| no source available
 
 
|
 
|
| bgcolor=#FFFFA6 | get source or remove
+
Make an index page
|-
+
 
| Troubleshooting_guide
+
[[ Create_a_New_Custom_Shape_in_Source_in_File]] has empty sections and needs a lot of pictures.
| Troubleshooting Common Problems
+
| PDF, HTML || 21p || 10.4 mo || PDLv1
+
| Gerry Singleton
+
| no source available
+
|
+
| bgcolor=#FFFFA6 | get source and move content to Troubleshooting wiki section (to be created)
+
|-
+
| cygwin_tortoise_cvs
+
| Installing and using CVS under Windows
+
| PDF, HTML || 9p || 4.7 y || none specified
+
| Miljenko Williams
+
| no source available
+
|
+
| bgcolor=#FFA6BC | remove, misplaced, no source
+
|-
+
| email_change_v0.2
+
| Changing Your Email Address: OpenOffice.org Mailing Lists
+
| PDF, SXW || 10p || 2.2 y || PDLv1
+
| Tim Kampa
+
|
+
|
+
|
+
|-
+
| multiple_screens
+
| How to Setup Multiple Screens under Linux Using Xinerama
+
| PDF, ODT || 10p || 1.6 y || none specified
+
| Chris Tyler
+
|
+
|
+
| bgcolor=#FFA6BC | remove, link to Linux Web resource instead
+
|- style="background-color: #DDDDDD;"
+
| colspan=10 | Section '''spreadsheet'''
+
|-
+
|
+
|
+
| PDF || 11p || 10.6 mo || PDLv1
+
|
+
|
+
|
+
 
|}
 
|}
  
<!--
+
{{Spacer|50}}
red = FFA6BC = remove
+
yellow = FFFFA6  = merge and/or update
+
green = BCFFA6 = check and repost
+
blue = BCA6FF = archive
+
//-->
+
  
[1] as per CVS statistics
+
=== Internal/Umbrella Projects  ===
  
Section/Directory    Documents   
+
{| cellspacing="0" cellpadding="5" border="1" width="80%" style="border-color: rgb(51, 51, 51); border-collapse: collapse;"
* data_source       
+
|- bgcolor="#dedede"
* drawing_graphics
+
! Project
* formula
+
! Status
* impress
+
! Owner
* misc
+
! Help Wanted
* spreadsheet
+
* various_topics
+
* word_processing
+
 
+
==Issuetracker==
+
The [http://www.openoffice.org/issues/buglist.cgi?issue_type=TASK&component=documentation&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED master issue list] has a total of '''151''' issues, '''129 (85%)''' of which are owned by issues@documentation, i.e. no-one.
+
 
+
{| border=0 cellpadding=10
+
|- valign=top
+
|'''Age Distribution'''
+
This tables shows how old the issues are (day of creation and day of last modification).
+
 
+
{| border=1 cellpadding=4 style="border-collapse:collapse;"
+
|+align="bottom" |''Age Distribution''
+
|- style="background-color: #DADAFF;"
+
! rowspan=2 | Age in Years
+
! colspan=3 | Creation Date
+
! colspan=3 | Modification Date
+
|- style="background-color: #DADAFF;"
+
! Issues !! % !! !!  Issues !! % !!
+
 
|-
 
|-
| <1  || 7 || 4.6% || {{Documentation/hbar|5|#AAA}} || 26 || 17.2% || {{Documentation/hbar|17|#AAA}}
+
| [[Documentation/Dashboard/Wiki Help|Wiki Help]]
 +
| stalled
 +
| &lt;TBD&gt;
 +
| <br>
 
|-
 
|-
| 1-2 || 12 || 7.9% ||{{Documentation/hbar|8|#AAA}}||  14 || 9.3% || {{Documentation/hbar|9|#AAA}}
+
| [[Documentation/Dashboard/Wiki_Editing_Policy|Wiki Editing Policy]]
 +
| ongoing
 +
| &lt;TBD&gt;
 +
| <br>
 
|-
 
|-
| 2-3 || 5 || 3.3% || {{Documentation/hbar|3|#AAA}} || 5 || 3.3% || {{Documentation/hbar|3|#AAA}}
+
| [[Documentation/Dashboard/Wiki Books|Wiki Books]]
 +
| started
 +
| &lt;TBD&gt;
 +
| <br>
 
|-
 
|-
| 3-4 || 124 || 82.1% || {{Documentation/hbar|82|#AAA}} || 106 || 70.2% || {{Documentation/hbar|70|#AAA}}
+
| [[Documentation/Dashboard/DocOOo Structure|Structure of the Documentation project]]
 +
| proposed
 +
| [mailto:mwaller@openoffice.org Martina]
 +
| <br>
 
|-
 
|-
| >4  || 3 || 2.0% || {{Documentation/hbar|2|#AAA}} || 0 || 0% ||  
+
| [[Documentation/Dashboard/Help Release Process|Help Release Process]]
|}
+
| planned
|'''Status Distribution'''
+
| &lt;TBD&gt;  
This tables shows the distribution of the status values for the issues
+
| <br>
 
+
{| border=1 cellpadding=4 style="border-collapse:collapse;"
+
|+align="bottom" |''Status Distribution''
+
|- style="background-color: #DADAFF;"
+
! Status !! Issues !! % !!
+
 
|-
 
|-
| NEW  || 131 || 86.8% || {{Documentation/hbar|87|#AAA}}
+
| [[Documentation/Dashboard/Curriculum Development|Curriculum Development]]
 +
| proposed
 +
| &lt;TBD&gt;
 +
| <br>
 
|-
 
|-
| STARTED || 17 || 11.3% ||{{Documentation/hbar|11|#AAA}}
+
| [[Documentation/Dashboard/Help Content Cleanup|Help Content Cleanup]]
 +
| proposed
 +
| [mailto:mwaller@openoffice.org Martina]
 +
| <br>
 
|-
 
|-
| UNCONFIRMED || 2 || 1.3% || {{Documentation/hbar|1|#AAA}}
+
| [[Documentation/Dashboard/Competitive Documentation Analysis|Competitive Documentation Analysis]]
 +
| ongoing
 +
| [mailto:mwaller@openoffice.org Martina]
 +
| please help discussing the results
 
|-
 
|-
| REOPENED || 1 || 0.7% || {{Documentation/hbar|1|#AAA}}
+
| [[Documentation/Dashboard/OOo-MSO Compatibility|OOo-MSO Compatibility]]
 
+
| proposed
 +
| &lt;TBD&gt;
 +
| Collect info: problems &amp; solutions
 +
|-
 +
| [[Documentation/Dashboard/Help Style Guide|Help Style Guide]]
 +
| in progress
 +
| [mailto:mwaller@openoffice.org Martina]
 +
| please report further [[Style inconsistencies]]
 +
|-
 +
| [[Documentation/Dashboard/Word List for User Guides|Word List for User Guides]]
 +
| Draft
 +
| [mailto:jeanweber@apache.org Jean]
 +
| Add more words and phrases as needed
 
|}
 
|}
  
|}
+
=== Old project related information ===
 
+
===Conclusions===
+
 
+
  
 +
*[[Documentation/Dashboard/Ideastorm|Ideastorm]] - many of the concepts here have been implemented in some form or another.  Some ideas were too complex to implement in the current structure, but can and should be revisited on a regular basis.
 +
*[[Documentation/Dashboard/Project Plan|Documentation Project Plan 2009]]
 +
*[[Documentation/Dashboard/2010 Plan|Doc Projects for 2010]] - needs to be re-evaluated for 2011.
 +
*[[Documentation/Dashboard/CMS Evaluation|CMS Evaluation]]
  
[[Category:Documentation]]
+
[[Category:Documentation/Dashboard]]

Latest revision as of 21:35, 7 July 2018

doc OOo
This page will serve as Dashboard for the Documentation project to allow high-level tracking of documentation sub-projects and content deliverables.

Documentation Bits

Project Status Owner Help Wanted
Installation Guide (formerly Setup Guide) Completed for OOoV3.2.1 TBD Update as needed for AOOv3.4; rebrand
User Guides In progress Jean Rebrand for AOO. Update source documents; plan improvements to existing books. See task list for user guides.

See also guide for producing user guides. Source docs are developed at ODFAuthors website.

Developer's Guide Transferred to wiki TBD Review/Ongoing - needs to have each chapter reviewed and verified for accuracy.
BASIC Programming Guide Transferred to wiki TBD Stable for 3.x release
Administration Guide Transferred to wiki TBD Rewrite started.  Admin Guide contents are very old and apply to 2.x and even earlier in some cases.
How Tos Transferred to wiki TBD Update as needed
FAQ Transferred to wiki TBD Consolidate and update FAQs from several sources
Clean up FAQs
Application Online Help Proposed Uwe?
Samples, Templates and Clipart in progress Martina?
Tutorials Proposed Jean Create tutorials targeted at specific audiences; see this page for details.
Update Doc Project webpages
In progress Jean

Specific pages in need of help:

SetupGuide v2

Common install instructions

Information for advanced users

Details, which do not directly belong to programming.

In progress

Make an index page

Create_a_New_Custom_Shape_in_Source_in_File has empty sections and needs a lot of pictures.

Internal/Umbrella Projects

Project Status Owner Help Wanted
Wiki Help stalled <TBD>
Wiki Editing Policy ongoing <TBD>
Wiki Books started <TBD>
Structure of the Documentation project proposed Martina
Help Release Process planned <TBD>
Curriculum Development proposed <TBD>
Help Content Cleanup proposed Martina
Competitive Documentation Analysis ongoing Martina please help discussing the results
OOo-MSO Compatibility proposed <TBD> Collect info: problems & solutions
Help Style Guide in progress Martina please report further Style inconsistencies
Word List for User Guides Draft Jean Add more words and phrases as needed

Old project related information

Personal tools