Toggle the table of contents

Projects/Usability/HIG/Contributing: Difference between revisions

From KDE TechBase

Revision as of 09:48, 5 September 2013

Report problems

If you found an area that was unclear or is not even covered in our HIG, tell us about it. We can be reached on the kde-guidelines mailing-list.

Conventions

Following is a set of guidelines to ensure the HIG itself is consistent.

Terminology

Use the word Control, not Widget to refer to a user interface element. Rationale: "Control" is more widespread outside the UNIX community. It is also reasonable to expect more and more applications will be written using QtQuick and QtQuick controls in the future.

Use check box and combo box, not checkbox or combobox.

TODO

Start page

~~Figure out what to do of the legacy stuff (at the bottom of the page)~~

Projects/Usability/HIG/Dialogs

Fix missing page: inline-editing
Fix missing page: info panels
Review guidelines about alignments: they duplicate/contradict the one from Form: Label Alignment

Projects/Usability/HIG/ListView

~~Purpose~~
~~Recommendation should be checked~~
~~Guidelines~~
~~Add subsections~~
~~Selection~~
Check against recommendation.
Choose between either:
In any other case, use the dual-list pattern because it allows users to easily see which items are selected at any point, without having to scroll through the available options

Use a list box for multiple selections with more than five options.

Get a new type of check boxes for list views implemented: KCheckBoxes:

KCB are flat (no frame, no shadow, no bevel) for clear differentiation from normal check boxes.
KCB are hidden by default, that means when no list item is selected.
KCB have a fade-in effect on mouse over to introduce themselves to users.
KCB are transparent and therby clearly part of the list item.
Legacy keyboard use applies to KCB as well. Thus, the whole item can be clicked to toggle option.

Multiple selection

A proposed layout for selection of multiple items in long lists.

Checking an item in [Available Items] includes it in [Selected Items]
Unchecking an item in [Available Items] removes it from [Selected Items]
Clicking an item in [Selected Items] removes it from [Selected Items] and selects it in [Available Items]
- (Alternate behavior: click item at [Selected Items] to select it in [Available Items]; click X to remove it from [Selected Items]. With this behavior, the hint "Click item to remove" is not needed)

If the workflow doesn't require remembering which items have been included so far, [Selected Items] can be hidden.

Projects/Usability/HIG/Radio_Buttons

Add inline examples of do and don't

Projects/Usability/HIG/Check_Box

Redo screenshots using Designer
~~Fix missing page: list~~

Projects/Usability/HIG/SOU_Workspace/Two_Lists

~~Move to Projects/Usability/HIG/Two_Lists? That is, drop "SOU_Workspace" from the url~~
Redo screenshots using Designer
~~Fix missing page: Selecting Items from a Pool~~
~~Fix missing page: Picker Dialog~~

Projects/Usability/HIG/Slider

~~Refresh page: it is copied from GNOME guidelines and contains references to figures we do not have~~

Projects/Usability/HIG/Notifications

Finish it (currently marked "Under Construction")

Projects/Usability/HIG/KNS

Redo screenshots

Projects/Usability/HIG/Wording

Use Options for a configuration dialog which provide.: Ask Celeste what she meant to add after provide.

Projects/Usability/HIG/Exclamation_points

Redo screenshots

Projects/Usability/HIG/Date_Time_Pickers

Pick one of KDateComboBox and KDateWidget or provide guidelines explaining when to use one or the other
Review the dropdown of KDateComboBox: it is probably too big

Projects/Usability/HIG/Menu_Bar

Redo screenshots

Projects/Usability/HIG/Slider_and_Spin_Box

Examples and illustrations
~~What happens if when SSB gets the focus?~~
~~Do we want to encourage the use of combined control?~~
~~In which case should the simple slider be favored?~~

Projects/Usability/HIG/edits

~~Split in two pages: line edits and text edits~~

Projects/Usability/HIG/Combo_Box

~~Split in two pages: drop-down and combobox~~

kdehig repository

Document how to use it
Move it to KDE playground
Integrate designer files from http://techbase.kde.org/File:HIG-UI-Files.tar.gz

Wish list

Balloons

Retrieved from "https://techbase.kde.org/index.php?title=Projects/Usability/HIG/Contributing&oldid=80961"

@@ Line 12: / Line 12: @@
 = TODO =
 == Start page ==
