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:17] – mike | panel-ui-guidelines [2007/12/16 18:02] – Nick: "it's GtkWidget->style" 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 53: | ||
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 | + | === Display a label === |
- | * Plugins using it: //menu (xfdesktop)// | + | * Plugins using it: //menu (xfdesktop)// |
- | * Put the label inside a box and use a spacing of 4 on that box --- // | + | * 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/ | ||
- | * Mix several widgets side by side | ||
- | * Plugins using it: // | ||
- | * Use 2px spacing between the label/ | ||
Line 35: | Line 72: | ||
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 can show labels and monitors for CPU, memory, and swap usage. | 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 can show labels and monitors for CPU, memory, and swap usage. | ||
- | * Order to display the widgets starting from the left or the top according to the panel orientation | + | === Order to display |
- | - Icon | + | The order of the widgets, starting from the left or the top according to the panel orientation, is the following: |
- | - Name | + | - Icon |
- | - Monitor | + | - Name |
- | - Value | + | - Monitor |
+ | - Value | ||
Line 45: | Line 84: | ||
This text is revision 1 of this guideline. | This text is revision 1 of this guideline. | ||
- | * Display a static label on the panel to explain an interactive widget | + | === Name of the plugin === |
- | * Use a short label to conserve space | + | * Use a short label to conserve space |
- | * Use capitalization like a title (e.g., "My Button" | + | * Use capitalization like a title (e.g., "My Button" |
- | * Display a static label on the panel to explain | + | === Name of a monitor |
- | * Use a short label to conserve space. Abbreviations are acceptable | + | * Use a short label to conserve space. Abbreviations are acceptable |
- | * Use all lowercase letters (e.g., " | + | * Use all lowercase letters (e.g., " |
- | * Omit spaces in acronyms and abbreviations (e.g., " | + | * Omit spaces in acronyms and abbreviations (e.g., " |
--- // | --- // | ||
- | * Display a value reading next to a monitor | + | === Display a value === |
- | * Don't include too much precision (e.g., " | + | * Don't include too much precision (e.g., " |
- | * Include units if they add no more than 3 characters to the string (e.g., " | + | * Include units if they add no more than 3 characters to the string (e.g., " |