MoodleDocs - User contributions [en]

Interface guidelines

2009-04-04T13:55:07Z

Lashae: /* Language strings */

{{Work in progress}}
This document is not authoritative, it is a collection of ideas and under construction.

==Keeping it simple==

Use the minimum interface required to get the job done.
Order the elements by contexts. Give the user a strong orientation where the places are to do several things.

==Standard pages==

===Activity modules===

*''index.php'' - lists all instances for that module in a course
*''view.php'' - displays a particular instance
*''config.html'' - configure an instance of the module

===Blocks===

*''config.html'' - configure an instance of the block

==One script per major function/page==

...

==Page layout==

# Print headings with print_heading, use the CSS hooks for IDs and Classes
# Print boxes around text using print_simple_box, use the CSS hooks for IDs and Classes

==Form layout==

# Show the more important settings at the top
# Each entry should have a label, and if necessary, a help file
# If there are more than 10 options, split them into required and optional/extra/advanced parameters

==Dealing with tables==

Use the print_table function whenever possible.

==Standard navigation tools==

# All pages should call print_header, and supply a standard navigation path to be displayed in it. Where possible, it should look like: COURSE >> INDEX >> INSTANCE >> SUBPAGES...
# Pages within activity modules should call navmenu() to generate the appropriate navigation menu.
# Links should include associated image (if available). For example, looking at an assignment in a course displays the assignment pic and then the assignment description as a single link; however, most of the blocks like the activity block exclude the image from the link. This is important as some folks are more graphically rather than text oriented and click on the picture and do not understand why it is not working. We need to be consistent (see MDL-6820).

==URLs==

# URLs should be as short as possible.
# No underscores in parameter names or files names
# Never use two words when one would do.

==Buttons vs links==

This is a hard one to define ...

The Google Web Accelerator issue definitely provides some pointers here:

# Actions which can modify the state of Moodle (data files, database, session information) should be performed through buttons
# At the very least, such actions which are implemented as links should forward to a confirmation page which *does* use buttons

==Language strings==

# Use your own language strings in a separate file. Don't use existing language files from moodle.php or other lang files. So translators can translate in the contexts in different ways as terms are used in the special learning culture.

==CSS naming==

* Don't add font, color or layout definitions in code. This belongs to CSS theme files.
* See [[Standards|theme standards]]

==Linking to help==

* Help buttons should be on the right of the thing (as an exception it can be left, if the thing is right-aligned)

==Related topics==

Robin Good's Latest News. "Interaction Design Meets Online Real Estate" 1 Mar. 2005 http://www.masternewmedia.org/news/2005/03/01/interaction_design_meets_online_real.htm

The article presents a view of virtual spaces with the focus on human actions. It reminded me of communicative approaches like Moodle. The interface serves as the handle of all the communication tools.

[[pt:Guia para interface]]
[[es:Manual de estilo de la interfaz]]
[[ja:インターフェースガイドライン]]

Talk:Interface guidelines

2009-04-04T13:50:47Z

Lashae:

I want to contribute for the "Language Strings" title.

The prepositions in English usually does not correspond to meaningfull words in other languages. Say "'''3 of 10 is being displayed'''" string should be coded in the language file as is.

Wrong Approach:
----
Phrase 1: '''of'''

Phrase 2: '''is being displayed'''

Instead, the correct approach is:
----
Phrase: '''%s of %s is being displayed'''

Because the preposition may or may not exist in the translation as a word, therefore the translated string may also be shuffled, i.e. may not be starting with "3" for the specific example above.

I think, this problem can be avoided by setting a guideline for it like:

"Use whole sentences or sub-sentences as language strings, do not divide your sentence into words of prepositions to avoid dublication in translations. Because not all the languages have the same grammer and linguistics that English built on."

This way, the the translated UI would be much more understandable.

Talk:Interface guidelines

2009-04-04T13:49:06Z

Lashae: Language Strings, prepositions and non-standard linguistics

I want to contribute for the "Language Strings" title.

The prepositions in English usually does not correspond to meaningfull words in other languages. Say "'''3 of 10 is being displayed'''" string should be coded in the language file as is.

Wrong Approach:
----
Phrase 1: '''of'''

Phrase 2: '''is being displayed'''

Instead, the correct approach is:
----
Phrase: '''%s of %s is being displayed'''

Because the preposition may or may not exist in the translation as a word, therefore the translated string may also be shuffled, i.e. may not be starting with "3" for the specific example above.

I think, this problem can be avoided by setting a guideline for it like:

"Use whole sentences or sub-sentences as language strings, do not divide your sentence into words of prepositions to avoid dublication in translations. Because not all the languages have the same grammer and linguistics that has English."

This way, the the translated UI would be much more understandable.