-* Figure out what to do of the legacy stuff (at the bottom of the page)
+*<s> Figure out what to do of the legacy stuff (at the bottom of the page)</s>
 == [[Projects/Usability/HIG/Dialogs]] ==
 * Fix missing page: [[Design_and_Layout:Interaction:Input#Inline Editing|inline-editing]]
 * Fix missing page: [[Guidelines:Info Panel|info panels]]
+* Review guidelines about alignments: they duplicate/contradict the one from [[Projects/Usability/HIG/Form_Label_Alignment|Form: Label Alignment]]
 == [[Projects/Usability/HIG/ListView]] ==
+<s>
 === Purpose ===
 Recommendation should be checked
@@ Line 31: / Line 33: @@
 # In any other case, use the dual-list pattern because it allows users to easily see which items are selected at any point, without having to scroll through the available options
 # Use a list box for multiple selections with more than five options.
+</s>
 Get a new type of check boxes for list views implemented: KCheckBoxes:
@@ Line 37: / Line 40: @@
 * KCB have a fade-in effect on mouse over to introduce themselves to users.
 * KCB are transparent and therby clearly part of the list item.
 * Legacy keyboard use applies to KCB as well. Thus, the whole item can be clicked to toggle option.
+==== Multiple selection ====
+A proposed layout for selection of multiple items in long lists.
+[[File:Multiple selection-remove.png]]
+*Checking an item in [Available Items] includes it in [Selected Items]
+*Unchecking an item in [Available Items] removes it from [Selected Items]
+*Clicking an item in [Selected Items] removes it from [Selected Items] and selects it in [Available Items]
+**(Alternate behavior: click item at [Selected Items] to select it in [Available Items]; click X to remove it from [Selected Items]. With this behavior, the hint "Click item to remove" is not needed)
+If the workflow doesn't require remembering which items have been included so far, [Selected Items] can be hidden.
+== [[Projects/Usability/HIG/Radio_Buttons]] ==
+* Add inline examples of do and don't
 == [[Projects/Usability/HIG/Check_Box]] ==
 * Redo screenshots using Designer
-* Fix missing page: [[Projects/Usability/HIG/ListBox| list]]
+* <s>Fix missing page: [[Projects/Usability/HIG/ListBox| list]]</s>
 == [[Projects/Usability/HIG/SOU_Workspace/Two_Lists]] ==
-* Move to Projects/Usability/HIG/Two_Lists? That is, drop "SOU_Workspace" from the url
+* <s>Move to Projects/Usability/HIG/Two_Lists? That is, drop "SOU_Workspace" from the url</s>
 * Redo screenshots using Designer
-* Fix missing page: [[../Selecting Items from a Pool|Selecting Items from a Pool]]
+* <s>Fix missing page: [[../Selecting Items from a Pool|Selecting Items from a Pool]]</s>
-* Fix missing page: [[../Picker Dialog|Picker Dialog]]
+* <s>Fix missing page: [[../Picker Dialog|Picker Dialog]]</s>
 == [[Projects/Usability/HIG/Slider]] ==
-* Refresh page: it is copied from GNOME guidelines and contains references to figures we do not have
+* <s>Refresh page: it is copied from GNOME guidelines and contains references to figures we do not have</s>
 == [[Projects/Usability/HIG/Notifications]] ==
-=== Purpose ===
+* Finish it (currently marked "Under Construction")
-* Fix missing page: [[Usability/HIG/NotificationMechanism|notification mechanism]]
-* Fix missing page: [[Projects/Usability/HIG/CentralConfiguration|central configuration]]
-=== Examples ===
+== [[Projects/Usability/HIG/KNS]] ==
-* Add screenshots
+* Redo screenshots
-=== Guidelines ===
+== [[Projects/Usability/HIG/Wording]] ==
-* ''Do not add controls to notification.''
+* ''Use Options for a configuration dialog which provide.'': Ask Celeste what she meant to add after ''provide''.
-** Thomas: I would remove this. Adding action buttons is allowed in the API and has reasonable use cases, other controls simply cannot be added technically
-* ''Do not override system settings.''
+== [[Projects/Usability/HIG/Exclamation_points]] ==
-** (remark: more specific)
+* Redo screenshots
-** Thomas: Which settings do you mean here?
-* ''Provide title and content text''
+== [[Projects/Usability/HIG/Date_Time_Pickers]] ==
-** (remark: not precise enough)
+* Pick one of KDateComboBox and KDateWidget or provide guidelines explaining when to use one or the other
-** Thomas: guidelines regarding the wording of title and content are indeed very important. Maybe celeste can help here.
+* Review the dropdown of KDateComboBox: it is probably too big
-* ''Customize notification with the origin's icon.''
+== [[Projects/Usability/HIG/Menu_Bar]] ==
-** Heiko: word "origin" needs to be replaced; "icon" might be replaced by technical term
+* Redo screenshots
+== [[Projects/Usability/HIG/Slider_and_Spin_Box]] ==
+* Examples and illustrations
+* <s>What happens if when SSB gets the focus?</s>
+* <s>Do we want to encourage the use of combined control?</s>
+* <s>In which case should the simple slider be favored?</s>
-* ''Provide actionable information (e.g. "Low battery power" "Only 13 min (2%) capacity remaining. Please save your stuff now. Your system will get shut down soon.")''
+== [[../edits]]==
-** should be according actual text
+* <s>Split in two pages: line edits and text edits</s>
-* Heiko: to be defined: Are all notifications configured in KCM? If not, how to separate?
+== [[../Combo_Box]]==
-** Kai Uwe: All notifications emitted through KNotify (ie. application has a notifyrc file) can be configured. Using the FDO notification dbus iface directly is discouraged. In 4.11 there's a configure button on notifications.
+* <s>Split in two pages: drop-down and combobox</s>
 == kdehig repository ==
@@ Line 85: / Line 103: @@
 * Move it to KDE playground
 * Integrate designer files from http://techbase.kde.org/File:HIG-UI-Files.tar.gz
+= Wish list =
+* Balloons
+[[File:Balloon.png]]