Orphan DocBook Pages?

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

Orphan DocBook Pages?

samhamilton
Reply | Threaded
Open this post in threaded view
|

Re: Orphan DocBook Pages?

BJ Freeman

how about putting them under webtools techdocs
key here is need a tab or component that is visible on the UI to have
them accessible from the Help link on UI.

=========================
BJ Freeman  <http://bjfreeman.elance.com>
Strategic Power Office with Supplier Automation  <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
Specialtymarket.com  <http://www.specialtymarket.com/>
Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man


Sam Hamilton sent the following on 9/2/2010 1:53 AM:
Reply | Threaded
Open this post in threaded view
|

Re: Orphan DocBook Pages?

samhamilton
Can anyone tell me or point me in the direction of how the DocBooks are
setup in OFBiz - master config file or something similar would be
perfect so I can understand how all the help pages come together?

I can see the {app}/documents folders and in most cases there also is
{app}/data/helpdata folder containing more pages.

Is there a specific reason why there is not a /data/helpdata folder in
framework for framework specific helpdocs?

Thanks
Sam


On 02/09/2010 11:38, BJ Freeman wrote:

>
> how about putting them under webtools techdocs
> key here is need a tab or component that is visible on the UI to have
> them accessible from the Help link on UI.
>
> =========================
> BJ Freeman  <http://bjfreeman.elance.com>
> Strategic Power Office with Supplier Automation
> <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
> Specialtymarket.com  <http://www.specialtymarket.com/>
> Systems Integrator-- Glad to Assist
>
> Chat  Y! messenger: bjfr33man
>
>
> Sam Hamilton sent the following on 9/2/2010 1:53 AM:
>> Hey Guys - do you know how to get the following pages in our help docs?
>>
>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/Framework.xml
>>
>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/SingleSignOn.xml
>>
>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/UnitTest.xml
>>
>>
>> thanks
>> Sam
>>
>>
>

Reply | Threaded
Open this post in threaded view
|

Re: Orphan DocBook Pages?

BJ Freeman
help goes through the controller of the webapp.
helpdata is only when you have a document, the ones in frame work only
link to an external page.
the helpdata is in a specific component so those document in framework
would have to be moved to a component like webtools that has a UI and
controller for the help link.



=========================
BJ Freeman  <http://bjfreeman.elance.com>
Strategic Power Office with Supplier Automation  <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
Specialtymarket.com  <http://www.specialtymarket.com/>
Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man


Sam Hamilton sent the following on 9/3/2010 9:15 AM:

> Can anyone tell me or point me in the direction of how the DocBooks are
> setup in OFBiz - master config file or something similar would be
> perfect so I can understand how all the help pages come together?
>
> I can see the {app}/documents folders and in most cases there also is
> {app}/data/helpdata folder containing more pages.
>
> Is there a specific reason why there is not a /data/helpdata folder in
> framework for framework specific helpdocs?
>
> Thanks
> Sam
>
>
> On 02/09/2010 11:38, BJ Freeman wrote:
>>
>> how about putting them under webtools techdocs
>> key here is need a tab or component that is visible on the UI to have
>> them accessible from the Help link on UI.
>>
>> =========================
>> BJ Freeman<http://bjfreeman.elance.com>
>> Strategic Power Office with Supplier Automation
>> <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
>> Specialtymarket.com<http://www.specialtymarket.com/>
>> Systems Integrator-- Glad to Assist
>>
>> Chat  Y! messenger: bjfr33man
>>
>>
>> Sam Hamilton sent the following on 9/2/2010 1:53 AM:
>>> Hey Guys - do you know how to get the following pages in our help docs?
>>>
>>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/Framework.xml
>>>
>>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/SingleSignOn.xml
>>>
>>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/UnitTest.xml
>>>
>>>
>>> thanks
>>> Sam
>>>
>>>
>>
>
>

Reply | Threaded
Open this post in threaded view
|

Re: Orphan DocBook Pages?

BJ Freeman
found this link
http://ofbiz.135035.n4.nabble.com/documentation-on-creating-help-pages-td2220298.html
=========================

BJ Freeman
Strategic Power Office with Supplier Automation  <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
Specialtymarket.com  <http://www.specialtymarket.com/>
Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man
BJ Freeman sent the following on 9/3/2010 10:01 AM:


> help goes through the controller of the webapp.
> helpdata is only when you have a document, the ones in frame work only
> link to an external page.
> the helpdata is in a specific component so those document in framework
> would have to be moved to a component like webtools that has a UI and
> controller for the help link.
>
>
>
> =========================
> BJ Freeman <http://bjfreeman.elance.com>
> Strategic Power Office with Supplier Automation
> <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
> Specialtymarket.com <http://www.specialtymarket.com/>
> Systems Integrator-- Glad to Assist
>
> Chat Y! messenger: bjfr33man
>
>
> Sam Hamilton sent the following on 9/3/2010 9:15 AM:
>> Can anyone tell me or point me in the direction of how the DocBooks are
>> setup in OFBiz - master config file or something similar would be
>> perfect so I can understand how all the help pages come together?
>>
>> I can see the {app}/documents folders and in most cases there also is
>> {app}/data/helpdata folder containing more pages.
>>
>> Is there a specific reason why there is not a /data/helpdata folder in
>> framework for framework specific helpdocs?
>>
>> Thanks
>> Sam
>>
>>
>> On 02/09/2010 11:38, BJ Freeman wrote:
>>>
>>> how about putting them under webtools techdocs
>>> key here is need a tab or component that is visible on the UI to have
>>> them accessible from the Help link on UI.
>>>
>>> =========================
>>> BJ Freeman<http://bjfreeman.elance.com>
>>> Strategic Power Office with Supplier Automation
>>> <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
>>> Specialtymarket.com<http://www.specialtymarket.com/>
>>> Systems Integrator-- Glad to Assist
>>>
>>> Chat Y! messenger: bjfr33man
>>>
>>>
>>> Sam Hamilton sent the following on 9/2/2010 1:53 AM:
>>>> Hey Guys - do you know how to get the following pages in our help docs?
>>>>
>>>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/Framework.xml
>>>>
>>>>
>>>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/SingleSignOn.xml
>>>>
>>>>
>>>> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/UnitTest.xml
>>>>
>>>>
>>>>
>>>> thanks
>>>> Sam
>>>>
>>>>
>>>
>>
>>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Orphan DocBook Pages?

