Details

      Description

      Fix the help screens of Manufacturing

      1. OFBIZ-4802-MFG-Help-v2.patch
        151 kB
        Pierre Smits
      2. OFBIZ-4802-MFG-Help.patch
        163 kB
        Pierre Smits

        Issue Links

          Activity

          Hide
          Jacques Le Roux added a comment -

          Fixed in
          trunk r1563958
          R13.07 r1563962
          R12.04 r1563963
          R11.04 r1563964

          Show
          Jacques Le Roux added a comment - Fixed in trunk r1563958 R13.07 r1563962 R12.04 r1563963 R11.04 r1563964
          Hide
          Jacques Le Roux added a comment -

          Yikes, I tried to fix that again. I did not find all the reasons the last time I wrote about. Removing the TREE_CHILD contentAssocTypeIds sounds a good idea, but renaming NL mapKeys sounds not enough. Also I found that the applications/manufacturing/documents/manufacturing.xml
          refers to wrong pathes, though fixing them allows only to refer to either EN or NL, I'm perplexed.

          https://cwiki.apache.org/confluence/display/OFBENDUSER/Help+for+providing+help+content is not of much help when it comes to i18n of help. OK just stulbed upon it, I think we need to complete this wiki page for i18n following HELP_OFBizDocumentationSystem.xml.

          So from "Internationalization of the help system" in this file, things need to be revisited here once again (the sub-dir EN and NL are not a good idea, the recipe there should have been followed)

          Show
          Jacques Le Roux added a comment - Yikes, I tried to fix that again. I did not find all the reasons the last time I wrote about. Removing the TREE_CHILD contentAssocTypeIds sounds a good idea, but renaming NL mapKeys sounds not enough. Also I found that the applications/manufacturing/documents/manufacturing.xml refers to wrong pathes, though fixing them allows only to refer to either EN or NL, I'm perplexed. https://cwiki.apache.org/confluence/display/OFBENDUSER/Help+for+providing+help+content is not of much help when it comes to i18n of help. OK just stulbed upon it, I think we need to complete this wiki page for i18n following HELP_OFBizDocumentationSystem.xml. So from "Internationalization of the help system" in this file, things need to be revisited here once again (the sub-dir EN and NL are not a good idea, the recipe there should have been followed)
          Hide
          Pierre Smits added a comment - - edited

          Hi Jacques,

          I am sorry to have to say that I can not work on this the coming weeks, as I will be busy working on projects and reporting until mid november.

          Regards,

          Pierre

          Show
          Pierre Smits added a comment - - edited Hi Jacques, I am sorry to have to say that I can not work on this the coming weeks, as I will be busy working on projects and reporting until mid november. Regards, Pierre
          Hide
          Jacques Le Roux added a comment -

          Hi Pierre,

          Do you think you will work on this or should I?

          Show
          Jacques Le Roux added a comment - Hi Pierre, Do you think you will work on this or should I?
          Hide
          Jacques Le Roux added a comment -

          The reason you have 2 NL instances is because for the same mapKey you have 2 contentAssocTypeIds. You can remove the TREE_CHILD ones. This solve already one of the issues.

          For the 2nd issue you simply need to rename the NL mapKeys from, for instance MANUFACTURING_main to MANUFACTURING_main_NL

          Show
          Jacques Le Roux added a comment - The reason you have 2 NL instances is because for the same mapKey you have 2 contentAssocTypeIds. You can remove the TREE_CHILD ones. This solve already one of the issues. For the 2nd issue you simply need to rename the NL mapKeys from, for instance MANUFACTURING_main to MANUFACTURING_main_NL
          Hide
          Pierre Smits added a comment -

          Sounds good, but good results is better....

          Location of help*.xml files is NOT the issue. Got the same problem again. Looking further...

          Show
          Pierre Smits added a comment - Sounds good, but good results is better.... Location of help*.xml files is NOT the issue. Got the same problem again. Looking further...
          Hide
          Jacques Le Roux added a comment -

          Sounds good, thanks Pierre

          Show
          Jacques Le Roux added a comment - Sounds good, thanks Pierre
          Hide
          Pierre Smits added a comment -

          Jacques,

          Indeed the location of the help*.xml files seems to be the culprit. I will provide a new patch relocating help*.xml files directly under folder 'helpdata' with in the name of the help*.xml the addition of the locale.
          Plus, corrections in the ManufacturingHelpData_EN.xml and ManufacturingHelpData_NL.xml to point to the new locations and names of the help*.xml files. Also, in the ManufacturingHelpData_EN.xml I set the localeString for the content records to be (more) complete.

          Show
          Pierre Smits added a comment - Jacques, Indeed the location of the help*.xml files seems to be the culprit. I will provide a new patch relocating help*.xml files directly under folder 'helpdata' with in the name of the help*.xml the addition of the locale. Plus, corrections in the ManufacturingHelpData_EN.xml and ManufacturingHelpData_NL.xml to point to the new locations and names of the help*.xml files. Also, in the ManufacturingHelpData_EN.xml I set the localeString for the content records to be (more) complete.
          Hide
          Jacques Le Roux added a comment -

          Reopened because there are issues reported at OFBIZ-5309 which I closed as a duplicate

          Show
          Jacques Le Roux added a comment - Reopened because there are issues reported at OFBIZ-5309 which I closed as a duplicate
          Hide
          Jacques Le Roux added a comment -

          Indeed, you were right from the start Jacopo

          Show
          Jacques Le Roux added a comment - Indeed, you were right from the start Jacopo
          Hide
          Jacopo Cappellato added a comment -

          I knew that there was the risk of forgetting after the first commit and this is the reason I complained about it, but my complain was not considered too much.
          Unfortunately, even if people like to contribute code and they have good intentions, their contributions are often incomplete and need to be carefully reviewed: you should not commit something incomplete hoping that the contributor will remember (or care) to complete the work at a later point: this approach, as this example clearly shows, doesn't work well.

          Show
          Jacopo Cappellato added a comment - I knew that there was the risk of forgetting after the first commit and this is the reason I complained about it, but my complain was not considered too much. Unfortunately, even if people like to contribute code and they have good intentions, their contributions are often incomplete and need to be carefully reviewed: you should not commit something incomplete hoping that the contributor will remember (or care) to complete the work at a later point: this approach, as this example clearly shows, doesn't work well.
          Hide
          Jacques Le Roux added a comment - - edited

          == TYPO ==
          Jacopo, yes, of course, I reviewed the English ones. When I 1st saw WIP in the NL ones, I thought Pierre would soon provide the complement. I must say I forgot that when closing and backporting because in the meantime Pierre provided EN complement.

          Pierre, please use OFBIZ-4898 and create new OFBIZ-2219 subtasks if necessary. I find easier to have all Help related changes in one Jira. It's a kind of simple board, because help
          is tranversal and there is for instance no Help component or such.

          Show
          Jacques Le Roux added a comment - - edited == TYPO == Jacopo, yes, of course, I reviewed the English ones. When I 1st saw WIP in the NL ones, I thought Pierre would soon provide the complement. I must say I forgot that when closing and backporting because in the meantime Pierre provided EN complement. Pierre, please use OFBIZ-4898 and create new OFBIZ-2219 subtasks if necessary. I find easier to have all Help related changes in one Jira. It's a kind of simple board, because help is tranversal and there is for instance no Help component or such.
          Hide
          Pierre Smits added a comment -

          Thanks Jacques, for pointing out that some Dutch help files are still incomplete. I will create a new patch file to correct this shortly.

          Regards,

          Pierre

          Show
          Pierre Smits added a comment - Thanks Jacques, for pointing out that some Dutch help files are still incomplete. I will create a new patch file to correct this shortly. Regards, Pierre
          Hide
          Jacopo Cappellato added a comment -

          Yes, this is what I meant with "empty" files (see my previous comment).
          As I also mentioned when you first committed all the empty files, I disagree with committing all these empty stuff, hoping that the initial contributor will add valid content at a later point; only when a valid file with interesting content is provided it is committed; I also hope that you are reviewing the content of them (at least the English ones, assuming that the NL ones are valid translations of them).

          Show
          Jacopo Cappellato added a comment - Yes, this is what I meant with "empty" files (see my previous comment). As I also mentioned when you first committed all the empty files, I disagree with committing all these empty stuff, hoping that the initial contributor will add valid content at a later point; only when a valid file with interesting content is provided it is committed; I also hope that you are reviewing the content of them (at least the English ones, assuming that the NL ones are valid translations of them).
          Hide
          Jacques Le Roux added a comment -

          Hi Japoco,

          I guess the empty files you speak about are those containing only

          • The ASL2 license
          • A title
          • The "word" WIP

          Stricly speaking there are not really empty files (OK you put quotes ;o). I see them rather as place holders.

          They are actually 16 "such" files. All in NL language but Help_MFG_EditProductManufacturingRules.xml which is in EN and contains more than above.

          What we could do (if Pierre does not intend to complete them soon): removes the NL language files from trunk and releases branches and add them later again if/when they will be completed.

          I have already created OFBIZ-4898 as sub-task of OFBIZ-2219 for that.

          The idea would be then to create (or extract from patches here) a patch for those files. And to put it in OFBIZ-4898. Then we would remove from trunk and backport the removing, easy stuff...

          Show
          Jacques Le Roux added a comment - Hi Japoco, I guess the empty files you speak about are those containing only The ASL2 license A title The "word" WIP Stricly speaking there are not really empty files (OK you put quotes ;o). I see them rather as place holders. They are actually 16 "such" files. All in NL language but Help_MFG_EditProductManufacturingRules.xml which is in EN and contains more than above. What we could do (if Pierre does not intend to complete them soon): removes the NL language files from trunk and releases branches and add them later again if/when they will be completed. I have already created OFBIZ-4898 as sub-task of OFBIZ-2219 for that. The idea would be then to create (or extract from patches here) a patch for those files. And to put it in OFBIZ-4898 . Then we would remove from trunk and backport the removing, easy stuff...
          Hide
          Jacques Le Roux added a comment -

          Mmm, there are 15 "empty" files you say, let me check...

          Show
          Jacques Le Roux added a comment - Mmm, there are 15 "empty" files you say, let me check...
          Hide
          Jacopo Cappellato added a comment -

          Jacques, any comments on this?

          Show
          Jacopo Cappellato added a comment - Jacques, any comments on this?
          Hide
          Pierre Smits added a comment -

          Feel free to provide a patch for others to review.

          Show
          Pierre Smits added a comment - Feel free to provide a patch for others to review.
          Hide
          Jacopo Cappellato added a comment -

          I still see at least 15 "empty" files that should have never been committed in this form.

          Show
          Jacopo Cappellato added a comment - I still see at least 15 "empty" files that should have never been committed in this form.
          Hide
          Jacques Le Roux added a comment - - edited

          == typo ==
          No, they are complete

          Show
          Jacques Le Roux added a comment - - edited == typo == No, they are complete
          Hide
          Jacopo Cappellato added a comment -

          Removed polemic and inaccurate comment that was simply causing confusion.

          Show
          Jacopo Cappellato added a comment - Removed polemic and inaccurate comment that was simply causing confusion.
          Hide
          Jacopo Cappellato added a comment -

          Does it mean that in the trunk and in the release branches you will leave 15 useless data files containing the WIP word in them?

          Show
          Jacopo Cappellato added a comment - Does it mean that in the trunk and in the release branches you will leave 15 useless data files containing the WIP word in them?
          Hide
          Jacques Le Roux added a comment -

          I backported r1340273 in
          R12.04 r1341492
          R11.04 r1341493
          R10.04 r1341494

          Show
          Jacques Le Roux added a comment - I backported r1340273 in R12.04 r1341492 R11.04 r1341493 R10.04 r1341494
          Hide
          Jacques Le Roux added a comment -

          Done

          Show
          Jacques Le Roux added a comment - Done
          Hide
          Pierre Smits added a comment -

          I think it can be closed. If ommissions are found or modification to existing help files are needed it can be reopenend again.

          Thanks, Jacques.

          Regards,

          Pierre

          Show
          Pierre Smits added a comment - I think it can be closed. If ommissions are found or modification to existing help files are needed it can be reopenend again. Thanks, Jacques. Regards, Pierre
          Hide
          Jacques Le Roux added a comment -

          Hi Pierre, I close or?

          Show
          Jacques Le Roux added a comment - Hi Pierre, I close or?
          Hide
          Jacques Le Roux added a comment -

          Thanks Pierre,

          Your patch is in trunk at r1340273, quite a good job! Should we close, or is there still some pending workk?

          Show
          Jacques Le Roux added a comment - Thanks Pierre, Your patch is in trunk at r1340273, quite a good job! Should we close, or is there still some pending workk?
          Hide
          Pierre Smits added a comment -

          This patch fixes the missing licence statements on both the EN locale and the NL locale. This patch file also includes the enhancement to the help files in the locale EN.

          Show
          Pierre Smits added a comment - This patch fixes the missing licence statements on both the EN locale and the NL locale. This patch file also includes the enhancement to the help files in the locale EN.
          Hide
          Pierre Smits added a comment -

          This patch file enhances the help files in locale EN and has minor changes in help files in locale NL.

          Show
          Pierre Smits added a comment - This patch file enhances the help files in locale EN and has minor changes in help files in locale NL.
          Hide
          Tom Burns added a comment -

          Pierre,

          My apologies for pointing the finger at you.
          The problem did not appear in a test against 10.04, leading to the wrong conclusion.
          The test was flawed.
          I'll open a bug report and move on.

          Tom

          Show
          Tom Burns added a comment - Pierre, My apologies for pointing the finger at you. The problem did not appear in a test against 10.04, leading to the wrong conclusion. The test was flawed. I'll open a bug report and move on. Tom
          Hide
          Pierre Smits added a comment -

          The help files don't contain code. So that can't generate the issue. It also happens when accessing help from another application and performing the same steps there.

          Show
          Pierre Smits added a comment - The help files don't contain code. So that can't generate the issue. It also happens when accessing help from another application and performing the same steps there.
          Hide
          Tom Burns added a comment -

          Pierre ,

          The help patch has broken the demo-trunk Language and Visual Themes features.

          To duplicate
          Logon to Manufacturing (English)
          Open Help
          (Note triplicate message on help screen.)
          Click Index
          Open Mfg Help
          Close Help

          Goto Language
          Select Nederlands
          Expect to return to app
          Actual Help Screen appears

          Similar problem with Themes

          Show
          Tom Burns added a comment - Pierre , The help patch has broken the demo-trunk Language and Visual Themes features. To duplicate Logon to Manufacturing (English) Open Help (Note triplicate message on help screen.) Click Index Open Mfg Help Close Help Goto Language Select Nederlands Expect to return to app Actual Help Screen appears Similar problem with Themes
          Hide
          Tom Burns added a comment -

          Use title-style capitalization for section titles.
          Correct: Edit Manufacturing Rules
          Incorrect: Edit manufacturing rules

          I will post some style references in the umbrella site later.

          Show
          Tom Burns added a comment - Use title-style capitalization for section titles. Correct: Edit Manufacturing Rules Incorrect: Edit manufacturing rules I will post some style references in the umbrella site later.
          Hide
          Jacques Le Roux added a comment -

          Thanks for clarification Jacopo

          Show
          Jacques Le Roux added a comment - Thanks for clarification Jacopo
          Hide
          Jacopo Cappellato added a comment -

          Just to clarify that I didn't comment on the decision to back port or not to branches (I don't care too much) but simply on the fact that the "Fix Version/s" field should never contain a released release because we fix the branches and future releases based on them, and not past releases; the reference to 11.04.01 was also not needed because, if we will back port to 11.04 branch then it will be also included in that release.

          Show
          Jacopo Cappellato added a comment - Just to clarify that I didn't comment on the decision to back port or not to branches (I don't care too much) but simply on the fact that the "Fix Version/s" field should never contain a released release because we fix the branches and future releases based on them, and not past releases; the reference to 11.04.01 was also not needed because, if we will back port to 11.04 branch then it will be also included in that release.
          Hide
          Pierre Smits added a comment -

          Jacques,

          I will fix the title tomorrow.

          Regards,

          Pierre

          Show
          Pierre Smits added a comment - Jacques, I will fix the title tomorrow. Regards, Pierre
          Hide
          Jacques Le Roux added a comment -

          Ha also we should change the Manufacturing Help title from
          OFBiz:MFG (Manufacturing)
          to simply
          Manufacturing

          To be consistent with the application name...

          Show
          Jacques Le Roux added a comment - Ha also we should change the Manufacturing Help title from OFBiz:MFG (Manufacturing) to simply Manufacturing To be consistent with the application name...
          Hide
          Jacques Le Roux added a comment -

          Thanks Pierre,

          Your patch is in
          trunk r1336921
          R12.04 r1336922
          R11.04 r1336923
          R10.04 r1336924

          I did not close because I guess we will continue here to fill the help...

          We maybe need to think about the components order in help

          Show
          Jacques Le Roux added a comment - Thanks Pierre, Your patch is in trunk r1336921 R12.04 r1336922 R11.04 r1336923 R10.04 r1336924 I did not close because I guess we will continue here to fill the help... We maybe need to think about the components order in help
          Hide
          Pierre Smits added a comment -

          Jacques,

          My apologies. That had slipped my mind, again...

          Regards,

          Pierre

          Show
          Pierre Smits added a comment - Jacques, My apologies. That had slipped my mind, again... Regards, Pierre
          Hide
          Jacques Le Roux added a comment -

          ^Though I must say that Release 11.04.01 is not "already released", at least not officialy...

          Show
          Jacques Le Roux added a comment - ^Though I must say that Release 11.04.01 is not "already released", at least not officialy...
          Hide
          Jacques Le Roux added a comment - - edited

          ============ EDIT

          { code }

          position ======
          Pierre,
          Just a detail I already told you about patches: please when using Subclipse chose project in order to avoid those 2 lines at top:

          ### Eclipse Workspace Patch 1.0
          #P ofbiz-trunk
          

          Not a big deal but then we need to remove them (unless our local prokect is also named ofbiz-trunk, unlikely...

          BTW this is documented here Eclipse internal command (don't use finish but rather select project to avoid the 2 1st lines in the patch)

          Thanks

          Show
          Jacques Le Roux added a comment - - edited ============ EDIT { code } position ====== Pierre, Just a detail I already told you about patches: please when using Subclipse chose project in order to avoid those 2 lines at top: ### Eclipse Workspace Patch 1.0 #P ofbiz-trunk Not a big deal but then we need to remove them (unless our local prokect is also named ofbiz-trunk, unlikely... BTW this is documented here Eclipse internal command (don't use finish but rather select project to avoid the 2 1st lines in the patch) Thanks
          Hide
          Jacques Le Roux added a comment -

          I second Adrian here

          Show
          Jacques Le Roux added a comment - I second Adrian here
          Hide
          Adrian Crum added a comment -

          Please Pierre, if you want to contribute, then try to understand the community fundamentals first.

          Show
          Adrian Crum added a comment - Please Pierre, if you want to contribute, then try to understand the community fundamentals first.
          Hide
          Adrian Crum added a comment -

          There is no "decree of Jacopo" - release branches are updated with bug fixes only. This has been the standard release management policy of the project all along.

          Show
          Adrian Crum added a comment - There is no "decree of Jacopo" - release branches are updated with bug fixes only. This has been the standard release management policy of the project all along.
          Hide
          Pierre Smits added a comment -

          The attached patch fixes the missing help files of manufacturing. It consists of the structure for help files in English and Dutch, the basis for help files in English and the start of help files in Dutch.

          Show
          Pierre Smits added a comment - The attached patch fixes the missing help files of manufacturing. It consists of the structure for help files in English and Dutch, the basis for help files in English and the start of help files in Dutch.

            People

            • Assignee:
              Jacques Le Roux
              Reporter:
              Pierre Smits
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development