Difference between revisions of "Documentation/Dashboard/CMS Evaluation"

From Apache OpenOffice Wiki
Jump to: navigation, search
m (Tools to Evaluate: added wiki pro's & con's)
 
(27 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Documentation/Banner}}
+
{{DocBanner}}
=CMS Evaluation for Multilingual Documentation Maintenance=
+
{{DISPLAYTITLE:CMS Evaluation for Multilingual Documentation Maintenance}}
 +
 
 +
== Purpose of this page ==
  
 
This page is intended to collect and discuss requirements, processes, and tools to
 
This page is intended to collect and discuss requirements, processes, and tools to
implement a '''content management framework''' that allows maintenance of multilingual
+
implement a '''content management framework''' that allows '''maintenance of multilingual
documentation. The goal is to find a way to intelligently create, update, localize, and  
+
documentation'''.  
 +
 
 +
The goal is to find a way to intelligently create, update, localize, and  
 
publish documentation in multiple languages. We are in agreement, that the current
 
publish documentation in multiple languages. We are in agreement, that the current
 
Mediawiki-based solution, while having unbeatably low barrier to contribution, lacks
 
Mediawiki-based solution, while having unbeatably low barrier to contribution, lacks
Line 10: Line 14:
 
languages, and publish documentation that went through review and quality  
 
languages, and publish documentation that went through review and quality  
 
assurance cycles.
 
assurance cycles.
 +
 +
== Open Questions ==
 +
 +
# Will the CMS also be used as publication platform for users?
 +
 +
==Scenarios==
 +
 +
...
 +
 +
{{Spacer|20}}
  
 
==Requirements==
 
==Requirements==
  
Enter requirements that a content management framework should meet. Think
+
Enter requirements that a content management framework should meet. Think problem, not solution.
problem, not solution.
+
  
{|border=1 style="border-collapse:collapse;" cellpadding=3 width=100%
+
{|class="prettytable sortable"
|-style="background-color:#AACCFF"
+
!Requirement !!Priority !!Notes
+
 
|-
 
|-
|'''Usability:''' easy of use and unambiguousness for end users
+
!Requirement !!Description !!Examples
 +
|-valign=top
 +
|Access Control
 +
|Availability of customizable user group access levels, document based, document-type based, or document-status based
 +
|
 +
|-valign=top
 +
|Multi-Language Access
 +
|GUI must be available in multiple languages, switching between document languages
 +
|
 +
|-valign=top
 +
|Localization
 +
|Allow for localization of documents, availability of glossary, terminology, translation memory, or interface to external localization tools and formats
 +
|
 +
|-valign=top
 +
|Document Workflow
 +
|Document creation and maintenance must take place inside a customizable work flow including steps to create, edit, review, publish, and archive documents in multiple languages
 +
|
 +
|-valign=top
 +
|Document Publication
 +
|Ability to publish documents internally and to different sites in different formats (ODF, PDF, HTML)
 +
|
 +
|-valign=top
 +
|Extensability
 +
|Framework to add extensions that provide special services, availability of vibrant extension development community
 +
|
 +
|-valign=top
 +
|API for programmatic access
 +
|Ability to automate tasks like mass-changes to documents using API access
 +
|
 +
|-valign=top
 +
|Metrics
 +
|Ability to measure access and usage metrics
 +
|
 +
|-valign=top
 +
|ODF support
 +
|Support of ODF documents, metadata evaluation, search in ODF, ODF diffs, plugging of OOo instances
 +
|
 +
|-valign=top
 +
|WYSIWYG support
 +
|Support of WYSIWYG editor for non-ODF content
 +
|
 +
|-valign=top
 +
|Document Versioning
 +
|Version control of documents, ability to recover/rollback old versions, milestones, creating release tags across different documents/languages
 +
|
 +
|-valign=top
 +
|Document Rating
 +
|Rating of documents by readers (only required if CMS will also be the publication framework)
 +
|
 +
|-valign=top
 +
|Comments
 +
|Add comments to documents by readers (only required if CMS will also be the publication framework)
 +
|
 +
|-valign=top
 +
|Ease of Use
 +
|
 +
|
 +
|-valign=top
 +
|Registration with click-through agreement
 +
|New users of the framework may need to agree to Terms of Use
 +
|
 +
|-valign=top
 +
|License maintenance
 +
|Ability to attach different licenses to different content pieces. Ability to track license usage and mixing of licenses in aggregated content.
 +
|
 +
|-valign=top
 +
|Content aggregation
 +
|Ability to aggregate content modules to different documentation types.
 +
|
 +
|}
 +
 
 +
<!--
 +
{|class="prettytable sortable"
 +
|-
 +
!Requirement !!Description !!Priority !!Notes
 +
|-
 +
|Usability
 +
|Easy of use and unambiguousness for end users
 
* search confined to one language (eventually with optional search in several different languages)
 
* search confined to one language (eventually with optional search in several different languages)
 
* clearcut content (e.g. "user help & program documentation"), not intermingled with project related stuff (like in the services-wiki)
 
* clearcut content (e.g. "user help & program documentation"), not intermingled with project related stuff (like in the services-wiki)
|Highest ;-)
+
|High
 
|if the intended target audience for the tool is the end user (if not, cancel this req!)
 
|if the intended target audience for the tool is the end user (if not, cancel this req!)
 
|-
 
|-
|'''Easy translation process:''' with one mouseclick to template for translation <br />The translation is reached by a flag-language-changer.
+
|Easy translation process
|Very high
+
|with one mouseclick to template for translation <br />The translation is reached by a flag-language-changer.
 +
|High
 
|
 
|
 
|-
 
|-
|'''Different documentation formats:''' Different mimetypes are allowed to up- and download.<br />ODF-Files and PDF-Files are displayed inside the framework without converting.
+
|Different documentation formats
|Very high ;-)
+
|Different mimetypes are allowed to up- and download.<br />ODF-Files and PDF-Files are displayed inside the framework without converting.
 +
