GNOME.org
 

Comments on hardware layout

Goals:
* Make guides more compact and easier to scan. I want people
  to spend as little time as possible on guide pages.
* Trim down those links trails. Especially when we get guide
  pages linked from guide sections of essentially the same
  name: "Hardware > Printing >> Printing >>"

So I took a stab at using the grid ("toronto") layout on the
hardware guide page. This is the same thing I did on prefs.
It's not done. I'm not sure what to do with some pages.

Using the grid layout with links in descs gives us, I think,
a nice way of promoting some subtopics without introducing
extra link trails and guide links and navigational craziness.

Patch attached. This is only on a local branch on my machine,
because I'm keeping master stable. I'd like feedback.

--
Shaun


>From 648050c820083ab560508177be8cf619cca92ce5 Mon Sep 17 00:00:00 2001
From: Shaun McCance <shaunm gnome org>
Date: Thu, 7 Apr 2011 22:04:09 -0400
Subject: [PATCH] hardware: First pass at grid layout on hardware

---
 gnome-help/C/bluetooth-connect-device.page       |    2 +-
 gnome-help/C/bluetooth-problem-connecting.page   |    2 +-
 gnome-help/C/bluetooth-remove-connection.page    |    2 +-
 gnome-help/C/bluetooth-send-file.page            |    2 +-
 gnome-help/C/bluetooth-turn-on-off.page          |    2 +-
 gnome-help/C/bluetooth.page                      |   22 ++++++++++++++++
 gnome-help/C/disk-benchmark.page                 |    2 +-
 gnome-help/C/disk-capacity.page                  |    2 +-
 gnome-help/C/disk-check.page                     |    2 +-
 gnome-help/C/disk-format.page                    |    2 +-
 gnome-help/C/disk-partitions.page                |    2 +-
 gnome-help/C/disk.page                           |   23 +++++++++++++++++
 gnome-help/C/hardware.page                       |   29 +--------------------
 gnome-help/C/power-batterybroken.page            |    1 -
 gnome-help/C/power-closelid.page                 |    1 -
 gnome-help/C/power-suspendfail.page              |    1 -
 gnome-help/C/power-suspendhibernate.page         |    1 -
 gnome-help/C/power-turnoffbutton.page            |    2 +-
 gnome-help/C/power.page                          |   11 +++-----
 gnome-help/C/printing-paperjam.page              |    1 -
 gnome-help/C/printing-setup-default-printer.page |    1 -
 gnome-help/C/printing-setup.page                 |    1 -
 gnome-help/C/printing.page                       |   10 ++-----
 gnome-help/Makefile.am                           |    2 +
 24 files changed, 67 insertions(+), 59 deletions(-)
 create mode 100644 gnome-help/C/bluetooth.page
 create mode 100644 gnome-help/C/disk.page

diff --git a/gnome-help/C/bluetooth-connect-device.page b/gnome-help/C/bluetooth-connect-device.page
index 59afeba..0e9eb36 100644
--- a/gnome-help/C/bluetooth-connect-device.page
+++ b/gnome-help/C/bluetooth-connect-device.page
@@ -3,7 +3,7 @@
       id="bluetooth-connect-device">
 
   <info>
-    <link type="guide" xref="hardware#bluetooth"/>
+    <link type="guide" xref="bluetooth"/>
     <desc>Pair Bluetooth devices.</desc>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
diff --git a/gnome-help/C/bluetooth-problem-connecting.page b/gnome-help/C/bluetooth-problem-connecting.page
index c43628e..0a8713e 100644
--- a/gnome-help/C/bluetooth-problem-connecting.page
+++ b/gnome-help/C/bluetooth-problem-connecting.page
@@ -4,7 +4,7 @@
 
   <info>
     <link type="guide" xref="hardware-problems-bluetooth"/>
-    <link type="guide" xref="hardware#bluetooth"/>
+    <link type="guide" xref="bluetooth"/>
     <link type="seealso" xref="hardware-driver"/>
     
     <desc>The adapter could be turned off or doesn't have drivers, or Bluetooth might be disabled or blocked.</desc>
diff --git a/gnome-help/C/bluetooth-remove-connection.page b/gnome-help/C/bluetooth-remove-connection.page
index 574de0f..8b189c4 100644
--- a/gnome-help/C/bluetooth-remove-connection.page
+++ b/gnome-help/C/bluetooth-remove-connection.page
@@ -3,7 +3,7 @@
       id="bluetooth-remove-connection">
 
   <info>
-    <link type="guide" xref="hardware#bluetooth"/>
+    <link type="guide" xref="bluetooth"/>
     <desc>Remove a device from the list of Bluetooth devices.</desc>
 
     <revision pkgversion="3.0" date="2011-04-03" status="final"/>
