Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
panel-ui-guidelines [2007/12/16 08:07] – mike | panel-ui-guidelines [2007/12/16 17:57] – worked on plugin classes (was categories) ongardie | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Rationale ===== | ===== Rationale ===== | ||
UI consistency is an important aspect of a mature desktop like Xfce. On the other hand, there are tons of panel plugins out there, developed by many different people. A written set of UI guidelines will help those developers ensure their plugins maintain some basic level of consistency. | UI consistency is an important aspect of a mature desktop like Xfce. On the other hand, there are tons of panel plugins out there, developed by many different people. A written set of UI guidelines will help those developers ensure their plugins maintain some basic level of consistency. | ||
+ | |||
+ | |||
===== Process ===== | ===== Process ===== | ||
New guidelines should be submitted as a draft at the bottom of the page, in the "Draft Guidelines" | New guidelines should be submitted as a draft at the bottom of the page, in the "Draft Guidelines" | ||
+ | |||
+ | ===== Plugin Classes ===== | ||
+ | Most guidelines apply differently based on the plugin class. (" | ||
+ | |||
+ | ==== Class B: Button ==== | ||
+ | < | ||
+ | |||
+ | sometimes opening a menu | ||
+ | |||
+ | examples: menu, places, launcher, window list, ... | ||
+ | |||
+ | ==== Class I: Input ==== | ||
+ | < | ||
+ | |||
+ | database queries, command execution, etc from the panel | ||
+ | |||
+ | examples: verve, dict(ionary) | ||
+ | |||
+ | ==== Class M: Monitor ==== | ||
+ | < | ||
+ | |||
+ | the resource monitoring ones | ||
+ | |||
+ | examples: system load monitor, battery monitor | ||
+ | |||
+ | ==== Class G: Grid ==== | ||
+ | < | ||
+ | |||
+ | examples: icon box, task list, system tray | ||
+ | |||
+ | ==== Class O: Other ==== | ||
+ | examples: pager, xfapplet | ||
===== Mature Guidelines ===== | ===== Mature Guidelines ===== | ||
Line 12: | Line 46: | ||
===== Draft Guidelines ===== | ===== Draft Guidelines ===== | ||
+ | |||
Line 17: | Line 52: | ||
This text is revision 1 of this guideline. | This text is revision 1 of this guideline. | ||
- | * Display an image inside a button | + | === Display an image inside a button |
- | * Plugins using it: //launcher (xfce4-panel)// | + | * Plugins using it: //launcher (xfce4-panel)// |
- | * Set the size of the image to:\\ '' | + | * Set the size of the image to:\\ '' |
+ | |||
+ | === Display a label === | ||
+ | * Plugins using it: //menu (xfdesktop)// | ||
+ | * Put the label inside a box and use a spacing of 4 on that box --- // | ||
+ | |||
+ | === Mix several widgets side by side === | ||
+ | * Plugins using it: // | ||
+ | * Use 2px spacing between the label/ | ||
- | * Display a label | ||
- | * Plugins using it: //menu (xfdesktop)// | ||
- | * Put the label inside a box and use a spacing of 4 on that box --- // | ||
- | * Mix several widgets side by side | ||
- | * Plugins using it: // | ||
- | * Use 2px spacing between the label/ | ||
==== Monitor Layout Guideline ==== | ==== Monitor Layout Guideline ==== | ||
- | * This text is revision | + | This text is revision |
- | * Core plugins implementing this guideline: ??? | + | |
- | * Additional plugins implementing this guideline: ??? | + | |
- | * Many plugins display a monitor | + | Many plugins display a monitor and give the user the option of showing a label, a value reading, or both. For example, the systemload plugin |
- | * For horizontal panels: | + | === Order to display widgets === |
- | | + | The order of the widgets, starting from the left or the top according |
- | * The value reading, if shown, should be placed | + | - Icon |
+ | - Name | ||
+ | - Monitor | ||
+ | - Value | ||
- | * For vertical panels: | ||
- | * The label, if shown, should be placed above the monitor. | ||
- | * The value reading, if shown, should be placed below the monitor. | ||
==== Text Guideline ==== | ==== Text Guideline ==== | ||
- | * This text is revision 1 of this guideline. | + | This text is revision 1 of this guideline. |
- | * Core plugins implementing this guideline: ??? | + | |
- | * Additional plugins implementing this guideline: ??? | + | === Name of the plugin === |
+ | * Use a short label to conserve space | ||
+ | * Use capitalization like a title (e.g., "My Button" | ||
- | * Plugins that display | + | === Name of a monitor === |
- | * Use a short label to conserve space | + | * Use a short label to conserve space. Abbreviations are acceptable |
- | * Use capitalization like a title (e.g., "My Button") | + | * Use all lowercase letters |
+ | * Omit spaces in acronyms and abbreviations (e.g., " | ||
+ | --- // | ||
- | * Plugins that display a static label on the panel to explain | + | === Display |
- | * Use a short label to conserve space. Abbreviations are acceptable. | + | * Don't include too much precision |
- | * Use all lowercase letters | + | * Include units if they add no more than 3 characters to the string |
- | * Omit spaces in acronyms and abbreviations | + | |
- | * Plugins that display a value reading next to a monitor: | ||
- | * Don't include too much precision (e.g., " | ||
- | * Include units if they add no more than 3 characters to the string (e.g., " |