[jira] Created: (OFBIZ-1425) Improve the ModelField.getDescription method
Locked
[jira] Created: (OFBIZ-1425) Improve the ModelField.getDescription method
 
|
Improve the ModelField.getDescription method
-------------------------------------------- Key: OFBIZ-1425 URL: https://issues.apache.org/jira/browse/OFBIZ-1425 Project: OFBiz Issue Type: Improvement Components: framework Reporter: Adrian Crum Priority: Minor Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Updated: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Adrian Crum updated OFBIZ-1425: ------------------------------- Attachment: example.patch modelfield.patch modelfield.patch contains the improvement. example.patch contains a demo in the Example component. Use the Webtools entity reference to view the results. ModelField.getDescription() uses the following strategy to resolve the description: 1. If the entity definition has a <default-resource-name> property, and the corresponding resource contains the FieldDescription.[entityname].[fieldname] property, then return the property 2. If the entity definition contains a <description> element for this field, then return the <description> element 3. If the entity definition has a <default-resource-name> property, and the corresponding resource contains the FieldDescription.[fieldname] property, then return the property 4. Convert the field name into a sentence, then return the sentence I believe this strategy will make everyone happy. An entity that isn't documented will have its field names converted to sentences for field descriptions. An entity that has a handful of fields documented will show those descriptions, and the remaining fields will have field names converted to sentences for field descriptions. An entity can be further docmented by putting common, redundant field descriptions in a property file. An ambitious developer could create a localized properties file to document an entity in another language. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545214 ] Adrian Crum commented on OFBIZ-1425: ------------------------------------ The only thing I don't like about this modification is the introduction of additional files to document the entities. That dilutes the concept of making entity definitions self-documenting. On the other hand, the advantage is the possibility of having localized entity documentation. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545219 ] Jacques Le Roux commented on OFBIZ-1425: ---------------------------------------- I wonder if it's not too sophisticated notably I don't like much the idea of several sources of informations. On the other hand, I agree that this strategy fulfill all needs already expressed To summarize +1 for FieldDescription.[fieldname] - will be used for all fields of that name +1 for FieldDescription.[entityname].[fieldname] - will be used for the specific entity field 0 for Convert the field name into a sentence, then return the sentence +1 for localisation, (hope we are all ambitious developpers if we really want to increase our market share ;o) -1 to use the <description> outside of the scope of the entitydef file (only used by.for programmers) Do we really need to add <default-resource-name> in entity ? Each entity and view-entity has a package-name and we could use it there to find related properties file. As, if I remember well, package-name is not mandatory I quickly checked and it seems to be well used. My 2 cents > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545226 ] Adrian Crum commented on OFBIZ-1425: ------------------------------------ Jacques, My original version used the entity package name to construct a properties file name, but then I saw there was an existing default-resource-name property defined - so I used that instead. I liked the idea of using existing properties files. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545228 ] Skip Dever commented on OFBIZ-1425: ----------------------------------- I for one agree with this strat Adrian. Having localization support I thing is very important and outweighs the downside of having documentation in multiple places/ > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545229 ] Adrian Crum commented on OFBIZ-1425: ------------------------------------ David's comment from OFBIZ-1387: "If we do something like that, here or anywhere, we should use XML and not properties files. XML is about 1E6 times better than properties files (name/value pairs) for organizing this sort of information. It is hierarchical so much easier to organize and you can use real UTF-8 characters there instead of having to encode everything and use a special tool or a translator to work on the files." This patch could be modified to use xml files instead of properties files. I just need an example of how to do that. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545254 ] Jacques Le Roux commented on OFBIZ-1425: ---------------------------------------- Adrian, Sorry I was not aware (and did not check) of default-resource-name existing. I agree far better, forget my suggestion. Adrian, Skip, To make it easier, I put here a link to my comment https://issues.apache.org/jira/browse/OFBIZ-1387#action_12545246 (it should be read in the context of OFBIZ-1387 issue) My concern is simple : UI consistency (should be all localised). Remember with end-users you only get one chance to make a great first impression and most of the time end-users make the decision... I agree that with your strategy theoritically we are able to localised all, but I'm afraid that most fields would not be. I'm not against it, just concerned... > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545521 ] David E. Jones commented on OFBIZ-1425: --------------------------------------- Adrian (and all), In XML there are standard ways of doing this, namely using the xml:lang attribute on an element to specify the language of the content in an element. The best way to do this is probably to allow multiple "description" elements and in the parsing code grab them along with the language and keep a Map of them or something. Some utility code may make sense here so that this same pattern can be used in other places more easily. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545526 ] Adrian Crum commented on OFBIZ-1425: ------------------------------------ David, Thank you very much for the suggestion. So, there is nothing in OFBiz at the moment to accomodate xml properties files. That being the case, would you object if we committed this? I would like to avoid losing momentum in the entity documentation effort. I will start another Jira issue to work on the xml property file idea. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545582 ] David E. Jones commented on OFBIZ-1425: --------------------------------------- I do have a small objection... I don't like seeing bad patterns introduced as they tend to require 10 times as much work to remove. :( > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545586 ] David E. Jones commented on OFBIZ-1425: --------------------------------------- This really is a bit off topic for this issue, but since it is getting into the i18n area I'll comment briefly here on this: there are some comments for how to determine the message to use based on the locale passed in and the locales available in the UtilProperties.java file, line 579 to 615. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545830 ] Jacques Le Roux commented on OFBIZ-1425: ---------------------------------------- Adrian, In dev ML, Vinni Miana has suggested to look at http://commons.apache.org/configuration/ and I believe it's a good idea ! > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Issue Comment Edited: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12545830 ] jacques.le.roux edited comment on OFBIZ-1425 at 11/28/07 7:47 PM: ------------------------------------------------------------------ Adrian, In dev ML, Vinni Miana has suggested to look at http://commons.apache.org/configuration/ and I believe it's a good idea ! Note : Finally http://commons.apache.org/configuration/ does not deal with i18n was (Author: jacques.le.roux): Adrian, In dev ML, Vinni Miana has suggested to look at http://commons.apache.org/configuration/ and I believe it's a good idea ! > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Updated: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Adrian Crum updated OFBIZ-1425: ------------------------------- Attachment: example.patch Updated the example.patch to use the new XML properties file. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, example.patch, modelfield.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Updated: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Adrian Crum updated OFBIZ-1425: ------------------------------- Attachment: (was: modelfield.patch) > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, example.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12547986 ] Adrian Crum commented on OFBIZ-1425: ------------------------------------ I came up with a slightly different approach. Instead of puttng the code in the entity engine, I'll put the code in the documentation class itself. I'll have an updated patch shortly. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, example.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Closed: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Adrian Crum closed OFBIZ-1425. ------------------------------ Resolution: Fixed Improved field descriptions in rev 601056. > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, example.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12906259#action_12906259 ] Bruno Busco commented on OFBIZ-1425: ------------------------------------ Hi, it seems that this feature does not allow to add an help string on form field titles that do not come from an Entity but from a Map. For instance I would like to add the following in WebToolsUiLabels.xml: <property key="FieldDescription.useSoftReference"> <value xml:lang="en">This property is used to specify whether soft references should be used for cache entries. Soft references help keep large caches from taking too much memory by allowing the garbage collector to clear these entries when more memory is needed. Possible values: true/false.</value> </property> so that user can get help on the useSoftReference field when accessing https://localhost:8443/webtools/control/EditUtilCache The FormFieldTitle_*** pattern, on the contrary, seems to be able to work on field titles that are not strictly related to entities field. Shouldn't we follow a similar approach replacing the FieldDescription.*** with FormFieldDescription_***. The field description is supposed to be used by an user that is in front of a field in a *form* and not strictly in an *entity*. What do you think about? > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, example.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
[jira] Commented: (OFBIZ-1425) Improve the ModelField.getDescription method
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-1425?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12915701#action_12915701 ] Jacques Le Roux commented on OFBIZ-1425: ---------------------------------------- I did not look into details but this sounds like a good idea to me > Improve the ModelField.getDescription method > -------------------------------------------- > > Key: OFBIZ-1425 > URL: https://issues.apache.org/jira/browse/OFBIZ-1425 > Project: OFBiz > Issue Type: Improvement > Components: framework > Reporter: Adrian Crum > Priority: Minor > Attachments: example.patch, example.patch > > > Based upon discussion on the dev mailing list and in the OFBIZ-1387 issue, modify the ModelField.getDescription method so it uses a more comprehensive way to resolve a field description. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online. |
«
Return to OFBiz - Dev
|
1 view|%1 views
| Free forum by Nabble | Edit this page |