diff --git a/gnome-help/C/bluetooth-send-file.page b/gnome-help/C/bluetooth-send-file.page
index 278e6bb..3e45e16 100644
--- a/gnome-help/C/bluetooth-send-file.page
+++ b/gnome-help/C/bluetooth-send-file.page
@@ -3,7 +3,7 @@
       id="bluetooth-send-file">
 
   <info>
-    <link type="guide" xref="hardware#bluetooth"/>
+    <link type="guide" xref="bluetooth"/>
     <desc>Share files between Bluetooth-enabled devices, like your computer and your phone.</desc>
 
     <revision pkgversion="3.0" date="2011-04-03" status="final"/>
diff --git a/gnome-help/C/bluetooth-turn-on-off.page b/gnome-help/C/bluetooth-turn-on-off.page
index 869e758..2f2ab86 100644
--- a/gnome-help/C/bluetooth-turn-on-off.page
+++ b/gnome-help/C/bluetooth-turn-on-off.page
@@ -3,7 +3,7 @@
       id="bluetooth-turn-on-off">
 
   <info>
-    <link type="guide" xref="hardware#bluetooth"/>
+    <link type="guide" xref="bluetooth"/>
     <desc>Enable or disable the Bluetooth device on your computer.</desc>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
diff --git a/gnome-help/C/bluetooth.page b/gnome-help/C/bluetooth.page
new file mode 100644
index 0000000..fe4185d
--- /dev/null
+++ b/gnome-help/C/bluetooth.page
@@ -0,0 +1,22 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="bluetooth">
+
+  <info>
+    <link type="guide" xref="hardware"/>
+
+    <desc>
+      <link xref="bluetooth-connect-device">Pairing</link>,
+      <link xref="bluetooth-send-file">sending files</link>,
+      <link xref="bluetooth-problem-connecting">connection problems</link>...
+    </desc>
+
+    <revision pkgversion="3.0" version="3.0.1" date="2011-04-07" status="outdated"/>
+    <credit type="author">
+      <name>Shaun McCance</name>
+      <email>shaunm gnome org</email>
+    </credit>
+  </info>
+
+<title>Bluetooth</title>
+</page>
diff --git a/gnome-help/C/disk-benchmark.page b/gnome-help/C/disk-benchmark.page
index 922e77c..735f72a 100644
--- a/gnome-help/C/disk-benchmark.page
+++ b/gnome-help/C/disk-benchmark.page
@@ -2,7 +2,7 @@
       type="topic" style="task"
       id="disk-benchmark">
   <info>
-    <link type="guide" xref="hardware#disk"/>
+    <link type="guide" xref="disk"/>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
diff --git a/gnome-help/C/disk-capacity.page b/gnome-help/C/disk-capacity.page
index ec643cc..865204b 100644
--- a/gnome-help/C/disk-capacity.page
+++ b/gnome-help/C/disk-capacity.page
@@ -2,7 +2,7 @@
       type="topic" style="task"
       id="disk-capacity">
   <info>
-    <link type="guide" xref="hardware#disk"/>
+    <link type="guide" xref="disk"/>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
diff --git a/gnome-help/C/disk-check.page b/gnome-help/C/disk-check.page
index 2b36c39..92086af 100644
--- a/gnome-help/C/disk-check.page
+++ b/gnome-help/C/disk-check.page
@@ -2,7 +2,7 @@
       type="topic" style="task"
       id="disk-check">
   <info>
-    <link type="guide" xref="hardware#disk"/>
+    <link type="guide" xref="disk"/>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
diff --git a/gnome-help/C/disk-format.page b/gnome-help/C/disk-format.page
index aa0be0d..174b339 100644
--- a/gnome-help/C/disk-format.page
+++ b/gnome-help/C/disk-format.page
@@ -2,7 +2,7 @@
       type="topic" style="task"
       id="disk-format">
   <info>
-    <link type="guide" xref="hardware#disk"/>
+    <link type="guide" xref="disk"/>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
diff --git a/gnome-help/C/disk-partitions.page b/gnome-help/C/disk-partitions.page
index 0e9f10d..e231bd2 100644
--- a/gnome-help/C/disk-partitions.page
+++ b/gnome-help/C/disk-partitions.page
@@ -2,7 +2,7 @@
       type="topic"
       id="disk-partitions">
   <info>
