Difference between revisions of "Documentation/Dashboard/CMS Evaluation"
(→Requirements) |
|||
(19 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{DocBanner}} |
{{DISPLAYTITLE: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== | ||
Line 15: | Line 29: | ||
Enter requirements that a content management framework should meet. Think problem, not solution. | Enter requirements that a content management framework should meet. Think problem, not solution. | ||
− | {|class=" | + | {|class="prettytable sortable" |
− | |- | + | |- |
+ | !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 | !Requirement !!Description !!Priority !!Notes | ||
|- | |- | ||
Line 81: | Line 169: | ||
| | | | ||
|} | |} | ||
+ | //--> | ||
+ | {{Spacer|20}} | ||
==Tools to Evaluate== | ==Tools to Evaluate== | ||
Line 87: | Line 177: | ||
{|class="prettytable sortable" | {|class="prettytable sortable" | ||
− | |- | + | |-valign=top |
− | !Tool !!Description | + | ! Tool !! Description !! Pros !! Cons |
− | |- | + | |-valign=top |
|[http://plone.org/ Plone] | |[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] | |CMS built on top of Zope, e.g. [http://www.oooauthors.org http://www.oooauthors.org], [http://www.plone.org http://www.plone.org] | ||
Line 100: | Line 190: | ||
* many extensions (products) available | * many extensions (products) available | ||
* ODF files support (also preview inside the cms) | * 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 |
|[http://www.mediawiki.org Mediawiki with Extensions] | |[http://www.mediawiki.org Mediawiki with Extensions] | ||
| | | | ||
Line 111: | Line 203: | ||
| | | | ||
* not well suited to implement specific behavior (e.g. automatized workflows) | * not well suited to implement specific behavior (e.g. automatized workflows) | ||
− | |- | + | |-valign=top |
|[http://drupal.org/ Drupal] | |[http://drupal.org/ Drupal] | ||
|Very popular CMS | |Very popular CMS | ||
Line 117: | Line 209: | ||
* Rich in multilingual and translation support | * Rich in multilingual and translation support | ||
* Very widely used, so familiar to users | * 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] | |[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. | |Alfresco is the Open Source Alternative for Enterprise Content Management (ECM), providing Document Management, Collaboration, Records Management, Knowledge Management, Web Content Management and Imaging. | ||
Line 125: | Line 220: | ||
* ODF integration | * ODF integration | ||
|Learning curve? | |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
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
- 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 |
|
|
Mediawiki with Extensions |
|
| |
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. |
|
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:
(copied from the Daisy website) |
|