hans_bakker
In reply to this post by samhamilton
The help system and how to contribute I described in the same system at:
http://demo-trunk.ofbiz.apache.org/cmssite/cms/APACHE_OFBIZ_HTML#N2353B

be patient , it can take some time to generate the document.

Regards,
Hans


--
Ofbiz on twitter: http://twitter.com/apache_ofbiz
Myself on twitter: http://twitter.com/hansbak
http://Antwebsystems.com: Quality services for competitive rates.

On Fri, 2010-09-03 at 17:15 +0100, Sam Hamilton wrote:

> Can anyone tell me or point me in the direction of how the DocBooks are
> setup in OFBiz - master config file or something similar would be
> perfect so I can understand how all the help pages come together?
>
> I can see the {app}/documents folders and in most cases there also is
> {app}/data/helpdata folder containing more pages.
>
> Is there a specific reason why there is not a /data/helpdata folder in
> framework for framework specific helpdocs?
>
> Thanks
> Sam
>
>
> On 02/09/2010 11:38, BJ Freeman wrote:
> >
> > how about putting them under webtools techdocs
> > key here is need a tab or component that is visible on the UI to have
> > them accessible from the Help link on UI.
> >
> > =========================
> > BJ Freeman  <http://bjfreeman.elance.com>
> > Strategic Power Office with Supplier Automation
> > <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
> > Specialtymarket.com  <http://www.specialtymarket.com/>
> > Systems Integrator-- Glad to Assist
> >
> > Chat  Y! messenger: bjfr33man
> >
> >
> > Sam Hamilton sent the following on 9/2/2010 1:53 AM:
> >> Hey Guys - do you know how to get the following pages in our help docs?
> >>
> >> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/Framework.xml
> >>
> >> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/SingleSignOn.xml
> >>
> >> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/UnitTest.xml
> >>
> >>
> >> thanks
> >> Sam
> >>
> >>
> >
>


Reply | Threaded
Open this post in threaded view
|

Re: Orphan DocBook Pages?

hans_bakker
In reply to this post by samhamilton
The help system contains out of 3 parts and most text appears in all
applications:

1. A general html document at:
http://demo-trunk.ofbiz.apache.org/cmssite/cms/APACHE_OFBIZ_HTML
2. The internal help system context sensitive screens
3. the help index

The orphaned document you mention, only appear in the html document, not
in the help, because they are more of a general nature and not directly
connected to a particular ofbiz screen. The help sceens however are
connected to a specific url.

Regards,
Hans

--
Ofbiz on twitter: http://twitter.com/apache_ofbiz
Myself on twitter: http://twitter.com/hansbak
Antwebsystems.com: Quality services for competitive rates.

On Fri, 2010-09-03 at 17:15 +0100, Sam Hamilton wrote:

> Can anyone tell me or point me in the direction of how the DocBooks are
> setup in OFBiz - master config file or something similar would be
> perfect so I can understand how all the help pages come together?
>
> I can see the {app}/documents folders and in most cases there also is
> {app}/data/helpdata folder containing more pages.
>
> Is there a specific reason why there is not a /data/helpdata folder in
> framework for framework specific helpdocs?
>
> Thanks
> Sam
>
>
> On 02/09/2010 11:38, BJ Freeman wrote:
> >
> > how about putting them under webtools techdocs
> > key here is need a tab or component that is visible on the UI to have
> > them accessible from the Help link on UI.
> >
> > =========================
> > BJ Freeman  <http://bjfreeman.elance.com>
> > Strategic Power Office with Supplier Automation
> > <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
> > Specialtymarket.com  <http://www.specialtymarket.com/>
> > Systems Integrator-- Glad to Assist
> >
> > Chat  Y! messenger: bjfr33man
> >
> >
> > Sam Hamilton sent the following on 9/2/2010 1:53 AM:
> >> Hey Guys - do you know how to get the following pages in our help docs?
> >>
> >> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/Framework.xml
> >>
> >> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/SingleSignOn.xml
> >>
> >> http://svn.apache.org/repos/asf/ofbiz/trunk/framework/documents/UnitTest.xml
> >>
> >>
> >> thanks
> >> Sam
> >>
> >>
> >
>

--
Ofbiz on twitter: http://twitter.com/apache_ofbiz
Myself on twitter: http://twitter.com/hansbak
Antwebsystems.com: Quality services for competitive rates.