summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShara Miller <shara.miller@gmail.com>2011-10-16 13:10:33 -0500
committerShara Miller <shara.miller@gmail.com>2011-10-16 13:10:43 -0500
commit617d30da8f0bddd0ed5f4bdf2c28626d2ac0fb71 (patch)
tree307e96b5606aa7c211d27f3950471ad3e12a515d
parentabf436c6ee4b24bb088338b646fc50df121e63f1 (diff)
downloadxfce4-docs-617d30da8f0bddd0ed5f4bdf2c28626d2ac0fb71.tar.gz
Added first draft of Clock documentation.
-rw-r--r--clock.page137
1 files changed, 132 insertions, 5 deletions
diff --git a/clock.page b/clock.page
index 879e10e..7e3cf96 100644
--- a/clock.page
+++ b/clock.page
@@ -17,20 +17,147 @@
<title>Clock</title>
- <p></p>
+ <p>The <app>Clock</app> panel plugin displays the current time in a variety of styles and formats.</p>
<section id="properties">
<title>Properties</title>
+ <figure>
+ <title>Clock's properties dialog</title>
+ <media type="image" src="figures/clock.png" mime="image/png" style="right"/>
+ </figure>
+
+ <section id="appearance">
+ <title>Appearance</title>
+ <terms>
+ <title><gui>Layout</gui></title>
+ <item>
+ <terms>
+ <item>
+ <title><gui>Analog</gui></title>
+ <p>
+ Displays time as a clock face with hands representing the current hour, minute, and seconds.
+ </p>
+ </item>
+ <item>
+ <title><gui>Binary</gui></title>
+ <p>
+ Displays a binary clock.
+ </p>
+ </item>
+ <item>
+ <title><gui>Digital</gui></title>
+ <p>
+ A simple time display with multiple formats.
+ </p>
+ </item>
+ <item>
+ <title><gui>Fuzzy</gui></title>
+ <p>
+ Displays an approximation of the current time.
+ </p>
+ </item>
+ <item>
+ <title><gui>LCD</gui></title>
+ <p>
+ Displays the time in the style of a digital LCD click.
+ </p>
+ </item>
+ </terms>
+ </item>
+
+ </terms>
+ <terms>
+ <item>
+ <title><gui>Tooltip Format</gui></title>
+ <p>
+ Changes how the time is displayed when hovering over the clock display.
+ </p>
+ </item>
+ <item>
+ <title><gui>Show Frame</gui></title>
+ <p>
+ Displays a frame around the clock display.
+ </p>
+ </item>
+
+ </terms>
+ </section>
+
+ <section id="clock-options">
+ <title>Clock Options</title>
+ <note>
+ <p>
+ The options available in <gui>Clock Options</gui> will vary depending on the clock <gui>Layout</gui> selected.
+ </p>
+ </note>
+
+ <terms>
+ <item>
+ <title><gui>24-hour Clock</gui></title>
+ <p>
+ Displays time in a 24-hour (military) format. <em>(<gui>LCD</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Display Seconds</gui></title>
+ <p>
+ Displays a seconds indicator in the clock display. <em>(<gui>Analog</gui>, <gui>LCD</gui>, and <gui>Binary</gui> layouts only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Flash Time Seperators</gui></title>
+ <p>
+ Flash the seperators between digits. <em>(<gui>LCD</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Format</gui></title>
+ <p>
+ Changes the time format of the clock with predefined or custom layout. <em>(<gui>Digital</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Fuzziness</gui></title>
+ <p>
+ Changes the degree of 'fuzziness' that the clock will display. <em>0</em> being the most accurate, <em>1</em> being less accurate,
+ and <em>2</em> being the least accurate. <em>(<gui>Fuzzy</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Show AM/PM</gui></title>
+ <p>
+ Displays an 'A' or 'P' to indicate the time of day. <em>(<gui>LCD</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Show Grid</gui></title>
+ <p>
+ Adds gridlines to the clock. <em>(<gui>Binary</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>Show Inactive Dots</gui></title>
+ <p>
+ All dots that are empty are not shown in the clock display. <em>(<gui>Binary</gui> layout only.)</em>
+ </p>
+ </item>
+ <item>
+ <title><gui>True Binary Clock</gui></title>
+ <p>
+ Displays a seconds indicator in the clock display. <em>(<gui>Binary</gui> layout only.)</em>
+ </p>
+ </item>
+
+
+ </terms>
+ </section>
+
</section>
<section id="theming">
<title>Style Properties</title>
- <figure>
- <title>Clock's properties dialog</title>
- <media type="image" src="figures/clock.png" mime="image/png" style="right"/>
- </figure>
</section>
</page>