DocBook Editor Feature

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Comments and Discussion)
(Please enhance the "How to test section"--see the discussion tab for more information)
 
(14 intermediate revisions by 3 users not shown)
Line 13: Line 13:
 
== Current status ==
 
== Current status ==
 
* Targeted release: [[Releases/12 |  Fedora 12]]
 
* Targeted release: [[Releases/12 |  Fedora 12]]
* Last updated: NA
+
* Last updated: 2009-06-01
* Percentage of completion: Not started yet.
+
* Percentage of completion: 5%
 +
* Minimal tag-set can be found at [[DocBook_Editor]]
 +
* XSL is being created.
  
 
== Detailed Description ==
 
== Detailed Description ==
Line 32: Line 34:
 
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
  
This is being started as a Google Summer of Code Project. It will be useable (Ready for consumption) by the end of GSoC period. It is not a big 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 Plug-in along with Beacon as a package so it can be installed/uninstalled by the user.
+
This is being started as a Google Summer of Code Project (http://socghop.appspot.com/student_project/show/google/gsoc2009/redhat/t124024692194). It will be useable (Ready for consumption) by the end of GSoC period. It is not a big 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 Plug-in along with Beacon as a package so it can be installed/uninstalled by the user.
  
 
== How To Test ==
 
== How To Test ==
Line 72: Line 74:
 
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
 
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
  
A detailed but under construction documentation is available at http://92.243.5.147/beacon/beacon.html
+
Documentation is available at [[DocBook_Editor_Documentation]]
  
 
== Release Notes ==
 
== Release Notes ==
Line 78: Line 80:
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
  
This is yet to be released.
+
Fedora 12 ships with Beacon, a WYSWIG editor for Docbook that enables Documentation writers to write documentation for Fedora with minimal Docbook experience.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
 
* See [[Talk:Features/DocBookEditor]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
 
* See [[Talk:Features/DocBookEditor]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
 
* Discussion on the fedora docs list: https://www.redhat.com/archives/fedora-docs-list/2009-March/msg00077.html
 
* Discussion on the fedora docs list: https://www.redhat.com/archives/fedora-docs-list/2009-March/msg00077.html
 +
* Discussion on Redhat Summer group: http://groups.google.com/group/redhat-summer/browse_thread/thread/73d39120e5aa6ffc
  
 
[[Category:FeaturePageIncomplete]]
 
[[Category:FeaturePageIncomplete]]

Latest revision as of 00:54, 12 June 2009

Contents

[edit] Feature Name

DocBook Editor

[edit] Summary

A WYSIWYG DocBook Editor

[edit] Owner

[edit] Current status

  • Targeted release: Fedora 12
  • Last updated: 2009-06-01
  • Percentage of completion: 5%
  • Minimal tag-set can be found at DocBook_Editor
  • XSL is being created.

[edit] 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-in for 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.

[edit] Benefit to Fedora

It has following benefits:

  • It enables new users to contribute documentation more easily without having to learn DocBook Format.
  • It can be used just like any other desktop editor by people to generate documentation for their own purposes.
  • It can be used as a tool to learn documentation formats by the WYSIWYG approach. This is similar to Do-It-Yourself learning methods as the changes made in the design view can be correlated to the changes introduced in the XML source view.
  • It will be integrated into Zikula CMS which will be used by Fedora to manage their content. This will make it easier to publish content.

[edit] Scope

This is being started as a Google Summer of Code Project (http://socghop.appspot.com/student_project/show/google/gsoc2009/redhat/t124024692194). It will be useable (Ready for consumption) by the end of GSoC period. It is not a big 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 Plug-in along with Beacon as a package so it can be installed/uninstalled by the user.

[edit] 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 plug-ins). The benefits to end-user are given in the 'Benefits to Fedora' section.

[edit] Dependencies

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

[edit] Contingency Plan

No other parts of Fedora will be affected by it. It is a web application with minimal or no implications on other parts of Fedora. It is a standalone tool.

[edit] Documentation

Documentation is available at DocBook_Editor_Documentation

[edit] Release Notes

Fedora 12 ships with Beacon, a WYSWIG editor for Docbook that enables Documentation writers to write documentation for Fedora with minimal Docbook experience.

[edit] Comments and Discussion