discussion: document proposal.

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

discussion: document proposal.

hans_bakker
Your input is required:

You probably noticed the big update?
My Apologies for its size but i think it is worth the effort.

To understand quickly where I am talking about, upgrade your local
version, reload your seed data (or run ant-install) and go to:
content -> content ->  navigate -> documents -> 'apache ofbiz in html
format'

Then you will see the xml document in file:
/applications/commonext/documents/ApacheOfbiz.xml
in html format.

The pdf format does not yet work...(Anybody can help: see comment in
svn)

-----------------------------------------------------------------------
The proposal is to move the documents from docs.ofbiz.org to the ofbiz
content manager.
-----------------------------------------------------------------------
What are the advantages?

     1. No external system required for documentation
     2. The content of the internal help files can be used within the
        documentation
     3. The documentation always has the same version as the system (It
        is part of it)
     4. The content is stored in a internationally accepted
        'DocBook' (www.docbook.org) format
     5. The content can be easily presented in the selected visual
        schemas (To be implemented)


What is the opinion of the community?

Regards,
Hans
--
Antwebsystems.com: Quality OFBiz services for competitive rates

Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Toddnick
Tracking doc versions through svn. Its an excellent idea.

On Thu, Aug 27, 2009 at 9:10 PM, Hans Bakker
<[hidden email]>wrote:

> Your input is required:
>
> You probably noticed the big update?
> My Apologies for its size but i think it is worth the effort.
>
> To understand quickly where I am talking about, upgrade your local
> version, reload your seed data (or run ant-install) and go to:
> content -> content ->  navigate -> documents -> 'apache ofbiz in html
> format'
>
> Then you will see the xml document in file:
> /applications/commonext/documents/ApacheOfbiz.xml
> in html format.
>
> The pdf format does not yet work...(Anybody can help: see comment in
> svn)
>
> -----------------------------------------------------------------------
> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
> content manager.
> -----------------------------------------------------------------------
> What are the advantages?
>
>     1. No external system required for documentation
>     2. The content of the internal help files can be used within the
>        documentation
>     3. The documentation always has the same version as the system (It
>        is part of it)
>     4. The content is stored in a internationally accepted
>        'DocBook' (www.docbook.org) format
>     5. The content can be easily presented in the selected visual
>        schemas (To be implemented)
>
>
> What is the opinion of the community?
>
> Regards,
> Hans
> --
> Antwebsystems.com: Quality OFBiz services for competitive rates
>
>


--
Todd Burdeinei
Web Developer
Burdeinei Corp
702-259-3273 office / fax number
702-372-9920 cell
[hidden email]
Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Adrian Crum
In reply to this post by hans_bakker
This sounds great! Thanks Hans!

-Adrian

Hans Bakker wrote:

> Your input is required:
>
> You probably noticed the big update?
> My Apologies for its size but i think it is worth the effort.
>
> To understand quickly where I am talking about, upgrade your local
> version, reload your seed data (or run ant-install) and go to:
> content -> content ->  navigate -> documents -> 'apache ofbiz in html
> format'
>
> Then you will see the xml document in file:
> /applications/commonext/documents/ApacheOfbiz.xml
> in html format.
>
> The pdf format does not yet work...(Anybody can help: see comment in
> svn)
>
> -----------------------------------------------------------------------
> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
> content manager.
> -----------------------------------------------------------------------
> What are the advantages?
>
>      1. No external system required for documentation
>      2. The content of the internal help files can be used within the
>         documentation
>      3. The documentation always has the same version as the system (It
>         is part of it)
>      4. The content is stored in a internationally accepted
>         'DocBook' (www.docbook.org) format
>      5. The content can be easily presented in the selected visual
>         schemas (To be implemented)
>
>
> What is the opinion of the community?
>
> Regards,
> Hans
Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Jacques Le Roux-2-2
Yes, bravo Hans! We have just to learn docBook now (but sounds easy)...

Jacques

From: "Adrian Crum" <[hidden email]>

