Moodle

Inclusion of images within form help buttons and localization of said images

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: 1.8.5, 1.9
  • Fix Version/s: None
  • Component/s: General
  • Labels:
    None
  • Environment:
    ALL
  • Affected Branches:
    MOODLE_18_STABLE, MOODLE_19_STABLE

Description

When generating help documentation for blocks' form elements, it would be help full to include images within the documentation to guide them. There currently isn't a clear way to do so as of the 1.9.4 branch other than building full URLs via $CFG->wwwroot.

However, if images are allowed to be included in help documentation, then should they be localized based on the users' language packs? If so, then the only place it makes sense to store these images is within the language packs of the blocks. If localization of these images is unnecessary, then they could live within a directory within the block such as 'images'.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Anthony Borrow added a comment -

Andrew - Sorry for the delayed response. Now that I have a little break from classes I am trying to catch up. Is this a general suggestion for how help files can make use of language specific images? It does not appear to be related to anything particularly in CONTRIB (i.e. patches or plugins). As such, once I hear back from you, I will move this and re-assign it to one of the developers so that they can consider your comment. Thanks for any clarification you can provide. Peace - Anthony

Show
Anthony Borrow added a comment - Andrew - Sorry for the delayed response. Now that I have a little break from classes I am trying to catch up. Is this a general suggestion for how help files can make use of language specific images? It does not appear to be related to anything particularly in CONTRIB (i.e. patches or plugins). As such, once I hear back from you, I will move this and re-assign it to one of the developers so that they can consider your comment. Thanks for any clarification you can provide. Peace - Anthony
Hide
Permalink
Anthony Borrow added a comment -

Martin - This was originally filed in CONTRIB but seems to be a general suggestion for dealing wtih help files. I was not sure quite what to do with it so I'm assigning it to you. Peace - Anthony

Show
Anthony Borrow added a comment - Martin - This was originally filed in CONTRIB but seems to be a general suggestion for dealing wtih help files. I was not sure quite what to do with it so I'm assigning it to you. Peace - Anthony
Hide
Permalink
Andrew Ralph Feller added a comment -

Anthony - As far as why it was posted under CONTRIB, it was a suggestion by a colleague; simple misunderstanding where this type of thread should have been created. Yes, this is a general suggestion on how Moodle can be improved.

There are two parts to this ticket:

1. Facilitate the use of images in HTML help documentation.
2. If it is advisable to use images in HTML help documentation, should images vary between language packs?

The best long term solution would be to consider anything within help documentation to be language-specific, thus images would be stored within the language packs. If so, then there needs to be an easier way to referencing the images instead of building a full path to them every time one is needed.

Show
Andrew Ralph Feller added a comment - Anthony - As far as why it was posted under CONTRIB, it was a suggestion by a colleague; simple misunderstanding where this type of thread should have been created. Yes, this is a general suggestion on how Moodle can be improved. There are two parts to this ticket: 1. Facilitate the use of images in HTML help documentation. 2. If it is advisable to use images in HTML help documentation, should images vary between language packs? The best long term solution would be to consider anything within help documentation to be language-specific, thus images would be stored within the language packs. If so, then there needs to be an easier way to referencing the images instead of building a full path to them every time one is needed.

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Moodle. Try JIRA - bug tracking software for your team.