-    <link type="guide" xref="hardware#disk"/>
+    <link type="guide" xref="disk"/>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
diff --git a/gnome-help/C/disk.page b/gnome-help/C/disk.page
new file mode 100644
index 0000000..e13391b
--- /dev/null
+++ b/gnome-help/C/disk.page
@@ -0,0 +1,23 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="disk">
+
+  <info>
+    <link type="guide" xref="hardware"/>
+
+    <title type="link" role="trail">Disks</title>    
+    <desc>
+      <link xref="disk-capacity">Free space</link>,
+      <link xref="disk-check">disk health</link>,
+      <link xref="disk-format">formatting</link>...
+    </desc>
+
+    <revision pkgversion="3.0" version="3.0.1" date="2011-04-07" status="outdated"/>
+    <credit type="author">
+      <name>Shaun McCance</name>
+      <email>shaunm gnome org</email>
+    </credit>
+  </info>
+
+<title>Disks &amp; storage</title>
+</page>
diff --git a/gnome-help/C/hardware.page b/gnome-help/C/hardware.page
index c49bdba..ed12a5b 100644
--- a/gnome-help/C/hardware.page
+++ b/gnome-help/C/hardware.page
@@ -27,13 +27,8 @@
 
 <title>Hardware &amp; drivers</title>
 
-<links type="topic" style="linklist" groups="driver">
-  <title>Drivers</title>
-</links>
-
-<links type="topic" style="linklist">
-  <title>Other topic groups</title>
-</links>
+<links type="topic" style="toronto"/>
+<links type="topic" style="linklist" groups="driver"/>
 
 <section id="problems" style="2column">
   <info>
@@ -42,10 +37,6 @@
  <title>Troubleshooting hardware problems</title>
 </section>
 
-<section id="printing" style="2column">
- <title>Printing</title>
-</section>
-
 <!--
 <section id="scanning" style="2column">
  <title>Scanning</title>
@@ -56,22 +47,6 @@
 </section>
 -->
 
-<section id="power" style="2column">
-  <info>
-    <title type="link" role="trail">Power</title>
-  </info>
-  <title>Power and batteries</title>
-</section>
-
-<section id="bluetooth" style="2column">
- <title>Bluetooth</title>
-</section>
-
-<section id="disk" style="2column">
- <info><title type="text">Disks</title></info>
- <title>Hard disks and other storage devices</title>
-</section>
-
 <section id="auth" style="2column">
  <title>Smart cards and fingerprint readers</title>
 </section>
diff --git a/gnome-help/C/power-batterybroken.page b/gnome-help/C/power-batterybroken.page
index 07f975a..b608983 100644
--- a/gnome-help/C/power-batterybroken.page
+++ b/gnome-help/C/power-batterybroken.page
@@ -5,7 +5,6 @@
 
   <info>
     <link type="guide" xref="power#battery"/>
-    <link type="guide" xref="hardware#power"/>
     <link type="seealso" xref="power-batteryoptimal"/>
     
     <desc>Your battery is probably not broken; it's more likely that it's just old.</desc>
diff --git a/gnome-help/C/power-closelid.page b/gnome-help/C/power-closelid.page
index 8e4e74d..d80b62a 100644
--- a/gnome-help/C/power-closelid.page
+++ b/gnome-help/C/power-closelid.page
@@ -4,7 +4,6 @@
 
   <info>
     <link type="guide" xref="power#problems"/>
-    <link type="guide" xref="hardware#power"/>
     <link type="seealso" xref="power-suspendfail"/>
     
     <desc>Laptops go to sleep when you close the lid, in order to save power.</desc>
diff --git a/gnome-help/C/power-suspendfail.page b/gnome-help/C/power-suspendfail.page
index c8c287d..2089ea1 100644
--- a/gnome-help/C/power-suspendfail.page
+++ b/gnome-help/C/power-suspendfail.page
@@ -4,7 +4,6 @@
 
   <info>
     <link type="guide" xref="power#problems"/>
-    <link type="guide" xref="hardware#power"/>
     <link type="guide" xref="hardware-problems-graphics"/>
     
     <desc>Some computer hardware causes problems with suspend/hibernate.</desc>
diff --git a/gnome-help/C/power-suspendhibernate.page b/gnome-help/C/power-suspendhibernate.page
index b2cd183..2d34720 100644
--- a/gnome-help/C/power-suspendhibernate.page
+++ b/gnome-help/C/power-suspendhibernate.page
@@ -4,7 +4,6 @@
 
   <info>
     <link type="guide" xref="power#problems"/>
-    <link type="guide" xref="hardware#power"/>
     
     <desc>Suspend sends it to sleep; hibernate saves your files but completely switches off the power.</desc>
     
diff --git a/gnome-help/C/power-turnoffbutton.page b/gnome-help/C/power-turnoffbutton.page
index c2d12c8..3d8d75d 100644
--- a/gnome-help/C/power-turnoffbutton.page
+++ b/gnome-help/C/power-turnoffbutton.page
@@ -3,7 +3,7 @@
       id="power-turnoffbutton">
 
   <info>
