extending the help system

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

extending the help system

chris snow-2
I would like to extend the help system to display entity field descriptions,
for example:

    <section>
        <myns:entityFieldDescriptions entity-name="ProductStore"/>
    </section>

The docbook processor would then expand the myns:entityFieldDescriptions
element to produce a horizontal list of fields, that are hyperlinked to the
descriptions which will be below the list (similar to javadocs), e.g.

-----
fieldA, fieldB, fieldC, fieldD, fieldE, ...
-----
fieldA : This is the description for field A
field B : This is the descriptoin for field B
...

Can anyone (Hans?) point me in the right direction?

Many thanks,

Chris
Reply | Threaded
Open this post in threaded view
|

Re: extending the help system

BJ Freeman
have you investigated using the artifact of webtools

=========================
BJ Freeman
http://bjfreeman.elance.com
Strategic Power Office with Supplier Automation <http://www.businessesnetwork.com/automation/viewforum.php?f=93>
Specialtymarket.com <http://www.specialtymarket.com/>

Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man
Linkedin
<http://www.linkedin.com/profile?viewProfile=&key=1237480&locale=en_US&trk=tab_pro>


chris snow sent the following on 5/18/2010 11:22 AM:

> I would like to extend the help system to display entity field descriptions,
> for example:
>
>     <section>
>         <myns:entityFieldDescriptions entity-name="ProductStore"/>
>     </section>
>
> The docbook processor would then expand the myns:entityFieldDescriptions
> element to produce a horizontal list of fields, that are hyperlinked to the
> descriptions which will be below the list (similar to javadocs), e.g.
>
> -----
> fieldA, fieldB, fieldC, fieldD, fieldE, ...
> -----
> fieldA : This is the description for field A
> field B : This is the descriptoin for field B
> ...
>
> Can anyone (Hans?) point me in the right direction?
>
> Many thanks,
>
> Chris
>


Reply | Threaded
Open this post in threaded view
|

Re: extending the help system

BJ Freeman
In reply to this post by chris snow-2
to clarify. why not do help files on how to user the webtools
they already provide data in a good format.
and the artifact is very powerful.

=========================
BJ Freeman
http://bjfreeman.elance.com
Strategic Power Office with Supplier Automation <http://www.businessesnetwork.com/automation/viewforum.php?f=93>
Specialtymarket.com <http://www.specialtymarket.com/>

Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man
Linkedin
<http://www.linkedin.com/profile?viewProfile=&key=1237480&locale=en_US&trk=tab_pro>


BJ Freeman sent the following on 5/18/2010 12:38 PM:

> have you investigated using the artifact of webtools
>
> =========================
> BJ Freeman
> http://bjfreeman.elance.com
> Strategic Power Office with Supplier Automation <http://www.businessesnetwork.com/automation/viewforum.php?f=93>
> Specialtymarket.com <http://www.specialtymarket.com/>
>
> Systems Integrator-- Glad to Assist
>
> Chat  Y! messenger: bjfr33man
> Linkedin
> <http://www.linkedin.com/profile?viewProfile=&key=1237480&locale=en_US&trk=tab_pro>
>
>
> chris snow sent the following on 5/18/2010 11:22 AM:
>> I would like to extend the help system to display entity field descriptions,
>> for example:
>>
>>     <section>
>>         <myns:entityFieldDescriptions entity-name="ProductStore"/>
>>     </section>
>>
>> The docbook processor would then expand the myns:entityFieldDescriptions
>> element to produce a horizontal list of fields, that are hyperlinked to the
>> descriptions which will be below the list (similar to javadocs), e.g.
>>
>> -----
>> fieldA, fieldB, fieldC, fieldD, fieldE, ...
>> -----
>> fieldA : This is the description for field A
>> field B : This is the descriptoin for field B
>> ...
>>
>> Can anyone (Hans?) point me in the right direction?
>>
>> Many thanks,
>>
>> Chris
>>
>
>
>


