DocBook Editor Feature

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Docbook editor initial feature proposal.)
 
(Please enhance the "How to test section"--see the discussion tab for more information)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
 
= Feature Name =
 
= Feature Name =
  
Line 14: 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 ==
  
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.
+
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.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
Line 25: Line 26:
  
 
It has following benefits:
 
It has following benefits:
* This enables new users to contribute documentation more easily then having to learn Docbook Format
+
* It enables new users to contribute documentation more easily without having to learn DocBook Format.
* Can be used just like any other desktop editor by people to generate documentation for their own purposes.
+
* It 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
+
* 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.
Do-It-Yourself learning methods. Changes done in design view can be related to what happens under
+
* 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.
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 ==
 
== Scope ==
 
<!-- 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 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.
+
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 ==
 
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them. The more specific you can be, the better the community testing can be.
 
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them. The more specific you can be, the better the community testing can be.
  
This is a web based application that works in Firefox (other browser currently not supported)
+
This is a web-based application that works in Firefox (other browser currently not supported).
and hence very much platform independent.
+
  
 
Installation requires:
 
Installation requires:
Line 47: Line 45:
 
2. PHP-XSL support
 
2. PHP-XSL support
 
3. PHP-Curl support
 
3. PHP-Curl support
4. Write permissions for your web server
+
4. Write permissions for your web server.
  
 
More notes on installing Beacon at http://92.243.5.147/beacon/beacon.html
 
More notes on installing Beacon at http://92.243.5.147/beacon/beacon.html
Line 53: Line 51:
 
The installation should be handled by an RPM (which I am working on at the moment).
 
The installation should be handled by an RPM (which I am working on at the moment).
  
The most basic form of testing will involve a check on how 'sane' is the XML source being generated by the tool and whether it actually meets the standards or not.
+
The most basic form of testing will involve a check on how 'sane' the XML source being generated by the tool is and whether it actually meets the standards or not.
  
 
Other than that its more of a usability study.
 
Other than that its more of a usability study.
Line 60: Line 58:
 
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
 
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
  
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.
+
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.
  
 
== Dependencies ==
 
== Dependencies ==
Line 66: Line 64:
 
or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
 
or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
  
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.
+
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.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour." Or it might not. If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour." Or it might not. If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
  
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.
+
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.
  
 
== Documentation ==
 
== Documentation ==
 
<!-- 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 82: 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/YourFeatureName]]  <!-- 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
Need to add all links here that refer to the mailing list discussion, summer of code project page, etc.
+
* 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