-    <link type="guide" xref="hardware#power"/>
+    <link type="guide" xref="power"/>
     <desc>Look in <guiseq><gui>System Settings</gui><gui>Power</gui></guiseq> for the option to change this.</desc>
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
diff --git a/gnome-help/C/power.page b/gnome-help/C/power.page
index 3ed357b..7602658 100644
--- a/gnome-help/C/power.page
+++ b/gnome-help/C/power.page
@@ -3,7 +3,7 @@
       id="power">
 <info>
     <link type="guide" xref="prefs"/>
-    <link type="guide" xref="hardware#power" />
+    <link type="guide" xref="hardware"/>
     
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
@@ -13,7 +13,8 @@
       <email>nruz alumnos inf utfsm cl</email>
     </credit>
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
-    
+
+    <title type="link" role="trail">Power</title>
     <desc>
       <link xref="power-suspendhibernate">Suspend</link>,
       <link xref="power-batterylife">energy savings</link>,
@@ -22,11 +23,7 @@
     
 </info>
 
-<title>Power settings</title>
-
-<section id="battery" style="2column">
-    <title>Battery settings</title>
-</section>
+<title>Power &amp; batteries</title>
 
 <section id="problems" style="2column">
     <title>Problems</title>
diff --git a/gnome-help/C/printing-paperjam.page b/gnome-help/C/printing-paperjam.page
index a3c363e..61a9474 100644
--- a/gnome-help/C/printing-paperjam.page
+++ b/gnome-help/C/printing-paperjam.page
@@ -3,7 +3,6 @@
       id="printing-paperjam">
 
   <info>
-    <link type="guide" xref="hardware#printing"/>
     <link type="guide" xref="printing#problems"/>
 
     <desc>How you clear a paper jam will depend on the make and model of printer that you have.</desc>
diff --git a/gnome-help/C/printing-setup-default-printer.page b/gnome-help/C/printing-setup-default-printer.page
index 7014484..86f7f4b 100644
--- a/gnome-help/C/printing-setup-default-printer.page
+++ b/gnome-help/C/printing-setup-default-printer.page
@@ -3,7 +3,6 @@
       id="printing-setup-default-printer">
 
   <info>
-    <link type="guide" xref="hardware#printing" />
     <link type="guide" xref="printing#setup" />
 
     <desc>Pick the printer that you use most often.</desc>
diff --git a/gnome-help/C/printing-setup.page b/gnome-help/C/printing-setup.page
index e607685..d90696f 100644
--- a/gnome-help/C/printing-setup.page
+++ b/gnome-help/C/printing-setup.page
@@ -3,7 +3,6 @@
       id="printing-setup">
 
   <info>
-    <link type="guide" xref="hardware#printing" />
     <link type="guide" xref="printing#setup" group="#first" />
 
     <desc>Set up a printer that is connected to your computer.</desc>
diff --git a/gnome-help/C/printing.page b/gnome-help/C/printing.page
index 4b7255a..9961844 100644
--- a/gnome-help/C/printing.page
+++ b/gnome-help/C/printing.page
@@ -3,9 +3,9 @@
       id="printing">
 
   <info>
-    <link type="guide" xref="hardware#printing" group="#first" />
+    <link type="guide" xref="hardware"/>
     
-    <desc>Learn about printing and using the more advanced features of your printer.</desc>
+    <desc>xxx</desc>
 
     <revision pkgversion="3.0" date="2011-04-04" status="final"/>
     <revision pkgversion="3.0" version="3.0.1" date="2011-04-06" status="outdated"/>
@@ -19,7 +19,7 @@
     </license>
   </info>
 
-<title>Printing</title>
+<title>Printers</title>
 
 <section id="setup" style="2column">
   <info>
@@ -36,10 +36,6 @@
 </section>
 
 <section id="problems" style="2column">
- <info>
-  <link type="guide" xref="hardware#problems"/>
-  <desc>Undetected printers, paper jams, print-outs that look wrong...</desc>
- </info>
  <title>Printer problems</title>
 </section>
 
diff --git a/gnome-help/Makefile.am b/gnome-help/Makefile.am
index 3f31bc0..15f1d6a 100644
--- a/gnome-help/Makefile.am
+++ b/gnome-help/Makefile.am
@@ -51,6 +51,7 @@ DOC_PAGES = \
 	backup-what.page \
 	backup-where.page \
 	backup-why.page \
+	bluetooth.page \
 	bluetooth-connect-device.page \
 	bluetooth-problem-connecting.page \
 	bluetooth-remove-connection.page \
@@ -60,6 +61,7 @@ DOC_PAGES = \
 	clock-calendar.page \
 	clock-set.page \
 	clock-timezone.page \
+	disk.page \
 	disk-benchmark.page \
 	disk-capacity.page \
 	disk-check.page \
-- 
1.7.3.2
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]