I will try to help this effort as much as I can
Jacques
From: "Scott Gray" <[EMAIL PROTECTED]>
Thanks David, when I get a chance I'll break them out into confluence
pages then perhaps rewrite them so they read like docs rather than a
transcript. As I'm doing that I'll see what more can go into the xsd
files.
Regards
Scott
2008/9/23 David E Jones <[EMAIL PROTECTED]>:
Sorry about the delay on this Scott.
I just attached Word Doc files for the Advanced Framework and Framework
Introduction Transcriptions:
http://docs.ofbiz.org/display/OFBTECH/Advanced+Framework+Transcription+Work+Plan
-David
On Aug 12, 2008, at 3:48 AM, Scott Gray wrote:
Hi David,
I'd like to spend some time converting the framework docs into
confluence pages, which will hopefully make it more digestible for
inclusion in xsd files and the like. But I'm having trouble
extracting the text because of the 2 page layout in the pdf, do you
have any other formats available?
Thanks
Scott
2008/5/24 David E Jones <[EMAIL PROTECTED]>:
As part of the effort to do a GA release of the framework documentation
can
play a big role in how much it is adopted and how well it is used. This
is
of course true for OFBiz in general as well, related to the framework
specifically for the point of this email.
Anyway, the more comprehensive body of knowledge I'm aware of is in the
advanced framework training videos from Hotwax Media (previously from
Undersun Consulting). These are nearly 2 years old now, but still cover
around 90-95% of the framework as it stands today.
The material includes lots of intro and overview text, lots of reference
text (descriptions of EVERY xml element/attribute that existed at the
time),
and lots of example descriptions.
The video transcript and the framework quick reference book it describes
are
now available for free download on docs.ofbiz.org. They are attached to a
page that I have started (not yet finished, help wanted on this too) to
list
every section of the transcription and who is working on it, and what the
status is.
Please check out this page and help with this effort to get annotations
in
for every element and attribute in the OFBiz XSD files, and to compile a
good set of intro/overview docs and example descriptions that people can
use
to learn about the OFBiz framework.
I plan to work on this myself, but it's a BIG project and we need all the
help we can get.
Note that to edit many of these things you need access to the technical
documentation space on the docs.ofbiz.org site. If you have not already
volunteered for helping with docs and you don't have permission, please
let
me know and we'll talk about your planned involvement and then decide on
the
best way to move forward so you can help out.
Please note that all XSD changes should be submitted as patches through
Jira.
I'm excited to see this happening, and want to thank the partners at
Hotwax
who are behind this direction and have released the IP of this stuff to
make
it happen.
The page in Confluence on docs.ofbiz.org is here:
http://docs.ofbiz.org/display/OFBTECH/Advanced+Framework+Transcription+Work+Plan
-David