|High
 
|See and read online, what you could get :-)
 
|See and read online, what you could get :-)
 
|-
 
|-
|'''Workflow management:''' Different areas of documentation types: from lower proof of quality to high proof (with workflow).<br />Management of rights for every object inside the framework (directory, file etc.)
+
|Workflow management
|Very high ;-)
+
|Different areas of documentation types: from lower proof of quality to high proof (with workflow).<br />Management of rights for every object inside the framework (directory, file etc.)
 +
|High
 
|Like in OOoAuthors we also need documentation with high quality ;-)
 
|Like in OOoAuthors we also need documentation with high quality ;-)
 
|-
 
|-
|'''Not finished documents unpublished:''' Documentation, which are in work and not finished could hold status private.
+
|Draft Documentation
 +
|Documentation, which are in work and not finished could hold status private.
 
|high
 
|high
 
|Work could be saved on the server (also it is not fished and ready for publishing)
 
|Work could be saved on the server (also it is not fished and ready for publishing)
 
|-
 
|-
|'''Dynamic navigation bar:''' A dynamic and quick to use navigation bar to navigate in the structure. Easy change to another language (with language changer / flag)
+
|Dynamic navigation bar
 +
|A dynamic and quick to use navigation bar to navigate in the structure. Easy change to another language (with language changer / flag)
 
|high
 
|high
 
|
 
|
 
|-
 
|-
|'''Different skins /views for anonymous visitors and contributors:''' An anonymous visitor needs only displayed content. A contributor needs a framework with tools (for editing etc.)
+
|Different skins /views for anonymous visitors and contributors
 +
|An anonymous visitor needs only displayed content. A contributor needs a framework with tools (for editing etc.)
 +
|high
 +
|
 +
|-
 +
|Modularity
 +
|Being able to aggregate content modules in different documentation types
 +
|high
 +
|
 +
|-
 +
|Automatic output to PDF/ODF
 +
|for post-processing, for example hardcopy publishing, bundling
 +
|medium
 +
|
 +
|-
 +
|API for automated content processing
 +
|for implementing bot-based changes, accessing content from outside and feed them into other (publication) processes
 +