Reply | Threaded
Open this post in threaded view
|

Re: extending the help system

Chris Snow-3
Hi BJ,

I'm not sure I understand what you are saying, but the field help tooltip
functionality has been created by using entity artifact data (entity
resource info).  For details see:

http://cwiki.apache.org/confluence/x/jgE7AQ

What I'm now trying to do is re-use the entity field description artifact
data in the main help system.

Cheers,

Chris

> to clarify. why not do help files on how to user the webtools
> they already provide data in a good format.
> and the artifact is very powerful.
>
> =========================
> BJ Freeman
> http://bjfreeman.elance.com
> Strategic Power Office with Supplier Automation
> <http://www.businessesnetwork.com/automation/viewforum.php?f=93>
> Specialtymarket.com <http://www.specialtymarket.com/>
>
> Systems Integrator-- Glad to Assist
>
> Chat  Y! messenger: bjfr33man
> Linkedin
> <http://www.linkedin.com/profile?viewProfile=&key=1237480&locale=en_US&trk=tab_pro>
>
>
> BJ Freeman sent the following on 5/18/2010 12:38 PM:
>> have you investigated using the artifact of webtools
>>
>> =========================
>> BJ Freeman
>> http://bjfreeman.elance.com
>> Strategic Power Office with Supplier Automation
>> <http://www.businessesnetwork.com/automation/viewforum.php?f=93>
>> Specialtymarket.com <http://www.specialtymarket.com/>
>>
>> Systems Integrator-- Glad to Assist
>>
>> Chat  Y! messenger: bjfr33man
>> Linkedin
>> <http://www.linkedin.com/profile?viewProfile=&key=1237480&locale=en_US&trk=tab_pro>
>>
>>
>> chris snow sent the following on 5/18/2010 11:22 AM:
>>> I would like to extend the help system to display entity field
>>> descriptions,
>>> for example:
>>>
>>>     <section>
>>>         <myns:entityFieldDescriptions entity-name="ProductStore"/>
>>>     </section>
>>>
>>> The docbook processor would then expand the
>>> myns:entityFieldDescriptions
>>> element to produce a horizontal list of fields, that are hyperlinked to
>>> the
>>> descriptions which will be below the list (similar to javadocs), e.g.
>>>
>>> -----
>>> fieldA, fieldB, fieldC, fieldD, fieldE, ...
>>> -----
>>> fieldA : This is the description for field A
>>> field B : This is the descriptoin for field B
>>> ...
>>>
>>> Can anyone (Hans?) point me in the right direction?
>>>
>>> Many thanks,
>>>
>>> Chris
>>>
>>
>>
>>
>
>
>


--
Chris Snow - CEng MBCS CITP MBA (Tech Mgmt) (Open) CISSP

Tel: 01453 890660
Mob: 07944 880950
Www: www.snowconsulting.co.uk

Reply | Threaded
Open this post in threaded view
|

Re: extending the help system

hans_bakker
In reply to this post by chris snow-2
Hi Chris,

thanks for your contributions on the help facility, also this is an
excellent idea.

the help screens are displayed with the HelpTemplate.ftl
You could extend this ftl so it will recognize your extensions....

Regards,
Hans


On Tue, 2010-05-18 at 19:22 +0100, chris snow wrote:

> I would like to extend the help system to display entity field descriptions,
> for example:
>
>     <section>
>         <myns:entityFieldDescriptions entity-name="ProductStore"/>
>     </section>
>
> The docbook processor would then expand the myns:entityFieldDescriptions
> element to produce a horizontal list of fields, that are hyperlinked to the
> descriptions which will be below the list (similar to javadocs), e.g.
>
> -----
> fieldA, fieldB, fieldC, fieldD, fieldE, ...
> -----
> fieldA : This is the description for field A
> field B : This is the descriptoin for field B
> ...
>
> Can anyone (Hans?) point me in the right direction?
>
> Many thanks,
>
> Chris

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