[MAGNOLIA-605] Create a help property in the dialogs Created: 01/Dec/05  Updated: 25/Nov/13  Resolved: 16/May/13

Status: Closed
Project: Magnolia
Component/s: admininterface
Affects Version/s: 2.1.4, 3.0 Beta 1
Fix Version/s: None

Type: New Feature Priority: Minor
Reporter: Tom Wespi Assignee: Philipp Bärfuss
Resolution: Outdated Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Date of First Response:

 Description   

create a help property node in the dialogs. if a help node exists or have content, a queation mark sign will appear next to the label.



 Comments   
Comment by Boris Kraft [ 01/Dec/05 ]

Could we have this defined so that we have either 1 help per dialog or help per fields. Also, this should be configurable and localizable (i.e. if dialogs are extended, there needs to be an easy way to add help text).

Most likely this should work like for the label itself, using property files. I would try to use an automated mechanism, e.g. if the dialog node has a name, look for a property file named dialog_name_help - avoid additional configuration when possible. Inside the property file we could use the labels as keys, plus a lable called "general" that holds help text for the whole dialog (what about tabs?)

Comment by Stojan Peshov [ 03/Dec/05 ]

Solution using properties files is fine and i assume it's the quickest way to do this,
BUT can we consider a different approach?

Lets store all the help in jcr, for example /help node in website, or even better a different workspace / repository.
This way it's easier to manage (add/delete) and edit the help, even online ( this is the first advantage over properties)
if we stick to the known paragraph / template schema that magnolia offers
We also get more quality content for help, links, downloads, images.... ( this is the second advantage over properties)

The help button ( " ? " next to edit, move and delete) should be placed on every paragraph in website
In edit dialog we should add internal link control that browses the above /help tree for choosing the help entry (paragraph)
that will be displayed in " ? " dialog

and that should be it

what needs to be done:

1. additional repository (this is my choice)
2. Help templates, paragraphs (fck should be good enough) and dialogs
3. custom control / dialog for displaying the help in website ( " ? " )
4. linkHelp custom control with extract / browse Tree dialog which includes paragraph (contentNode) browsing as well
5. treeDialog for the needs of 4.

This is only a suggestion. I'm about to realise this idea next year ( hope it will be finished by february )
so I needed an opinion from the comunity

If this concept proves the efficiency, it can be applied on Localization as well (with the advanced mechanizm for online translation)

Thanks

Generated at Mon Feb 12 03:19:05 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.