[gnome-user-docs] Adding shorter titles for link trails
- From: Shaun McCance <shaunm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-user-docs] Adding shorter titles for link trails
- Date: Wed, 17 Feb 2021 16:29:07 +0000 (UTC)
commit 55afcd3db72764c4b7750cfa9f5511f176b45fcd
Author: Shaun McCance <shaunm redhat com>
Date: Sun Feb 7 20:04:57 2021 -0500
Adding shorter titles for link trails
gnome-help/C/.yelp-tools.cfg | 7 +++++++
gnome-help/C/a11y.page | 9 ++-------
gnome-help/C/accounts.page | 1 +
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/color.page | 3 ++-
gnome-help/C/disk.page | 3 ++-
gnome-help/C/files-search.page | 5 +++--
gnome-help/C/files.page | 9 ++-------
gnome-help/C/hardware-phone.page | 7 +++----
gnome-help/C/hardware.page | 4 ++--
gnome-help/C/media.page | 3 ++-
gnome-help/C/more-help.page | 8 +++-----
gnome-help/C/mouse.page | 1 +
gnome-help/C/nautilus-prefs.page | 1 +
gnome-help/C/net-email.page | 1 +
gnome-help/C/net-findip.page | 4 ++--
gnome-help/C/net-general.page | 1 +
gnome-help/C/net-security-tips.page | 2 +-
gnome-help/C/net-security.page | 1 +
gnome-help/C/net.page | 10 +++-------
gnome-help/C/power.page | 8 ++------
gnome-help/C/prefs-display.page | 8 ++------
gnome-help/C/printing-2sided.page | 2 +-
gnome-help/C/printing-differentsize.page | 2 +-
gnome-help/C/printing-order.page | 2 +-
gnome-help/C/printing-select.page | 2 +-
gnome-help/C/runchecks.sh | 19 +++++++++++++++++++
gnome-help/C/screen-shot-record.page | 2 +-
gnome-help/C/shell-windows.page | 1 +
gnome-help/C/tips.page | 5 +++--
gnome-help/C/wacom.page | 1 +
35 files changed, 78 insertions(+), 64 deletions(-)
---
diff --git a/gnome-help/C/.yelp-tools.cfg b/gnome-help/C/.yelp-tools.cfg
index f6ea1c8b..0d6d5e80 100644
--- a/gnome-help/C/.yelp-tools.cfg
+++ b/gnome-help/C/.yelp-tools.cfg
@@ -40,6 +40,13 @@ select = /mal:page/mal:info/mal:desc
assert = not(mal:link)
message = Stop putting links in desc elements
+[check:gnome-trail-title]
+skip = hardware-auth.page
+desc = Use a short title for link trails
+select = /mal:page[@type='guide']
+assert = string-length(mal:title) <= 20 or (mal:info/mal:title[@type='link' and @role='trail'] and
string-length(mal:info/mal:title[@type='link' and @role='trail']) <= 20)
+message = Use a short title for link trails
+
[check:gnome-no-ascii-quotes]
select = //mal:*[not(ancestor-or-self::mal:cmd or ancestor-or-self::mal:code or
ancestor-or-self::mal:comment or ancestor-or-self::mal:file or ancestor-or-self::mal:input or
ancestor-or-self::mal:key or ancestor-or-self::mal:output or ancestor-or-self::mal:screen or
ancestor-or-self::mal:screen or ancestor-or-self::mal:sys)]
assert = not(contains(text(), "'") or contains(text(), '"'))
diff --git a/gnome-help/C/a11y.page b/gnome-help/C/a11y.page
index 5792f98b..b88749cf 100644
--- a/gnome-help/C/a11y.page
+++ b/gnome-help/C/a11y.page
@@ -22,13 +22,8 @@
<email>kittykat3756 gmail com</email>
</credit>
- <desc>
- <link xref="a11y#vision">Seeing</link>,
- <link xref="a11y#sound">hearing</link>,
- <link xref="a11y#mobility">mobility</link>,
- <link xref="a11y-braille">braille</link>,
- <link xref="a11y-mag">screen magnifier</link>…
- </desc>
+ <desc>Use assistive technologies to help with special needs for
+ vision, hearing, and mobility.</desc>
</info>
<title>Accessibility</title>
diff --git a/gnome-help/C/accounts.page b/gnome-help/C/accounts.page
index a80e0f09..b319b7c3 100644
--- a/gnome-help/C/accounts.page
+++ b/gnome-help/C/accounts.page
@@ -16,6 +16,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Accounts</title>
<desc>
<link xref="accounts-add">Add an online account</link>,
<link xref="accounts-remove">Remove an account</link>,
diff --git a/gnome-help/C/bluetooth-connect-device.page b/gnome-help/C/bluetooth-connect-device.page
index fa910545..846609a8 100644
--- a/gnome-help/C/bluetooth-connect-device.page
+++ b/gnome-help/C/bluetooth-connect-device.page
@@ -1,7 +1,7 @@
<page xmlns="http://projectmallard.org/1.0/";
xmlns:its="http://www.w3.org/2005/11/its";
xmlns:if="http://projectmallard.org/if/1.0/";
- type="guide" style="task" version="1.0 if/1.0"
+ type="topic" style="task" version="1.0 if/1.0"
id="bluetooth-connect-device">
<info>
diff --git a/gnome-help/C/bluetooth-problem-connecting.page b/gnome-help/C/bluetooth-problem-connecting.page
index 96fd5b22..ff5e6941 100644
--- a/gnome-help/C/bluetooth-problem-connecting.page
+++ b/gnome-help/C/bluetooth-problem-connecting.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/";
xmlns:its="http://www.w3.org/2005/11/its";
- type="guide" style="problem"
+ type="topic" style="problem"
id="bluetooth-problem-connecting">
<info>
diff --git a/gnome-help/C/bluetooth-remove-connection.page b/gnome-help/C/bluetooth-remove-connection.page
index 6144e4bb..7edaa069 100644
--- a/gnome-help/C/bluetooth-remove-connection.page
+++ b/gnome-help/C/bluetooth-remove-connection.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/";
xmlns:its="http://www.w3.org/2005/11/its";
- type="guide" style="task"
+ type="topic" style="task"
id="bluetooth-remove-connection">
<info>
diff --git a/gnome-help/C/bluetooth-send-file.page b/gnome-help/C/bluetooth-send-file.page
index 9977aadd..778f9253 100644
--- a/gnome-help/C/bluetooth-send-file.page
+++ b/gnome-help/C/bluetooth-send-file.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/";
xmlns:its="http://www.w3.org/2005/11/its";
- type="guide" style="task"
+ type="topic" style="task"
id="bluetooth-send-file">
<info>
diff --git a/gnome-help/C/bluetooth-turn-on-off.page b/gnome-help/C/bluetooth-turn-on-off.page
index 4a9ab815..ab7a402e 100644
--- a/gnome-help/C/bluetooth-turn-on-off.page
+++ b/gnome-help/C/bluetooth-turn-on-off.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/";
xmlns:its="http://www.w3.org/2005/11/its";
- type="guide" style="task"
+ type="topic" style="task"
id="bluetooth-turn-on-off">
<info>
diff --git a/gnome-help/C/color.page b/gnome-help/C/color.page
index 3401a579..842cb2c0 100644
--- a/gnome-help/C/color.page
+++ b/gnome-help/C/color.page
@@ -11,6 +11,7 @@
</credit>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+ <title type="link" role="trail">Color</title>
<desc>
<link xref="color-whyimportant">Why is this important</link>,
<link xref="color#profiles">Color profiles</link>,
@@ -33,4 +34,4 @@
<title>Problems</title>
</section>
-</page>
\ No newline at end of file
+</page>
diff --git a/gnome-help/C/disk.page b/gnome-help/C/disk.page
index bf302363..d170b5a6 100644
--- a/gnome-help/C/disk.page
+++ b/gnome-help/C/disk.page
@@ -12,6 +12,7 @@
<revision pkgversion="3.4.0" date="2012-02-19" status="review"/>
+ <title type="link" role="trail">Disks</title>
<desc>
<link xref="disk-capacity">Disk space</link>,
<link xref="disk-benchmark">performance</link>,
@@ -24,4 +25,4 @@
<title>Disks & storage</title>
-</page>
\ No newline at end of file
+</page>
diff --git a/gnome-help/C/files-search.page b/gnome-help/C/files-search.page
index 1a47e1c8..09e71a7d 100644
--- a/gnome-help/C/files-search.page
+++ b/gnome-help/C/files-search.page
@@ -36,6 +36,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Search</title>
<desc>Locate files based on file name and type.</desc>
</info>
@@ -75,9 +76,9 @@
</item>
<item>
<p>You can narrow your results by date, by file type, and by whether to
- search a file's full text, or to only search for file names.</p>
+ search a file’s full text, or to only search for file names.</p>
<p>To apply filters, select the drop-down menu button to the left of the
- file manager's <media its:translate="no" type="image" mime="image/svg"
+ file manager’s <media its:translate="no" type="image" mime="image/svg"
src="figures/edit-find-symbolic.svg"> <key>Search</key> key symbol</media>
icon, and choose from the available filters:</p>
<list>
diff --git a/gnome-help/C/files.page b/gnome-help/C/files.page
index 0788dd8d..f011c700 100644
--- a/gnome-help/C/files.page
+++ b/gnome-help/C/files.page
@@ -26,13 +26,8 @@
<title type="link" role="trail">Files</title>
- <desc>
- <link xref="files-search">Searching</link>,
- <link xref="files-delete">delete files</link>,
- <link xref="files#backup">backups</link>,
- <link xref="files#removable">removable drives</link>…
- </desc>
- <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <desc>Find and manage your files, whether on your computer, on the
+ internet, or in backups.</desc>
</info>
<title>Files, folders & search</title>
diff --git a/gnome-help/C/hardware-phone.page b/gnome-help/C/hardware-phone.page
index c80c5dfb..2c2e370b 100644
--- a/gnome-help/C/hardware-phone.page
+++ b/gnome-help/C/hardware-phone.page
@@ -13,10 +13,9 @@
<years>2019</years>
</credit>
- <desc><link xref="net-tethering">Tether your phone to your computer</link>,
- <link xref="net-mobile">connect to mobile broadband</link>,
- <link xref="bluetooth-connect-device">connect via Bluetooth</link>…</desc>
- <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Phone</title>
+ <desc>Connect your phone to your computer and use a mobile
+ broadband connection.</desc>
</info>
<title>Connect a cell phone to your computer</title>
diff --git a/gnome-help/C/hardware.page b/gnome-help/C/hardware.page
index 95be082a..79dbc055 100644
--- a/gnome-help/C/hardware.page
+++ b/gnome-help/C/hardware.page
@@ -25,7 +25,7 @@
<title>Hardware & drivers</title>
-<links type="topic" style="toronto"/>
+<links type="topic" style="linklist"/>
<links type="topic" style="linklist" groups="more">
<title>More topics</title>
@@ -40,4 +40,4 @@
<links type="topic" style="linklist"/>
</section>
-</page>
\ No newline at end of file
+</page>
diff --git a/gnome-help/C/media.page b/gnome-help/C/media.page
index deb848c5..13997e1b 100644
--- a/gnome-help/C/media.page
+++ b/gnome-help/C/media.page
@@ -10,6 +10,7 @@
<email>shaunm gnome org</email>
</credit>
+ <title type="link" role="trail">Media</title>
<desc>
<link xref="media#photos">Digital cameras</link>,
<link xref="media#music">iPods</link>,
@@ -51,4 +52,4 @@
<title>Videos and video cameras</title>
</section>
-</page>
\ No newline at end of file
+</page>
diff --git a/gnome-help/C/more-help.page b/gnome-help/C/more-help.page
index c3d339f1..4f05ba56 100644
--- a/gnome-help/C/more-help.page
+++ b/gnome-help/C/more-help.page
@@ -15,11 +15,9 @@
<email>jwcampbell gmail com</email>
</credit>
- <desc>
- <link xref="about-this-guide">Tips on using this guide</link>,
- <link xref="get-involved">help improve this guide</link>,
- <link xref="help-mailing-list">mailing list</link>,
- <link xref="help-irc">IRC</link>…</desc>
+ <desc>Get tips on using this guide, and connect with the
+ community for more help.</desc>
+
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
</info>
diff --git a/gnome-help/C/mouse.page b/gnome-help/C/mouse.page
index 1290474b..3f8279a1 100644
--- a/gnome-help/C/mouse.page
+++ b/gnome-help/C/mouse.page
@@ -26,6 +26,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Mouse</title>
<desc>
<link xref="mouse-lefthanded">Left-handed</link>,
<link xref="mouse-sensitivity">speed and sensitivity</link>,
diff --git a/gnome-help/C/nautilus-prefs.page b/gnome-help/C/nautilus-prefs.page
index 75db2a37..9cbee685 100644
--- a/gnome-help/C/nautilus-prefs.page
+++ b/gnome-help/C/nautilus-prefs.page
@@ -8,6 +8,7 @@
<name>Shaun McCance</name>
<email>shaunm gnome org</email>
</credit>
+ <title type="link" role="trail">Preferences</title>
<desc>View and set preferences for the file browser.</desc>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
</info>
diff --git a/gnome-help/C/net-email.page b/gnome-help/C/net-email.page
index ccc5f137..f3293eec 100644
--- a/gnome-help/C/net-email.page
+++ b/gnome-help/C/net-email.page
@@ -22,6 +22,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Email</title>
<desc>
<link xref="net-default-email">Default email apps</link>,
<link xref="net-email-virus">Should I scan for viruses?</link>…
diff --git a/gnome-help/C/net-findip.page b/gnome-help/C/net-findip.page
index ce292278..8cb474fd 100644
--- a/gnome-help/C/net-findip.page
+++ b/gnome-help/C/net-findip.page
@@ -46,7 +46,7 @@
IP address for your computer on the internet.</p>
<steps>
- <title>Find your wired connection's internal (network) IP address</title>
+ <title>Find your wired connection’s internal (network) IP address</title>
<item>
<p>Open the <gui xref="shell-introduction#activities">Activities</gui> overview and
start typing <gui>Settings</gui>.</p>
@@ -75,7 +75,7 @@
</note>
<steps>
- <title>Find your wireless connection's internal (network) IP address</title>
+ <title>Find your wireless connection’s internal (network) IP address</title>
<item>
<p>Open the <gui xref="shell-introduction#activities">Activities</gui> overview and
start typing <gui>Settings</gui>.</p>
diff --git a/gnome-help/C/net-general.page b/gnome-help/C/net-general.page
index 1509fe3c..7ca1a264 100644
--- a/gnome-help/C/net-general.page
+++ b/gnome-help/C/net-general.page
@@ -18,6 +18,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Tips</title>
<desc>
<link xref="net-findip">Find your IP address</link>,
<link xref="net-wireless-wepwpa">WEP & WPA security</link>,
diff --git a/gnome-help/C/net-security-tips.page b/gnome-help/C/net-security-tips.page
index d06f7ba5..f822adb8 100644
--- a/gnome-help/C/net-security-tips.page
+++ b/gnome-help/C/net-security-tips.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/";
xmlns:its="http://www.w3.org/2005/11/its";
- type="guide" style="task"
+ type="topic" style="task"
id="net-security-tips">
<info>
diff --git a/gnome-help/C/net-security.page b/gnome-help/C/net-security.page
index ab44a5e2..107e9a84 100644
--- a/gnome-help/C/net-security.page
+++ b/gnome-help/C/net-security.page
@@ -14,6 +14,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Security</title>
<desc>
<link xref="net-antivirus">Antivirus software</link>,
<link xref="net-firewall-on-off">basic firewalls</link>,
diff --git a/gnome-help/C/net.page b/gnome-help/C/net.page
index 2f356606..017c047a 100644
--- a/gnome-help/C/net.page
+++ b/gnome-help/C/net.page
@@ -17,13 +17,9 @@
<years>2015</years>
</credit>
- <desc>
- <link xref="net-wireless">Wireless</link>,
- <link xref="net-wired">wired</link>,
- <link xref="net-problem">connection problems</link>,
- <link xref="net-browser">web browsing</link>,
- <link xref="net-email">email accounts</link>…
- </desc>
+ <title type="link" role="trail">Networking</title>
+ <desc>Connect to wireless and wired networks. Stay safe with a VPN.
+ Create a wireless hotspot.</desc>
<!--
chat…
-->
diff --git a/gnome-help/C/power.page b/gnome-help/C/power.page
index 428876f4..a0a0b924 100644
--- a/gnome-help/C/power.page
+++ b/gnome-help/C/power.page
@@ -20,12 +20,8 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
- <desc>
- <link xref="power-status">Battery status</link>,
- <link xref="power-suspend">suspend</link>,
- <link xref="power-whydim">screen dimming</link>…
- </desc>
-
+ <title type="link" role="trail">Power</title>
+ <desc>View your battery status and change power saving settings.</desc>
</info>
<title>Power & battery</title>
diff --git a/gnome-help/C/prefs-display.page b/gnome-help/C/prefs-display.page
index 4de4a491..653c0e8b 100644
--- a/gnome-help/C/prefs-display.page
+++ b/gnome-help/C/prefs-display.page
@@ -14,12 +14,8 @@
<email>mdhillca gmail com</email>
</credit>
- <desc>
- <link xref="look-background">Background</link>,
- <link xref="look-resolution">size and orientation</link>,
- <link xref="display-brightness">brightness</link>,
- <link xref="display-night-light">color temperature</link>…
- </desc>
+ <desc>Set your background, configure monitors, and manage
+ color temperatures.</desc>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
</info>
diff --git a/gnome-help/C/printing-2sided.page b/gnome-help/C/printing-2sided.page
index 00e83457..ed422122 100644
--- a/gnome-help/C/printing-2sided.page
+++ b/gnome-help/C/printing-2sided.page
@@ -1,5 +1,5 @@
<page xmlns="http://projectmallard.org/1.0/";
- type="guide" style="task"
+ type="topic" style="task"
id="printing-2sided">
<info>
diff --git a/gnome-help/C/printing-differentsize.page b/gnome-help/C/printing-differentsize.page
index 4ccac601..b99cb977 100644
--- a/gnome-help/C/printing-differentsize.page
+++ b/gnome-help/C/printing-differentsize.page
@@ -1,5 +1,5 @@
<page xmlns="http://projectmallard.org/1.0/";
- type="guide" style="task"
+ type="topic" style="task"
id="printing-differentsize">
<info>
diff --git a/gnome-help/C/printing-order.page b/gnome-help/C/printing-order.page
index cd963e36..9e97304f 100644
--- a/gnome-help/C/printing-order.page
+++ b/gnome-help/C/printing-order.page
@@ -1,5 +1,5 @@
<page xmlns="http://projectmallard.org/1.0/";
- type="guide" style="task"
+ type="topic" style="task"
id="printing-order">
<info>
diff --git a/gnome-help/C/printing-select.page b/gnome-help/C/printing-select.page
index b8d0641f..edf6e2ed 100644
--- a/gnome-help/C/printing-select.page
+++ b/gnome-help/C/printing-select.page
@@ -1,5 +1,5 @@
<page xmlns="http://projectmallard.org/1.0/";
- type="guide" style="task"
+ type="topic" style="task"
id="printing-select">
<info>
diff --git a/gnome-help/C/runchecks.sh b/gnome-help/C/runchecks.sh
new file mode 100755
index 00000000..ae28ac2b
--- /dev/null
+++ b/gnome-help/C/runchecks.sh
@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# FIXME
+# Make yelp-check able to do compound commands, like this:
+#
+# [check:gnome-all]
+# commands = ids links media orphans validate gnome-desc gnome-desc-punc ...
+#
+# Then delete this file.
+
+yelp-check ids
+yelp-check links
+yelp-check media
+yelp-check orphans
+yelp-check validate
+
+for check in $(yelp-check | grep -o ' gnome-[^ ]*'); do
+ yelp-check $check;
+done
diff --git a/gnome-help/C/screen-shot-record.page b/gnome-help/C/screen-shot-record.page
index 282fc21d..31eb5df7 100644
--- a/gnome-help/C/screen-shot-record.page
+++ b/gnome-help/C/screen-shot-record.page
@@ -1,5 +1,5 @@
<page xmlns="http://projectmallard.org/1.0/";
- type="guide" style="task"
+ type="topic" style="task"
id="screen-shot-record">
<info>
diff --git a/gnome-help/C/shell-windows.page b/gnome-help/C/shell-windows.page
index e6b58a33..df7c5dc9 100644
--- a/gnome-help/C/shell-windows.page
+++ b/gnome-help/C/shell-windows.page
@@ -15,6 +15,7 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+ <title type="link" role="trail">Windows</title>
<desc>Move and organize your windows.</desc>
</info>
diff --git a/gnome-help/C/tips.page b/gnome-help/C/tips.page
index d2a4f2d3..f8484838 100644
--- a/gnome-help/C/tips.page
+++ b/gnome-help/C/tips.page
@@ -9,9 +9,10 @@
<email>shaunm gnome org</email>
</credit>
- <desc><link xref="tips-specialchars">Special characters</link>, <link xref="mouse-middleclick">middle
click shortcuts</link>…</desc>
+ <desc>
+<link xref="tips-specialchars">Special characters</link>, <link xref="mouse-middleclick">middle click
shortcuts</link>…</desc>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
</info>
<title>Tips & tricks</title>
-</page>
\ No newline at end of file
+</page>
diff --git a/gnome-help/C/wacom.page b/gnome-help/C/wacom.page
index f4184902..04b0c0b5 100644
--- a/gnome-help/C/wacom.page
+++ b/gnome-help/C/wacom.page
@@ -4,6 +4,7 @@
id="wacom">
<info>
+ <title type="link" role="trail">Wacom</title>
<desc>
<link xref="wacom-multi-monitor">Map a monitor</link>,
<link xref="wacom-stylus">configure the stylus</link>,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