> This sounds great! Thanks Hans!
>
> -Adrian
>
> Hans Bakker wrote:
>> Your input is required:
>>
>> You probably noticed the big update?
>> My Apologies for its size but i think it is worth the effort.
>>
>> To understand quickly where I am talking about, upgrade your local
>> version, reload your seed data (or run ant-install) and go to:
>> content -> content ->  navigate -> documents -> 'apache ofbiz in html
>> format'
>>
>> Then you will see the xml document in file:
>> /applications/commonext/documents/ApacheOfbiz.xml
>> in html format.
>>
>> The pdf format does not yet work...(Anybody can help: see comment in
>> svn)
>>
>> -----------------------------------------------------------------------
>> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
>> content manager.
>> -----------------------------------------------------------------------
>> What are the advantages?
>>
>>      1. No external system required for documentation
>>      2. The content of the internal help files can be used within the
>>         documentation
>>      3. The documentation always has the same version as the system (It
>>         is part of it)
>>      4. The content is stored in a internationally accepted
>>         'DocBook' (www.docbook.org) format
>>      5. The content can be easily presented in the selected visual
>>         schemas (To be implemented)
>>
>>
>> What is the opinion of the community?
>>
>> Regards,
>> Hans
>
Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Sharan-F
Thanks for all the work Hans - its sounds fantastic. Will take a look to see if there is anything I can help with.

Sharan

Jacques Le Roux-2 wrote
Yes, bravo Hans! We have just to learn docBook now (but sounds easy)...

Jacques

From: "Adrian Crum" <adrianc@hlmksw.com>
> This sounds great! Thanks Hans!
>
> -Adrian
>
> Hans Bakker wrote:
>> Your input is required:
>>
>> You probably noticed the big update?
>> My Apologies for its size but i think it is worth the effort.
>>
>> To understand quickly where I am talking about, upgrade your local
>> version, reload your seed data (or run ant-install) and go to:
>> content -> content ->  navigate -> documents -> 'apache ofbiz in html
>> format'
>>
>> Then you will see the xml document in file:
>> /applications/commonext/documents/ApacheOfbiz.xml
>> in html format.
>>
>> The pdf format does not yet work...(Anybody can help: see comment in
>> svn)
>>
>> -----------------------------------------------------------------------
>> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
>> content manager.
>> -----------------------------------------------------------------------
>> What are the advantages?
>>
>>      1. No external system required for documentation
>>      2. The content of the internal help files can be used within the
>>         documentation
>>      3. The documentation always has the same version as the system (It
>>         is part of it)
>>      4. The content is stored in a internationally accepted
>>         'DocBook' (www.docbook.org) format
>>      5. The content can be easily presented in the selected visual
>>         schemas (To be implemented)
>>
>>
>> What is the opinion of the community?
>>
>> Regards,
>> Hans
>
Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Jacques Le Roux
Administrator
As I don't want to learn all Docbook tags, I tried to install the Vex editor as a plugin in Eclipse (Ganymede == 3.4) but it's not
working (and is a known issue).
So I found a solution here http://www.nabble.com/Re%3A-Error-message-when-starting-eclipse-w-VEX-plugin-p13036761.html
It works but when I load it asks me about the version of docbook documents I use. I searched in ML but I'm not quite sure about it,
any ideas ?
BTW it looks like using OpenOffice (with a plugin?) could be a better solution
http://xml.openoffice.org/xmerge/docbook/UserGuide.html...

What I want to do is to put tips like that http://markmail.org/message/73e5wtnb2m4w4ikw in the online help. For instance this one
would be at the page https://localhost:8443/webtools/control/runService.
I'm sure this would be a great benefit for everybody

Thanks

Jacques

From: "Sharan-F" <[hidden email]>

