(→Category Names) |
|||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
== What These Guidelines (Will) Cover == | == What These Guidelines (Will) Cover == | ||
| Line 5: | Line 7: | ||
== Category Names == | == Category Names == | ||
| − | The following are acceptable known entries for plasmoids and applets. If your applet does not fall within one of the following categories, leave the category field empty (it will be automatically | + | The following are acceptable known entries for plasmoids and applets. If your applet does not fall within one of the following categories, leave the category field empty (it will be automatically categorized under "Miscellaneous" for the time being) and contact the Plasma development team to have a suitable category added to the list (at which point you may then use that category). |
| + | *'''Accessibility''' tools that help those with special needs or disabilities use their computer | ||
*'''Application Launchers''' application starters and file openers. | *'''Application Launchers''' application starters and file openers. | ||
*'''Astronomy''' anything to do with the night sky or other celestial bodies. | *'''Astronomy''' anything to do with the night sky or other celestial bodies. | ||
*'''Date and Time''' clocks, calendars, scheduling, etc | *'''Date and Time''' clocks, calendars, scheduling, etc | ||
| + | *'''Development Tools''' tools and utilities to aid software developers | ||
*'''Education''' teaching and educational aides | *'''Education''' teaching and educational aides | ||
*'''Environment and Weather''' add-ons that display information regarding the weather or other environmentally related data | *'''Environment and Weather''' add-ons that display information regarding the weather or other environmentally related data | ||
Contents |
This document is a place to collect all the "do"s, "don't"s and "how to"s for interface elements in Plasma, particularly applets and plasmoids.
The following are acceptable known entries for plasmoids and applets. If your applet does not fall within one of the following categories, leave the category field empty (it will be automatically categorized under "Miscellaneous" for the time being) and contact the Plasma development team to have a suitable category added to the list (at which point you may then use that category).
Since your plugins and packages will co-exist with everyone else's, it is a good idea to use a naming scheme that eliminates possibility of accidental name collisions.
In the examples below where it referse to [name], consider including an element unique to your project or organization in it. For instance, if your packages accompany an application, consider including the name of the application. Using an organizational or domain name are also possibilities.
For example, if your plasmoid was called "SuperWidget", the [name] might be:
Plasma uses a "general to specific" naming system for .desktop files. Following this practice makes it easy to find entries in the file system and keeps things nicely ordered.
In the list below, [name] would most commonly be the plugin name as found in the file. Files autogenerated by ScriptEngines may include additional namespacing information in the file name.