Version 1 by Steven Brown
on Mar 27, 2008 07:44.

compared with
Current by Steven Brown
on Mar 27, 2008 07:59.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (35)

View Page History
{info:title=New Proposal Template}
This page has been created from a template that uses "zones." To proceed:
<ac:macro ac:name="note"><ac:parameter ac:name="title">Under Construction</ac:parameter><ac:rich-text-body>
<p>This proposal is under construction and is not ready for review.</p></ac:rich-text-body></ac:macro>

# Edit the page
# Replace sample content within each zone-data tag
# Remove this notice
# Save the page
# When you are ready for review, remove the (!) Under Construction notice
{info}
<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[{zone-template-instance:ZFDEV:Zend Proposal Zone Template}

{note:title=Under Construction}
This proposal is under construction and is not ready for review.
{note}

{zone-template-instance:ZFDEV:Zend Proposal Zone Template}

{zone-data:component-name}
Zend_Something_Or_Other Zend_Office
{zone-data}

{zone-data:proposer-list}
[My E-mail Address|mailto:noreply@zend.com]
[Steven Brown|mailto:steven@yewchube.com]
{zone-data}

{zone-data:revision}
1.1 - 1 August 2006: Updated from community comments.
0.1 - 27 March 2008: Created.
{zone-data}

{zone-data:overview}
Zend_Magic is a simple component that reads my mind and generates code dynamically to do what I want.
Zend_Office will provide the ability to work with Microsoft Office documents, in particular Word and Excel files. The format of preference will be the open xml format but it may be possible to provide simple binary format functionality. Open Office formats could also be supported.
{zone-data}

{zone-data:references}
* [Harry Houdini Wikipedia Entry|http://en.wikipedia.org/wiki/Harry_Houdini]
* [MagicTricks.com|http://www.magictricks.com/]
* [Microsoft Office Binary File Format Specifications|http://www.microsoft.com/interop/docs/OfficeBinaryFormats.mspx]
* [Microsoft Office Open XML Developer Site|http://openxmldeveloper.org/default.aspx]
* [OpenOffice.org File Format Specifications|http://xml.openoffice.org/general.html]
{zone-data}

{zone-data:requirements}
Most requirements take the form of "foo will do ...." or "foo will not support ...", although different words and sentence structure might be used. Adding functionality to your proposal is requirements creep (bad), unless listed below. Discuss major changes with your team first, and then open a "feature improvement" issue against this component.

* This component *will* correctly reads a developers mind for intent and generate the right configuration file.
* The generated config file *will not* support XML, but will provide an extension point in the API.
* This component *will* use no more memory than twice the size of all data it contains.
* This component *will* include a factory method.
* This component *will not* allow subclassing. (i.e. when reviewed, we expect to see "final" keyword in code)
* This component *will* only generate data exports strictly complying with RFC 12345.
* This component *will* validate input data against formats supported by ZF component Foo.
* This component *will not* save any data using Zend_Cache or the filesystem. All transient data *will be* saved using Zend_Session.
* This component *will* allow opening of the mentioned file formats.
* This component *will* allow creation of the mentioned file formats.
* This component *will* allow editing of the mentioned file formats.
* This component *will* allow saving of the mentioned file formats.
* This component *will* allow conversion between the mentioned file formats.
{zone-data}


{zone-data:operation}
The component is instantiated with a mind-link that ...
The developer loads or creates a file, gets information or makes any changes necessary, then discards or saves the file.
{zone-data}

{zone-data:milestones}
Describe some intermediate state of this component in terms of design notes, additional material added to this page, and / code. Note any significant dependencies here, such as, "Milestone #3 can not be completed until feature Foo has been added to ZF component XYZ." Milestones will be required for acceptance of future proposals. They are not hard, and many times you will only need to think of the first three below.
* Milestone 1: [design notes will be published here|http://framework.zend.com/wiki/x/sg]
* Milestone 1: Write specification.
* Milestone 2: Working prototype checked into the incubator supporting use cases #1, #2, ... Office Open XML Word and Excel formats.
* Milestone 3: Working prototype checked into the incubator supporting use cases #3 and #4.
* Milestone 3: Working prototype checked into the incubator supporting OpenOffice.org word processor and spreadsheet formats.
* Milestone 4: Working prototype checked into the incubator supporting Office Binary Word and Excel formats (maybe).
* Milestone 45: Unit tests exist, work, and are checked into SVN.
* Milestone 56: Initial documentation exists.

If a milestone is already done, begin the description with "\[DONE\]", like this:
* Milestone #: \[DONE\] Unit tests ...
{zone-data}

{zone-data:class-list}
* Zend_Magic_Exception Zend_Office_Exception
* Zend_Magic (factory class)
* Zend_Magic_MindProbe Zend_Office_Word
* Zend_Magic_MindProbe_Intent Zend_Office_Spreadsheet
* Zend_Magic_Action
* Zend_Magic_CodeGen
{zone-data}

{zone-data:use-cases}
||UC-01||

... (see good use cases book)
{zone-data}

{zone-data:skeletons}
{code}
class Zend_Magic_Exception extends Zend_Exception {}

class Zend_Magic {
...
{code}
{zone-data}

{zone-template-instance}
{zone-template-instance}]]></ac:plain-text-body></ac:macro>