DocBook Editor Feature

From FedoraProject

Revision as of 15:01, 7 May 2009 by Satyak (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

Feature Name

DocBook Editor

Summary

A WYSIWYG DocBook Editor

Owner

Current status

  • Targeted release: Fedora 12
  • Last updated: NA
  • Percentage of completion: Not started yet.

Detailed Description

This feature aims at implementing a WYSIWYG editor for DocBook XML that Fedora uses to author/maintain its documentation. The richness of DocBook can often overwhelm new users. An easy to use tool will attract new contributors and will also provide a convenient alternative to those who are old-timers.The editor will be developed as a plug-infor Beacon, an XSLT based plug-able editor. The editor can be used as a stand-alone application or can be integrated with Zikula and Publican.

Benefit to Fedora

It has following benefits:

  • This enables new users to contribute documentation more easily then having to learn Docbook Format
  • Can be used just like any other desktop editor by people to generate documentation for their own purposes.
  • Can be used as a tool to learn documentation formats by the WYSIWYG approach. Similar to

Do-It-Yourself learning methods. Changes done in design view can be related to what happens under the hood.

  • Will be integrated into Zikula CMS which will be used by Fedora to manage their content. Makes it easier to publish content.

Scope

This is being kicked off as a Google Summer of Code Project. It'll be in useable state (Ready for consumption) by the end of that period. Its not a large change to the distribution and is more of an isolated End User product just like any other text editor. It basically involves deploying the Docbook Plugin along with Beacon as a package so it can be installed/uninstalled by the user.

How To Test

They will notice an editor available to them that allows them to publish documents in Docbook and/or other formats (supported by Beacon plugins). The benefits to end user are given in the 'Benefits to Fedora' section.

Dependencies

Beacon has minimal requirements for it to run. PHP 5 is the base requirement which is quite stable. The upstream project is willing to help in deploying it for multiple distributions.

Contingency Plan

No other parts of Fedora will be in jeopardy. Its a web app with minimal or no implications on other parts of Fedora. Its a standalone tool.

Documentation

Release Notes

This is yet to be released.

Comments and Discussion

Need to add all links here that refer to the mailing list discussion, summer of code project page, etc.