>
> Thanks for all the work Hans - its sounds fantastic. Will take a look to see
> if there is anything I can help with.
>
> Sharan
>
>
> Jacques Le Roux-2 wrote:
>>
>> Yes, bravo Hans! We have just to learn docBook now (but sounds easy)...
>>
>> Jacques
>>
>> From: "Adrian Crum" <[hidden email]>
>>> This sounds great! Thanks Hans!
>>>
>>> -Adrian
>>>
>>> Hans Bakker wrote:
>>>> Your input is required:
>>>>
>>>> You probably noticed the big update?
>>>> My Apologies for its size but i think it is worth the effort.
>>>>
>>>> To understand quickly where I am talking about, upgrade your local
>>>> version, reload your seed data (or run ant-install) and go to:
>>>> content -> content ->  navigate -> documents -> 'apache ofbiz in html
>>>> format'
>>>>
>>>> Then you will see the xml document in file:
>>>> /applications/commonext/documents/ApacheOfbiz.xml
>>>> in html format.
>>>>
>>>> The pdf format does not yet work...(Anybody can help: see comment in
>>>> svn)
>>>>
>>>> -----------------------------------------------------------------------
>>>> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
>>>> content manager.
>>>> -----------------------------------------------------------------------
>>>> What are the advantages?
>>>>
>>>>      1. No external system required for documentation
>>>>      2. The content of the internal help files can be used within the
>>>>         documentation
>>>>      3. The documentation always has the same version as the system (It
>>>>         is part of it)
>>>>      4. The content is stored in a internationally accepted
>>>>         'DocBook' (www.docbook.org) format
>>>>      5. The content can be easily presented in the selected visual
>>>>         schemas (To be implemented)
>>>>
>>>>
>>>> What is the opinion of the community?
>>>>
>>>> Regards,
>>>> Hans
>>>
>>
>>
>
> --
> View this message in context: http://www.nabble.com/discussion%3A-document-proposal.-tp25183768p25215593.html
> Sent from the OFBiz - User mailing list archive at Nabble.com.
>


Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Jacques Le Roux
Administrator
It seems that we use Docbook V4.3 but, even with this information, I'm not sure the Eclipse plugin is very valuable

Jacques

From: "Jacques Le Roux" <[hidden email]>

> As I don't want to learn all Docbook tags, I tried to install the Vex editor as a plugin in Eclipse (Ganymede == 3.4) but it's not
> working (and is a known issue).
> So I found a solution here http://www.nabble.com/Re%3A-Error-message-when-starting-eclipse-w-VEX-plugin-p13036761.html
> It works but when I load it asks me about the version of docbook documents I use. I searched in ML but I'm not quite sure about
> it, any ideas ?
> BTW it looks like using OpenOffice (with a plugin?) could be a better solution
> http://xml.openoffice.org/xmerge/docbook/UserGuide.html...
>
> What I want to do is to put tips like that http://markmail.org/message/73e5wtnb2m4w4ikw in the online help. For instance this one
> would be at the page https://localhost:8443/webtools/control/runService.
> I'm sure this would be a great benefit for everybody
>
> Thanks
>
> Jacques
>
> From: "Sharan-F" <[hidden email]>
>>
>> Thanks for all the work Hans - its sounds fantastic. Will take a look to see
>> if there is anything I can help with.
>>
>> Sharan
>>
>>
>> Jacques Le Roux-2 wrote:
>>>
>>> Yes, bravo Hans! We have just to learn docBook now (but sounds easy)...
>>>
>>> Jacques
>>>
>>> From: "Adrian Crum" <[hidden email]>
>>>> This sounds great! Thanks Hans!
>>>>
>>>> -Adrian
>>>>
>>>> Hans Bakker wrote:
>>>>> Your input is required:
>>>>>
>>>>> You probably noticed the big update?
>>>>> My Apologies for its size but i think it is worth the effort.
>>>>>
>>>>> To understand quickly where I am talking about, upgrade your local
>>>>> version, reload your seed data (or run ant-install) and go to:
>>>>> content -> content ->  navigate -> documents -> 'apache ofbiz in html
>>>>> format'
>>>>>
>>>>> Then you will see the xml document in file:
>>>>> /applications/commonext/documents/ApacheOfbiz.xml
>>>>> in html format.
>>>>>
>>>>> The pdf format does not yet work...(Anybody can help: see comment in
>>>>> svn)
>>>>>
>>>>> -----------------------------------------------------------------------
>>>>> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
>>>>> content manager.
>>>>> -----------------------------------------------------------------------
>>>>> What are the advantages?
>>>>>
>>>>>      1. No external system required for documentation
>>>>>      2. The content of the internal help files can be used within the
>>>>>         documentation
>>>>>      3. The documentation always has the same version as the system (It
>>>>>         is part of it)
>>>>>      4. The content is stored in a internationally accepted
>>>>>         'DocBook' (www.docbook.org) format
>>>>>      5. The content can be easily presented in the selected visual
>>>>>         schemas (To be implemented)
>>>>>
>>>>>
>>>>> What is the opinion of the community?
>>>>>
>>>>> Regards,
>>>>> Hans
>>>>
>>>
>>>
>>
>> --
>> View this message in context: http://www.nabble.com/discussion%3A-document-proposal.-tp25183768p25215593.html
>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>
>
>


Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Jacques Le Roux
Administrator
In reply to this post by Jacques Le Roux
Thanks Hans sounds logical. Anyway, from my very limited experience, I guess The Eclipse plugin is not the ideal solution.

