XWiki 7783 - Add hints for class properties in the class editor #141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…he hint metadata).
| */ | ||
| public String getHint() | ||
| { | ||
| return getBasePropertyClass().getTranslatedHint(context); |
There was a problem hiding this comment.
API methods are supposed to be simple wrappers for the protected classes. As such, it's not quite right that an API method calls a different method (getHint doesn't call the equivalent getHint, but getTranslatedHint).
…ehaviour: display the raw value only if there is no translation key following the convention. It is more consistent with the pretty name behaviour).
…y hints in the object editor).
| @@ -36,6 +36,7 @@ | |||
| #end | |||
| #foreach ($prop in $properties) | |||
| <dt class="label#if($prop.isDisabled()) disabled#end"><label for="${escapetool.xml($class.name)}_${obj.number}_${escapetool.xml($prop.name)}">${escapetool.xml($prop.translatedPrettyName)}</label></dt> | |||
| #if($prop.translatedHint!='')<span class="xHint">($prop.translatedHint)</span>#end | |||
There was a problem hiding this comment.
Definition lists must contain (dt|dd)+ so the hint span should be put inside the definition term as the vertical form standard recommends.
Conflicts: xwiki-platform-core/xwiki-platform-web/src/main/webapp/templates/editobject.vm
* Use "_hint" suffix instead of ".hint" to be consistent with the "tooltip" property.
mflorea
reviewed
Nov 27, 2017
| @@ -36,7 +36,7 @@ | |||
| #end | |||
| #foreach ($prop in $properties) | |||
| <dt class="label#if($prop.isDisabled()) disabled#end"><label for="${escapetool.xml($class.name)}_${obj.number}_${escapetool.xml($prop.name)}">${escapetool.xml($prop.translatedPrettyName)}</label></dt> | |||
| <dd#if ($prop.isDisabled()) class="disabled"#end>$doc.display($prop.name, "edit", $obj)</dd> | |||
| <dd#if ($prop.isDisabled()) class="disabled"#end>#if ("$!prop.hint" != '')<p><span class="xHint">$prop.hint</span></p>#end$doc.display($prop.name, "edit", $obj)</dd> | |||
There was a problem hiding this comment.
Should we escape the HTML from the hint?
There was a problem hiding this comment.
Indeed, fixed in dc6655f.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have added a new metadata called "hint" in the PropertyMetaClass.
Then, we can edit the content of the hint in the class editor.
I have also added a PropertyClass#getHint(), that:
I hope you like it.
Louis-Marie