Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.9
    • Fix Version/s: 1.9.1
    • Component/s: Documentation
    • Labels:
      None
    • Affected Branches:
      MOODLE_19_STABLE
    • Fixed Branches:
      MOODLE_19_STABLE

      Gliffy Diagrams

        Activity

        Hide
        tsala Helen Foster added a comment -

        Suggested text:

        Upload user pictures

        User pictures can be uploaded as a zipped folder of image files. Image files should be named chosen-user-attribute.extension, for example 1234.jpg. Image types supported include gif, jpg, and png.

        Show
        tsala Helen Foster added a comment - Suggested text: Upload user pictures User pictures can be uploaded as a zipped folder of image files. Image files should be named chosen-user-attribute.extension, for example 1234.jpg. Image types supported include gif, jpg, and png.
        Hide
        aborrow Anthony Borrow added a comment -

        Helen - it is a minor point, but I changed zipped folder to zip file as I wanted to avoid confusion that one puts the files into a folder. I was also a little wordier in the example (hopefully for the sake of clarity). Looking at this also made me wonder if we should say something about case sensitivity of file names and for that matter if they should be case sensitive or whether we should modify the method to force lowercase since usernames are always lowercase. Id is less of an issue since it is an integer; however, id number could potentially be mixed case. In any case, I have checked this in to both 19STABLE and HEAD and will mark this as resolved; however, feel free to comment on the above issue and if needed I will add an issue to improve handling of case sensitivity at which point we can add something to the help file. At this point, do you think we should indicate in the help file that the filenames for the username are case-sensitive? I think it might be a good idea but did not verify that that was the case in behavior so I was hesitant to put it in the help file. I think it might avoid some questions/confusion about the function not working when the cases do not match. Peace - Anthony

        Show
        aborrow Anthony Borrow added a comment - Helen - it is a minor point, but I changed zipped folder to zip file as I wanted to avoid confusion that one puts the files into a folder. I was also a little wordier in the example (hopefully for the sake of clarity). Looking at this also made me wonder if we should say something about case sensitivity of file names and for that matter if they should be case sensitive or whether we should modify the method to force lowercase since usernames are always lowercase. Id is less of an issue since it is an integer; however, id number could potentially be mixed case. In any case, I have checked this in to both 19STABLE and HEAD and will mark this as resolved; however, feel free to comment on the above issue and if needed I will add an issue to improve handling of case sensitivity at which point we can add something to the help file. At this point, do you think we should indicate in the help file that the filenames for the username are case-sensitive? I think it might be a good idea but did not verify that that was the case in behavior so I was hesitant to put it in the help file. I think it might avoid some questions/confusion about the function not working when the cases do not match. Peace - Anthony
        Hide
        aborrow Anthony Borrow added a comment -

        uploadpictures.html added to 19STABLE and HEAD

        Show
        aborrow Anthony Borrow added a comment - uploadpictures.html added to 19STABLE and HEAD
        Hide
        tsala Helen Foster added a comment -

        Very clear help file wording - thanks Anthony

        If case-sensitivity is an issue, perhaps a note could be added to http://docs.moodle.org/en/Upload_user_pictures

        Show
        tsala Helen Foster added a comment - Very clear help file wording - thanks Anthony If case-sensitivity is an issue, perhaps a note could be added to http://docs.moodle.org/en/Upload_user_pictures
        Hide
        aborrow Anthony Borrow added a comment -

        Helen - I tested this with a zip file containing various cases of the usernames and they all were imported so case is taken care of. The only disadvantage to this is that if a user zips images and has two images for the same user then the last one in the zip archive processed is the final image. There is no testing to see if the image was updated with the current zip and frankly I see no need to. I'm going to add a little more to the help file indicating that the file names are not case sensitive. Peace - Anthony

        Show
        aborrow Anthony Borrow added a comment - Helen - I tested this with a zip file containing various cases of the usernames and they all were imported so case is taken care of. The only disadvantage to this is that if a user zips images and has two images for the same user then the last one in the zip archive processed is the final image. There is no testing to see if the image was updated with the current zip and frankly I see no need to. I'm going to add a little more to the help file indicating that the file names are not case sensitive. Peace - Anthony
        Hide
        tsala Helen Foster added a comment -

        Hi Anthony,

        Regarding updating a help file, please note the information in the coding guidelines http://docs.moodle.org/en/Coding

        14. All help files should be translatable - create new texts in the "lang/en_utf8/help" directory and call them using helpbutton(). If you need to update a help file:

        • with a minor change, where an old translation of the file would still make sense, then it's OK to make the change but you should notify translation AT moodle DOT org.
        • for a major change you should create a new file by adding an incrementing number (eg filename2.html) so that translators can easily see it's a new version of the file. Obviously the new code and the help index files should also be modified to point to the newest versions.

        An alternative to adding more information to a help file is to add the information to the page in the documentation wiki.

        Show
        tsala Helen Foster added a comment - Hi Anthony, Regarding updating a help file, please note the information in the coding guidelines http://docs.moodle.org/en/Coding 14. All help files should be translatable - create new texts in the "lang/en_utf8/help" directory and call them using helpbutton(). If you need to update a help file: with a minor change, where an old translation of the file would still make sense, then it's OK to make the change but you should notify translation AT moodle DOT org. for a major change you should create a new file by adding an incrementing number (eg filename2.html) so that translators can easily see it's a new version of the file. Obviously the new code and the help index files should also be modified to point to the newest versions. An alternative to adding more information to a help file is to add the information to the page in the documentation wiki.
        Hide
        aborrow Anthony Borrow added a comment -

        Helen - Thanks for calling my attention to the protocol for changing help files. With this particular change, it is very minor and my gut says that it would be best to revert the change to the help file and simply add it to the wiki documentation. Do you have a preference one way or the other? Thinking about this, I wonder if we might be able to get the cvs list to automatically send emails to translation AT moodle DOT org whenever there is is a change to a help file. That would alert translators of the nature of the change. Peace - Anthony

        Show
        aborrow Anthony Borrow added a comment - Helen - Thanks for calling my attention to the protocol for changing help files. With this particular change, it is very minor and my gut says that it would be best to revert the change to the help file and simply add it to the wiki documentation. Do you have a preference one way or the other? Thinking about this, I wonder if we might be able to get the cvs list to automatically send emails to translation AT moodle DOT org whenever there is is a change to a help file. That would alert translators of the nature of the change. Peace - Anthony
        Hide
        tsala Helen Foster added a comment -

        Hi Anthony,

        As you say, it's a very minor change. How about adding it to the documentation wiki and just leaving it in CVS.

        (I've added Koen as a watcher.)

        Show
        tsala Helen Foster added a comment - Hi Anthony, As you say, it's a very minor change. How about adding it to the documentation wiki and just leaving it in CVS. (I've added Koen as a watcher.)
        Hide
        aborrow Anthony Borrow added a comment -

        Helen - OK, I have added the sentence about filenames not being case sensitive to the documentation wiki and will leave it in CVS. I will leave it Koen's discretion as to whether he wants to email the change in the lang/en_utf8/help/uploadpictures.html file to translation AT moodle DOT org. Peace - Anthony

        Show
        aborrow Anthony Borrow added a comment - Helen - OK, I have added the sentence about filenames not being case sensitive to the documentation wiki and will leave it in CVS. I will leave it Koen's discretion as to whether he wants to email the change in the lang/en_utf8/help/uploadpictures.html file to translation AT moodle DOT org. Peace - Anthony
        Hide
        koen Koen Roggemans added a comment -

        I guess it is fine - it is not very major. Since the info is also in the docs, it is possible to find it even if your interface is not in English.

        Thanks a lot Anthony

        Show
        koen Koen Roggemans added a comment - I guess it is fine - it is not very major. Since the info is also in the docs, it is possible to find it even if your interface is not in English. Thanks a lot Anthony

          People

          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:
              Fix Release Date:
              15/May/08