GConf Keys
GConf keys are required to have long and short descriptions for each key. Many keys have no interface through the application, so for someone administering the key values from another application each description field will be the only interface available to them.
Guidelines
- Short Descriptions should be short, less than 8 words, describing the purpose of the key
- Long Description should be complete in describing the possible values of the key and the effects that those values have on the application
Example 2-8 Example descriptions for GConf Keys from gnome-terminal
| Key | Short Description | Long Description |
|---|---|---|
| background_type | Background type | Type of terminal background. May be "solid" for a solid color, "image" for an image, or "transparent" for pseudo-transparency. |
| delete_binding | Effect of the Delete key | Sets what code the delete key generates. Possible values are "ascii-del" for the ASCII DEL character, "control-h" for Control-H (AKA the ASCII BS character), "escape-sequence" for the escape sequence typically bound to backspace or delete. "escape-sequence" is normally considered the correct setting for the Delete key. |