|medium
 +
|
 +
|-
 +
|Extensible
 +
|for being able to extend the framework with additional functionality (for example, thru plugin technology)
 +
|medium
 +
|
 +
|-
 +
|Controlled access
 +
|Making sure that access rights can be controlled. Users must agree to Terms of Use and sign Contributor Agreement.
 
|high
 
|high
 
|
 
|
 
|}
 
|}
 +
//-->
 +
{{Spacer|20}}
  
 
==Tools to Evaluate==
 
==Tools to Evaluate==
  
{|border=1 style="border-collapse:collapse;" cellpadding=3 width=100%
+
See also the [http://en.wikipedia.org/wiki/List_of_content_management_systems#Free_and_open_source_software Wikipedia list of CMSs]
|-style="background-color:#AACCFF"
+
 
!Tool !!Description/URL !!Pros !!Cons
+
{|class="prettytable sortable"
|-
+
|-valign=top
|Plone
+
! Tool !! Description !! Pros !! Cons
|CMS built on top of Zope, e.g. [http://www.oooauthors.org http://www.oooauthors.org]
+
|-valign=top
 +
|[http://plone.org/ Plone]
 +
|CMS built on top of Zope, e.g. [http://www.oooauthors.org http://www.oooauthors.org], [http://www.plone.org http://www.plone.org]
 
|
 
|
 +
* very low entry threshold
 +
* dynamic navigation
 +
* tools for editing like wordprocessor
 +
* multilingual support right out of the box
 +
* external editor posible
 +
* many extensions (products) available
 +
* ODF files support (also preview inside the cms)
 +
* customizable workflow for every folder / subproject / nat-lang-group
 +
* finetuning of rights for every function
 
|
 
|
|-
+
|-valign=top
|Mediawiki with Extensions
+
|[http://www.mediawiki.org Mediawiki with Extensions]
 
|
 
|
|supposed lowest entry threshold; <br>best suited for setting up a "quick and dirty pilot environment" <br>(e.g. for trying out workflows)
+
|
|not well suited to implement specific behavior<br>(e.g. automatized workflows)
+
* supposed lowest entry threshold
|-
+
* best suited for setting up a "quick and dirty pilot environment" (e.g. for trying out workflows)
|Drupal
+
* very large estension base
|Very popular CMS: http://drupal.org/
+
* existing implementation
|Rich in multilingual and translation support<br>Very widely used, so familiar to users
+
|
 +
* not well suited to implement specific behavior (e.g. automatized workflows)
 +
|-valign=top
 +
|[http://drupal.org/ Drupal]
 +
|Very popular CMS
 +
|
 +
* Rich in multilingual and translation support
 +
* Very widely used, so familiar to users
 +
* Already used for http://extensions.services.openoffice.org and http://templates.services.openoffice.org
 +
* Thousands of contributed modules available for fine-tuning
 +
* Availability of open and free collaboration solutions based on Drupal, like http://openatrium.com
 +
|
 +
|-valign=top
 +
|[http://www.alfresco.com/ Alfresco]
 +
|Alfresco is the Open Source Alternative for Enterprise Content Management (ECM), providing Document Management, Collaboration, Records Management, Knowledge Management, Web Content Management and Imaging.
 +
|
 +
* sophisticated, enterprise-level CMS
 +
* ODF integration
 +
|Learning curve?
 +
|-valign=top
 +
|Joomla
 +
|
 +
|
 +
|
 +
|-valign=top
 +
|Mambo
 +
|
 +
|
 +
|
 +
|-valign=top
 +
|OpenCMS
 +
|
 +
|
 +
|
 +
|-valign=top
 +
|O3Spaces
 +
|
 +
|
 +
|
 +
|-valign=top
 +
|[http://cocoondev.org/daisy/index.html Daisy]
 +
|Daisy is a content management system that offers rich out-of-the-box functionality combined with solid foundations for extensibility and integration. Daisy consists of two main components:
 +
* a stand-alone repository server accessible through HTTP/XML (using the ReST style of WebServices) and/or a high-level (remote) Java API, and
 +
* an extensive editing and publishing front-end web application running inside Apache Cocoon.
 +
(copied from the Daisy website)
 +
|
 +
* WYSIWYG editing
 +
* Document inclusions
 +
* PDF publishing of single pages or collections of pages as a book
 
|
 
|
 
|}
 
|}
 +
[[Category: Documentation/Dashboard]]

Latest revision as of 21:33, 7 July 2018

doc OOo


Purpose of this page

This page is intended to collect and discuss requirements, processes, and tools to implement a content management framework that allows maintenance of multilingual documentation.

The goal is to find a way to intelligently create, update, localize, and publish documentation in multiple languages. We are in agreement, that the current Mediawiki-based solution, while having unbeatably low barrier to contribution, lacks basic content management functions required to maintain documentation in multiple languages, and publish documentation that went through review and quality assurance cycles.

Open Questions

  1. Will the CMS also be used as publication platform for users?

Scenarios

...

Requirements

Enter requirements that a content management framework should meet. Think problem, not solution.

Requirement Description Examples
Access Control Availability of customizable user group access levels, document based, document-type based, or document-status based
Multi-Language Access GUI must be available in multiple languages, switching between document languages
Localization Allow for localization of documents, availability of glossary, terminology, translation memory, or interface to external localization tools and formats
Document Workflow Document creation and maintenance must take place inside a customizable work flow including steps to create, edit, review, publish, and archive documents in multiple languages
Document Publication Ability to publish documents internally and to different sites in different formats (ODF, PDF, HTML)
Extensability Framework to add extensions that provide special services, availability of vibrant extension development community
API for programmatic access Ability to automate tasks like mass-changes to documents using API access
Metrics Ability to measure access and usage metrics
ODF support Support of ODF documents, metadata evaluation, search in ODF, ODF diffs, plugging of OOo instances
WYSIWYG support Support of WYSIWYG editor for non-ODF content
Document Versioning Version control of documents, ability to recover/rollback old versions, milestones, creating release tags across different documents/languages
Document Rating Rating of documents by readers (only required if CMS will also be the publication framework)
Comments Add comments to documents by readers (only required if CMS will also be the publication framework)
Ease of Use
Registration with click-through agreement New users of the framework may need to agree to Terms of Use
License maintenance Ability to attach different licenses to different content pieces. Ability to track license usage and mixing of licenses in aggregated content.
Content aggregation Ability to aggregate content modules to different documentation types.

Tools to Evaluate

See also the Wikipedia list of CMSs

Tool Description Pros Cons
Plone CMS built on top of Zope, e.g. http://www.oooauthors.org, http://www.plone.org
  • very low entry threshold
  • dynamic navigation
  • tools for editing like wordprocessor
  • multilingual support right out of the box
  • external editor posible
  • many extensions (products) available
  • ODF files support (also preview inside the cms)
  • customizable workflow for every folder / subproject / nat-lang-group
  • finetuning of rights for every function
Mediawiki with Extensions
  • supposed lowest entry threshold
  • best suited for setting up a "quick and dirty pilot environment" (e.g. for trying out workflows)
  • very large estension base
  • existing implementation
  • not well suited to implement specific behavior (e.g. automatized workflows)
Drupal Very popular CMS
Alfresco Alfresco is the Open Source Alternative for Enterprise Content Management (ECM), providing Document Management, Collaboration, Records Management, Knowledge Management, Web Content Management and Imaging.
  • sophisticated, enterprise-level CMS
  • ODF integration
Learning curve?
Joomla
Mambo
OpenCMS
O3Spaces
Daisy Daisy is a content management system that offers rich out-of-the-box functionality combined with solid foundations for extensibility and integration. Daisy consists of two main components:
  • a stand-alone repository server accessible through HTTP/XML (using the ReST style of WebServices) and/or a high-level (remote) Java API, and
  • an extensive editing and publishing front-end web application running inside Apache Cocoon.

(copied from the Daisy website)

  • WYSIWYG editing
  • Document inclusions
  • PDF publishing of single pages or collections of pages as a book
Personal tools