Jacques

From: "Hans Bakker" <[hidden email]>
To: "Jacques Le Roux" <[hidden email]>

>I installed docbook V5.....
>
> On Wed, 2009-09-02 at 08:29 +0200, Jacques Le Roux wrote:
>> As I don't want to learn all Docbook tags, I tried to install the Vex editor as a plugin in Eclipse (Ganymede == 3.4) but it's
>> not
>> working (and is a known issue).
>> So I found a solution here http://www.nabble.com/Re%3A-Error-message-when-starting-eclipse-w-VEX-plugin-p13036761.html
>> It works but when I load it asks me about the version of docbook documents I use. I searched in ML but I'm not quite sure about
>> it,
>> any ideas ?
>> BTW it looks like using OpenOffice (with a plugin?) could be a better solution
>> http://xml.openoffice.org/xmerge/docbook/UserGuide.html...
>>
>> What I want to do is to put tips like that http://markmail.org/message/73e5wtnb2m4w4ikw in the online help. For instance this one
>> would be at the page https://localhost:8443/webtools/control/runService.
>> I'm sure this would be a great benefit for everybody
>>
>> Thanks
>>
>> Jacques
>>
>> From: "Sharan-F" <[hidden email]>
>> >
>> > Thanks for all the work Hans - its sounds fantastic. Will take a look to see
>> > if there is anything I can help with.
>> >
>> > Sharan
>> >
>> >
>> > Jacques Le Roux-2 wrote:
>> >>
>> >> Yes, bravo Hans! We have just to learn docBook now (but sounds easy)...
>> >>
>> >> Jacques
>> >>
>> >> From: "Adrian Crum" <[hidden email]>
>> >>> This sounds great! Thanks Hans!
>> >>>
>> >>> -Adrian
>> >>>
>> >>> Hans Bakker wrote:
>> >>>> Your input is required:
>> >>>>
>> >>>> You probably noticed the big update?
>> >>>> My Apologies for its size but i think it is worth the effort.
>> >>>>
>> >>>> To understand quickly where I am talking about, upgrade your local
>> >>>> version, reload your seed data (or run ant-install) and go to:
>> >>>> content -> content ->  navigate -> documents -> 'apache ofbiz in html
>> >>>> format'
>> >>>>
>> >>>> Then you will see the xml document in file:
>> >>>> /applications/commonext/documents/ApacheOfbiz.xml
>> >>>> in html format.
>> >>>>
>> >>>> The pdf format does not yet work...(Anybody can help: see comment in
>> >>>> svn)
>> >>>>
>> >>>> -----------------------------------------------------------------------
>> >>>> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
>> >>>> content manager.
>> >>>> -----------------------------------------------------------------------
>> >>>> What are the advantages?
>> >>>>
>> >>>>      1. No external system required for documentation
>> >>>>      2. The content of the internal help files can be used within the
>> >>>>         documentation
>> >>>>      3. The documentation always has the same version as the system (It
>> >>>>         is part of it)
>> >>>>      4. The content is stored in a internationally accepted
>> >>>>         'DocBook' (www.docbook.org) format
>> >>>>      5. The content can be easily presented in the selected visual
>> >>>>         schemas (To be implemented)
>> >>>>
>> >>>>
>> >>>> What is the opinion of the community?
>> >>>>
>> >>>> Regards,
>> >>>> Hans
>> >>>
>> >>
>> >>
>> >
>> > --
>> > View this message in context: http://www.nabble.com/discussion%3A-document-proposal.-tp25183768p25215593.html
>> > Sent from the OFBiz - User mailing list archive at Nabble.com.
>> >
>>
>>
> --
> Antwebsystems.com: Quality OFBiz services for competitive rates
>


Reply | Threaded
Open this post in threaded view
|

Re: discussion: document proposal.

Jacques Le Roux
Administrator
Found the right solution, at least for me an Oxygen users
http://www.oxygenxml.com/docbook_editor.html?adw=true&gclid=CImBn9r2iZ0CFUxs4wodN0xf2w

