SMF Development > Bug Reports
Visual presentation bugs and errors
BeeKay:
Having recently completed an initial 'translation' of much of the English_British language pack v2.0.x, one of the things that has become increasingly obvious to me is the lack of consistency in the visual presentation of the configuration screens For example:
1. On some pages the selection item is on the left with the selection box on the right while on other pages it is reversed.
2. On some items the ending punctuation is hard-coded while elsewhere it is part of the language file.
3. In some places the required input unit (e.g. minutes, days etc.) is placed after the selection box while in other places it is part of the selection item definition in the language file.
4. On many screens there is a mixture of sentence case and camel/proper case used for titles, headings etc.
In many cases I have identified where changes are required to the source or template files to standardise the layout. A minor correction to the coding works in nearly every case, so here is the first of those bugs/corrections.
Firstly, in accordance with the Bug Report guidelines:
My setup:
SMF version: 2.0.2 (patched from 2.0.1)
Modifications installed: None
Themes installed: Standard
Non-English language packs installed: English_British
Using UTF-8: No
Any other related information: None
Server software:
Apache/IIS version: 2.2.14
PHP version: 5.3.1
Database type and version: MySQL 5.4.1
Any other related server information: None
Where the error occurred:
File: Register.template.php
Function: template_verification_sound()
Line: 490-491, 504-507
Relevant errors in the SMF error log: None
How to reproduce the error:
From the initial screen, select Register -> Accept the agreement -> Listen to the sounds
Also occurs when validating a personal message (and posting this topic) but they use the same function
Additional Information:
1. The Help popup that appears is black text on dark blue background making it very difficult to read.
Current code (lines 490-491)
--- Code: ---<body style="margin: 1ex;">
<div class="popuptext" style="text-align: center;">';
--- End code ---
Changing this code to the standard Help popup will produce a standard black text in a white box on the dark blue background.
Modified code (lines 490-491)
--- Code: ---<body id="help_popup">
<div class="windowbg description" style="text-align: center;">';
--- End code ---
2. The contents of the Help popup (above) should also be reorganised so that they are spaced further apart and the 'Close window' option comes last (as standard).
Current code (lines 504-507)
--- Code: ---<br />
<a href="', $context['verification_sound_href'], ';sound" rel="nofollow">', $txt['visual_verification_sound_again'], '</a><br />
<a href="javascript:self.close();">', $txt['visual_verification_sound_close'], '</a><br />
<a href="', $context['verification_sound_href'], '" rel="nofollow">', $txt['visual_verification_sound_direct'], '</a>
--- End code ---
Modified code (lines 504-507)
--- Code: ---<br /><br />
<a href="', $context['verification_sound_href'], ';sound" rel="nofollow">', $txt['visual_verification_sound_again'], '</a><br /><br />
<a href="', $context['verification_sound_href'], '" rel="nofollow">', $txt['visual_verification_sound_direct'], '</a><br /><br />
<a href="javascript:self.close();">', $txt['visual_verification_sound_close'], '</a><br /><br />
--- End code ---
Joker™:
First of all thanks for such detailed report.
Regarding your bug report:
1. Yes that can be termed as bug in terms of consistency.
2. Dev's can decide on that whether we need revamp in that area or not.
--- Quote from: BeeKay on December 31, 2011, 10:24:21 AM ---1. On some pages the selection item is on the left with the selection box on the right while on other pages it is reversed.
2. On some items the ending punctuation is hard-coded while elsewhere it is part of the language file.
3. In some places the required input unit (e.g. minutes, days etc.) is placed after the selection box while in other places it is part of the selection item definition in the language file.
4. On many screens there is a mixture of sentence case and camel/proper case used for titles, headings etc.
--- End quote ---
Can you tell us more instances related to that, so that we can trace the bugs collectively on the tracker :).
BeeKay:
--- Quote from: Joker™ on January 03, 2012, 05:49:03 AM ---
--- Quote from: BeeKay on December 31, 2011, 10:24:21 AM ---1. On some pages the selection item is on the left with the selection box on the right while on other pages it is reversed.
2. On some items the ending punctuation is hard-coded while elsewhere it is part of the language file.
3. In some places the required input unit (e.g. minutes, days etc.) is placed after the selection box while in other places it is part of the selection item definition in the language file.
4. On many screens there is a mixture of sentence case and camel/proper case used for titles, headings etc.
--- End quote ---
Can you tell us more instances related to that, so that we can trace the bugs collectively on the tracker :).
--- End quote ---
Thanks for your reply. I will post my findings in this topic over the next few days/weeks. Can't do them all at once as I'm gradually working through all the screens again after completing the initial language work. A drip feed will probably be best anyway. Many of the changes are quite minor and almost all of the instances are in the configuration screens rather than the boards and topics themselves.
As already mentioned, in many cases I have identified (and tested) where changes can be made to improve the visual presentation and will include my suggested re-coding with the reports. One of the things I find about commercial software (obviously SMF is not commercial) is it's consistency of layout which I think at present some of SMF doesn't have - hence my input. No offence intended - I like the programme and the way it has been implemented.
Just for reference, I'm testing on my own local unmodified installation of SMF v2.0.2 using Windows XP Pro, IE8 and Firefox 9 with Firebug.
BeeKay:
--- Quote from: Joker™ on January 03, 2012, 05:49:03 AM ---
--- Quote from: BeeKay on December 31, 2011, 10:24:21 AM ---1. On some pages the selection item is on the left with the selection box on the right while on other pages it is reversed.
2. On some items the ending punctuation is hard-coded while elsewhere it is part of the language file.
3. In some places the required input unit (e.g. minutes, days etc.) is placed after the selection box while in other places it is part of the selection item definition in the language file.
4. On many screens there is a mixture of sentence case and camel/proper case used for titles, headings etc.
--- End quote ---
Can you tell us more instances related to that, so that we can trace the bugs collectively on the tracker :).
--- End quote ---
You asked for more instances of the items I referred to above so here are quite a few. Read as key strokes to get to the example followed by my comments on what needs to be done to produce a better visual experience!
--------------------------------------------------------------------------------
1. On some pages the selection item is on the left with the selection box on the right while on other pages it is reversed.
Overall layout is generally selection item/caption on the left with selection/input box on the right and this should be the standard.
However for Themes, in particular, this is generally reversed at present.
Profile -> Modify Profile -> Look and Layout -> Profile
Layout between second and third horizontal lines has checkboxes and input boxes to the left of the selection item/caption.
Coded as a list (<li>) rather than definitions (<dt>/<dd>) like most other pages.
Requires modification of function template_profile_theme_settings in Profile.template.php lines 1460-1583.
Exact details of the template modification to follow.
Admin -> Configuration -> Themes and Layout -> Member Options -> Configure guest and new user options for this theme
Admin -> Configuration -> Themes and Layout -> Member Options -> Change current options for all members using this theme
Layout on both pages has checkboxes and input boxes to the left of the selection item/caption.
Coded as a list (<li>) rather than definitions (<dt>/<dd>) like most other pages.
Requires modification of function template_set_options in Themes.template.php lines 343-422.
Exact details of the template modification to follow.
Profile -> Modify Profile -> Notifications -> Profile
Layout in the top section has checkboxes and input boxes to the left of the selection item/caption.
Coded as input and label rather than definitions (<dt>/<dd>) like most other pages.
Requires modification of function template_notification in Profile.template.php lines 1585-1654.
Exact details of the template modification to follow.
--------------------------------------------------------------------------------
2. On some items the ending punctuation is hard-coded while elsewhere it is part of the language file.
Profile -> Modify Profile -> Account Settings -> Profile
'Current Password', 'Primary Membergroup', 'Additional Membergroups' all end with hard-coded colon but other labels do not.
Requires modification of function template_edit_options in Profile.template.php line 1199 so that all labels end with colons for consistency with other pages.
Exact details of the template modification to follow.
Profile -> Modify Profile -> Forum Profile -> Profile
'Birthdate' ('Date of Birth'), 'Signature' and 'Karma' all end with hard-coded colon but other labels do not.
Requires modification of function template_edit_options in Profile.template.php line 1199 so that all labels end with colons for consistency with other pages.
Exact details of the template modification to follow.
Profile -> Modify Profile -> Personal Messaging -> Profile
Some prompts end with hard-coded colon, other prompts with no punctuation.
Requires modification of function template_profile_pm_settings Profile.template.php lines 1376-1457.
Can't be changed until other templates modified as variable is used elsewhere.
Exact details of the template modification to follow.
Admin -> Members -> Ban List -> Add New Ban -> Expiry
Hard-coded colon after 'Ban will expire after' but not on any of the other options.
Requires modification of function template_ban_edit in ManageBans.template.php line 62 to remove hard-coded colon.
Exact details of the template modification to follow.
Admin -> Members -> Ban List -> Add New Ban -> Triggers
Hard-coded colon after 'Ban on username' but not on any of the other options.
Requires modification of function template_ban_edit in ManageBans.template.php line 113 to remove hard-coded colon.
Exact details of the template modification to follow.
Profile -> Errors
Hard-coded colon/full stop is inconsistent with all other error messages.
Requires modification of function template_error_message in Profile.template.php lines 2487 and 2494.
Exact details of the template modification to follow.
Profile -> Modify Profile -> Look and Layout -> Profile
There are 5 combo boxes at the bottom of the page. Four do NOT have a hard-coded colon in the template but the item 'First day of the week...' DOES have a hard-coded colon.
Can be corrected in the language file but why should that be necessary because these 5 items are not coded the same?
Requires modification of function template_profile_theme_settings in Profile.template.php line 1589.
Exact details of the template modification to follow.
--------------------------------------------------------------------------------
3. In some places the required input unit (e.g. minutes, days etc.) is placed after the selection box while in other places it is part of the selection item definition in the language file.
Admin -> Forum -> Posts and Topics -> Post Settings
Admin -> Forum -> Posts and Topics -> Topic Settings
Both these pages show input units after input boxes.
Units included in array definition in function ModifyPostSettings in Sources/ManagePosts.php lines 194-196 and 199-201.
This is HOW IT SHOULD BE DONE throughout the programme!
Admin -> Forum -> Attachments and Avatars -> Attachment Settings
Attachment Settings page shows some input units after input boxes.
Requires modification of function ManageAttachmentSettings in Sources/ManageAttachments.php lines 188/9 to include units.
Modification needs new variable ($txt['pixels']) defined in language file.
Language file definitions can then have the units removed (2 lines).
Exact details of the source file modification to follow.
Admin -> Forum -> Attachments and Avatars -> Avatar Settings
Avatar Settings page does not show input units after input boxes.
Requires modification of function ManageAvatarSettings in Sources/ManageAttachments.php lines 235/6 and 248/9 to include units.
Modification needs new variable ($txt['pixels']) defined in language file.
Language file definitions can then have the units removed (4 lines)'.
Exact details of the source file modification to follow.
Admin -> Configuration -> Current Theme -> Themes and Options Preferences
Item 'Fader delay....' has no indication of input units.
Modification needs new variable ($txt['milliseconds'])) defined in language file.
Language file definitions can then have the units removed.
Can't find where to modify template file yet.
Exact details of the file modification to follow.
Admin -> Configuration -> Features and Options -> General
The fields 'Overall time offset' and 'User online time threshold' need units specified (hours, minutes respectively) but are not included in the sources, template or language files.
Requires modification of function ModifyBasicSettings in Sources/ManageSettings.php, lines 472 and 477 to include units.
Modification needs new variable ($txt['minutes'])) defined in language file ($txt['hours'] already defined).
Language file definitions can then have the units removed (2 lines).
Exact details of the source file modification to follow.
--------------------------------------------------------------------------------
4. On many screens there is a mixture of sentence case and camel/proper case used for titles, headings etc.
Register -> Registration Form -> Required Information
'Email' should be 'Email Address', 'Choose password' and 'Verify password' should both be camel case.
Changing variable definition in the language file changes other labels incorrectly.
Modification would need new camel case variables defined in language file.
Profile -> Modify Profile -> Account Settings -> Profile
'Choose password' and 'Verify password' are sentence case while every other label is camel case.
Changing variable definition in the language file changes these labels incorrectly when used elsewhere.
Modification would need new camel case variables defined in language file.
Profile -> Modify Profile -> Account Settings -> Profile
'Choose password' and 'Verify password' are sentence case while every other label is camel case.
Changing variable definition in the language file changes these labels incorrectly when used elsewhere.
Modification would need new camel case variables defined in language file.
Admin -> Main -> Package Manager -> Download Packages
In the 'Download New Packages' section, the titles of the boxes are sentence case but should be camel case for consistency.
However, words like 'a, by, with, for, and, etc. should never be capitialised.
Variable definitions can be changed in the relevant language file.
Admin -> Members -> Membergroups -> Add Membergroup
'Membergroup name' and 'Required posts' labels are sentence case while every other label on the left side is camel case.
'Select Group Type' box label on the right is camel case while other 2 box labels are sentence case.
Variable definitions can be changed in the relevant language file.
--------------------------------------------------------------------------------
Quite a long list but by no means a complete one!
Do you wish me to post the code modifications in full here or would it be better to put them in files and attach to my posts?
Antechinus:
Thanks for the feedback. Do it the way that is easiest for you. Given the number of tweaks, perhaps just edited files with comments added might be best, since I assume you already have the edited files.
Navigation
[0] Message Index
[#] Next page
Go to full version