Jacques

From: "Jacques Le Roux" <[hidden email]>

> Thanks Hans sounds logical. Anyway, from my very limited experience, I guess The Eclipse plugin is not the ideal solution.
>
> Jacques
>
> From: "Hans Bakker" <[hidden email]>
> To: "Jacques Le Roux" <[hidden email]>
>>I installed docbook V5.....
>>
>> On Wed, 2009-09-02 at 08:29 +0200, Jacques Le Roux wrote:
>>> As I don't want to learn all Docbook tags, I tried to install the Vex editor as a plugin in Eclipse (Ganymede == 3.4) but it's
>>> not
>>> working (and is a known issue).
>>> So I found a solution here http://www.nabble.com/Re%3A-Error-message-when-starting-eclipse-w-VEX-plugin-p13036761.html
>>> It works but when I load it asks me about the version of docbook documents I use. I searched in ML but I'm not quite sure about
>>> it,
>>> any ideas ?
>>> BTW it looks like using OpenOffice (with a plugin?) could be a better solution
>>> http://xml.openoffice.org/xmerge/docbook/UserGuide.html...
>>>
>>> What I want to do is to put tips like that http://markmail.org/message/73e5wtnb2m4w4ikw in the online help. For instance this
>>> one
>>> would be at the page https://localhost:8443/webtools/control/runService.
>>> I'm sure this would be a great benefit for everybody
>>>
>>> Thanks
>>>
>>> Jacques
>>>
>>> From: "Sharan-F" <[hidden email]>
>>> >
>>> > Thanks for all the work Hans - its sounds fantastic. Will take a look to see
>>> > if there is anything I can help with.
>>> >
>>> > Sharan
>>> >
>>> >
>>> > Jacques Le Roux-2 wrote:
>>> >>
>>> >> Yes, bravo Hans! We have just to learn docBook now (but sounds easy)...
>>> >>
>>> >> Jacques
>>> >>
>>> >> From: "Adrian Crum" <[hidden email]>
>>> >>> This sounds great! Thanks Hans!
>>> >>>
>>> >>> -Adrian
>>> >>>
>>> >>> Hans Bakker wrote:
>>> >>>> Your input is required:
>>> >>>>
>>> >>>> You probably noticed the big update?
>>> >>>> My Apologies for its size but i think it is worth the effort.
>>> >>>>
>>> >>>> To understand quickly where I am talking about, upgrade your local
>>> >>>> version, reload your seed data (or run ant-install) and go to:
>>> >>>> content -> content ->  navigate -> documents -> 'apache ofbiz in html
>>> >>>> format'
>>> >>>>
>>> >>>> Then you will see the xml document in file:
>>> >>>> /applications/commonext/documents/ApacheOfbiz.xml
>>> >>>> in html format.
>>> >>>>
>>> >>>> The pdf format does not yet work...(Anybody can help: see comment in
>>> >>>> svn)
>>> >>>>
>>> >>>> -----------------------------------------------------------------------
>>> >>>> The proposal is to move the documents from docs.ofbiz.org to the ofbiz
>>> >>>> content manager.
>>> >>>> -----------------------------------------------------------------------
>>> >>>> What are the advantages?
>>> >>>>
>>> >>>>      1. No external system required for documentation
>>> >>>>      2. The content of the internal help files can be used within the
>>> >>>>         documentation
>>> >>>>      3. The documentation always has the same version as the system (It
>>> >>>>         is part of it)
>>> >>>>      4. The content is stored in a internationally accepted
>>> >>>>         'DocBook' (www.docbook.org) format
>>> >>>>      5. The content can be easily presented in the selected visual
>>> >>>>         schemas (To be implemented)
>>> >>>>
>>> >>>>
>>> >>>> What is the opinion of the community?
>>> >>>>
>>> >>>> Regards,
>>> >>>> Hans
>>> >>>
>>> >>
>>> >>
>>> >
>>> > --
>>> > View this message in context: http://www.nabble.com/discussion%3A-document-proposal.-tp25183768p25215593.html
>>> > Sent from the OFBiz - User mailing list archive at Nabble.com.
>>> >
>>>
>>>
>> --
>> Antwebsystems.com: Quality OFBiz services for competitive rates
>>
>
>