[gnome-devel-docs] hig3: fix validation errors
- From: David King <davidk src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-devel-docs] hig3: fix validation errors
- Date: Wed, 13 Aug 2014 22:42:23 +0000 (UTC)
commit 7d78f86d4c50acca83dc56b1dc6d1a9b1ef0b775
Author: David King <amigadave amigadave com>
Date: Wed Aug 13 23:41:07 2014 +0100
hig3: fix validation errors
hig3/C/check-boxes.page | 4 ++--
hig3/C/grids.page | 2 +-
hig3/C/header-bar-menus.page | 2 +-
hig3/C/icons-and-artwork.page | 4 ++--
hig3/C/keyboard-input.page | 4 ++--
hig3/C/lists.page | 2 ++
hig3/C/menu-bars.page | 34 +++++++++++++++++++++++++++++++++-
hig3/C/notifications.page | 4 ++--
hig3/C/typography.page | 2 ++
hig3/C/ui-elements.page | 18 +++++++++---------
10 files changed, 56 insertions(+), 20 deletions(-)
---
diff --git a/hig3/C/check-boxes.page b/hig3/C/check-boxes.page
index 0932d7f..920c8c8 100644
--- a/hig3/C/check-boxes.page
+++ b/hig3/C/check-boxes.page
@@ -29,12 +29,12 @@
<item><p>Use <link xref="writing-style#capitalization">sentence capitalization</link> for check box labels,
for example <gui>Use custom font</gui>.</p></item>
<item><p>Label check boxes to clearly indicate the effects of both their checked and unchecked states, for
example, <gui>Show icons in menus</gui>. If the two states of a check box cannot be clearly communicated,
consider using two radio buttons instead so both states can be given labels.</p></item>
<item><p>Provide an <link xref="keyboard-input#access-keys">access key</link> in all check box labels that
allows the user to set or unset the check box directly from the keyboard.</p></item>
-<item><p>If the check box represents a setting in a multiple selection that is set for some objects in the
selection and unset for others, show the check box in its mixed state. When a check box is in its mixed
state:</p></item>
+<item><p>If the check box represents a setting in a multiple selection that is set for some objects in the
selection and unset for others, show the check box in its mixed state. When a check box is in its mixed
state:</p>
<list>
<item><p>Clicking the box once should check the box, applying that setting (when confirmed) to all the
selected objects.</p></item>
<item><p>Clicking the box a second time should uncheck the box, removing that setting (when confirmed) to
all the selected objects.</p></item>
<item><p>Clicking the box a third time should return the box to its mixed state, restoring each selected
object's original value for that setting (when confirmed).</p></item>
-</list>
+</list></item>
<item><p>Label a group of check boxes with a descriptive heading above or to the left of the
group.</p></item>
<item><p>Do not place more than about eight check boxes under the same group heading. If you need more than
eight, try to use blank space or heading labels to divide them into smaller groups. Otherwise, consider using
a check box list instead— but you probably also need to think about how to simplify your user
interface.</p></item>
<item><p>Try to align groups of check boxes vertically rather than horizontally, as this makes them easier
to scan visually. Use horizontal or rectangular alignments only if they greatly improve the layout of the
window.</p></item>
diff --git a/hig3/C/grids.page b/hig3/C/grids.page
index aba09d3..9aa3d91 100644
--- a/hig3/C/grids.page
+++ b/hig3/C/grids.page
@@ -29,7 +29,7 @@
</section>
<section id="general-guidelines">
-<p>General guidelines</p>
+<title>General guidelines</title>
<list>
<item><p>Wherever possible, each item of content should have a unique thumbnail.</p></item>
diff --git a/hig3/C/header-bar-menus.page b/hig3/C/header-bar-menus.page
index 8b3c208..bb34a4d 100644
--- a/hig3/C/header-bar-menus.page
+++ b/hig3/C/header-bar-menus.page
@@ -27,7 +27,7 @@
<p>Use a header bar menu to present additional actions or options for the current view. They are best used
when those actions or options are not used the majority of the time - if there is a set of actions which
deserve more prominence in the view, an <link xref="action-bar">action bar</link> might be a better
choice.</p>
-<p>Header bar menus are not a good choice for performing actions on selected content: when content hasn't
been selected, the menu will contain unhelpful insensitive menu items, when it has been selected, possible
actions will not be advertised. <link xref="selection-mode">Selection mode</link> or <link>popovers</link>
are a better choice for this situation.</p>
+<p>Header bar menus are not a good choice for performing actions on selected content: when content hasn't
been selected, the menu will contain unhelpful insensitive menu items, when it has been selected, possible
actions will not be advertised. <link xref="selection-mode">Selection mode</link> or <link
xref="popovers">popovers</link> are a better choice for this situation.</p>
</section>
diff --git a/hig3/C/icons-and-artwork.page b/hig3/C/icons-and-artwork.page
index 5b40525..288e8b1 100644
--- a/hig3/C/icons-and-artwork.page
+++ b/hig3/C/icons-and-artwork.page
@@ -26,11 +26,11 @@
<p>There are many situations when it is necessary to decide between using an icon and a text label,
particularly for buttons. Icons have the advantage of being smaller, and not requiring translation. At the
same time, the incorrect use of an icon can make your interface hard - or even impossible - to understand.</p>
<list>
-<item><p>Only use icons whose meaning is commonly recognized. If a commonly recognised icon is not
available, it might be better to use a text label instead.</p></item>
+<item><p>Only use icons whose meaning is commonly recognized. If a commonly recognised icon is not
available, it might be better to use a text label instead.</p>
<list>
<item><p>Convention establishes which icons will be recognised. If you are in doubt, stick to icons which
are frequently used in other applications.</p></item>
<item><p>Consider which icons will be meaningful in the specific context of your application - users of
specialist tools will often be familiar with domain-specific symbols.</p></item>
-</list>
+</list></item>
<item><p>Remember that some icons are only meaningful alongside other icons of the same type. For example, a
media icon for stop is simply a square, and may not be identified as a stop icon without other media controls
(like play, pause, or skip) being visible close by. Likewise, the icon to remove an item from a list is a
subtract symbol (ie. a single line), and will not be recognisable without a corresponding "plus" add
icon.</p></item>
</list>
diff --git a/hig3/C/keyboard-input.page b/hig3/C/keyboard-input.page
index b4dd7d3..842d855 100644
--- a/hig3/C/keyboard-input.page
+++ b/hig3/C/keyboard-input.page
@@ -40,13 +40,13 @@
<list>
<item><p>Give all labelled components an access key (underlined letter), with the exception of toolbar
controls which would use up too many access key combinations.</p></item>
-<item><p>Choose access keys so that they are easy to remember. Normally this means using the first letter of
the label. However, in complex windows, the choice can become more difficult. Here are some simple
rules:</p></item>
+<item><p>Choose access keys so that they are easy to remember. Normally this means using the first letter of
the label. However, in complex windows, the choice can become more difficult. Here are some simple rules:</p>
<list>
<item><p>Assign access keys to the most frequently-used controls first. If it's not clear which controls
will be the most frequently used, assign access keys from left to right, top to bottom (for Western
locales).</p></item>
<item><p>Use the first letter of the label, or of one of its other words if it has more than one. If another
letter provides a better association (e.g. "x" in Extra Large) however, consider using that letter
instead.</p></item>
<item><p>If the first letter is not available, choose an easy to remember consonant from the label, for
example, "p" in Replace.</p></item>
<item><p>If no such consonants are available, choose any available vowel from the label.</p></item>
-</list>
+</list></item>
<item><p>If duplication of access keys in a window is unavoidable, you should still refrain from duplicating
the access keys for any of these buttons that appear in the same window: OK, Cancel, Close, Apply or Help.
GTK+ handles duplicated access keys by cycling the focus between the controls with the same access
key.</p></item>
<item><p>It is better not to assign access keys to "thin" letters (such as lowercase i or l), or letters
with descenders (such as lowercase g or y) unless it is unavoidable. The underline does not show up very well
on those characters in some fonts.</p></item>
<item><p>Applications using a non-Roman writing system in conjunction with a standard keyboard can have
control labels prefixed with Roman characters as access keys.</p></item>
diff --git a/hig3/C/lists.page b/hig3/C/lists.page
index 332e3bd..d798ae3 100644
--- a/hig3/C/lists.page
+++ b/hig3/C/lists.page
@@ -77,6 +77,7 @@
<td><p>Example</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p>Natural</p></td>
<td><p>Down</p></td>
@@ -87,6 +88,7 @@
<td><p>Up</p></td>
<td><p>Reverse alphabetical, largest number first, most recent date first, unchecked items first</p></td>
</tr>
+</tbody>
</table>
diff --git a/hig3/C/menu-bars.page b/hig3/C/menu-bars.page
index 3effecc..639860a 100644
--- a/hig3/C/menu-bars.page
+++ b/hig3/C/menu-bars.page
@@ -51,6 +51,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>New</gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>N</key></keyseq></p></td>
@@ -63,6 +64,7 @@
<td><p><keyseq><key>Ctrl</key><key>O</key></keyseq></p></td>
<td><p>Opens an existing document in a new window. Present the user with a standard <gui>Open File</gui>
dialog from which they can choose an existing file. If the chosen file is already open in the application,
raise that window instead of opening a new one.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -78,6 +80,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Save</gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>S</key></keyseq></p></td>
@@ -114,6 +117,7 @@
<td><p>None</p></td>
<td><p>An alternative to the <gui>Save Version</gui> and <gui>Restore Version</gui> commands. Use this when
more utilities, such as a diff, are available.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -129,6 +133,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Page Setup</gui></p></td>
<td><p>None</p></td>
@@ -149,6 +154,7 @@
<td><p><keyseq><key>Ctrl</key><key>M</key></keyseq></p></td>
<td><p>Provides the user a means to attach or send the current document as an email or email attachment,
depending on its format. You may provide more than one <gui>Send</gui> item depending on which options are
available. If there are more than two such items, move them into a submenu. For example, if only <gui>Send by
Email</gui> and <gui>Send by Fax</gui> are available, leave them on the top-level menu If there is a third
option, such as <gui>Send by FTP</gui>, place all the options in a Send submenu.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -164,11 +170,13 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Properties…</gui></p></td>
<td><p><keyseq><key>Alt</key><key>Return</key></keyseq></p></td>
<td><p>Opens the document's <gui>Properties</gui> window. This may contain editable information, such as the
document author's name, or read-only information, such as the number of words in the document, or a
combination of both. The <keyseq><key>Alt</key><key>Return</key></keyseq> shortcut should not be provided
where <key>Return</key> is most frequently used to insert a new line.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -184,6 +192,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Close</gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>W</key></keyseq></p></td>
@@ -202,6 +211,7 @@
<td><p>Closes the application. If there are unsaved changes in any open documents, present the user with a
confirmation alert for each affected document, giving the option to save the changes, discard them, or
cancel. If there are no unsaved changes, close the application immediately without presenting any further
messages or dialogs.</p>
<p>In particular, non-document based applications, for example a game or a calculator, should save their
state and exit immediately. This state should be restored the next time the application is started.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -230,6 +240,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Undo <em>action</em></gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>Z</key></keyseq></p></td>
@@ -241,6 +252,7 @@
<td><p>Performs the next action in the undo history list, after the user has moved backwards through the
list with the <gui>Undo</gui> command. Move the user one step forwards again, restoring the document to the
state it was in after that action was originally performed.</p>
<p>Note: provide a separate <gui>Undo</gui> and <gui>Redo</gui> menu item even if your application only
supports one level of undo.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -256,6 +268,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Cut</gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>X</key></keyseq></p></td>
@@ -296,6 +309,7 @@
<td><p><keyseq><key>Shift</key><key>Ctrl</key><key>A</key></keyseq></p></td>
<td><p>Deselects all content in the current document. Only provide this item in situations when no other
method of undoing selection is possible or apparent to the user. For example, in complex graphics
applications where selection and deselection is not usually possible simply by using the cursor keys. Note:
Do not provide <gui>Deselect All</gui> in text entry fields, as
<keyseq><key>Shift</key><key>Ctrl</key><key>hex</key></keyseq> digit is used to enter unicode characters so
its shortcut will not work.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -311,6 +325,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Find…</gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>F</key></keyseq></p></td>
@@ -331,6 +346,7 @@
<td><p><keyseq><key>Ctrl</key><key>H</key></keyseq></p></td>
<td><p>Opens a window or dialog allowing the user to search for specific content in the current document,
and replace each occurrence with new content.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -359,6 +375,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Icons</gui></p></td>
<td><p>None</p></td>
@@ -373,7 +390,7 @@
<td><p><gui>Details</gui></p></td>
<td><p>None</p></td>
<td><p>Shows the contents of the selected container as single column of small icons, each with its name on
its right-hand side. Additional columns give extra information about the object each icon represents, for
example the size and modification date of files in a file manager. This is a radio button menu item.</p>
-<p>If your application has no need for both <p>List</p> and <p>Details</p> modes, use the List item for
whichever of the two modes you support.</p></td>
+<p>If your application has no need for both <gui>List</gui> and <gui>Details</gui> modes, use the List item
for whichever of the two modes you support.</p></td>
</tr>
<tr>
<td><p><gui>Sort By…</gui></p></td>
@@ -415,6 +432,7 @@
<td><p><keyseq><key>Ctrl</key><key>R</key></keyseq></p></td>
<td><p>Redraws the current view of the document, checking the data source for changes first. For example,
checks the web server for updates to the page before redrawing it. If your application requires both
<gui>Reload</gui> and <gui>Refresh</gui>, use <keyseq><key>Shift</key><key>Ctrl</key><key>R</key></keyseq> as
the shortcut for <gui>Reload</gui>.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -434,6 +452,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Page Break</gui></p></td>
<td><p>None</p></td>
@@ -484,6 +503,7 @@
<td><p>None</p></td>
<td><p>Inserts a link to an object stored in a different file, or on a remote system. The object is not
embedded in or saved with the document, only a link to it. Open a dialog in which the user can type or choose
the name of the object, for example a filename or a webpage URL. Show the link in the document in as
informative way as possible. For example, show a link to an image as a thumbnail of that image, unless the
user specifies otherwise.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -505,6 +525,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Style…</gui></p></td>
<td><p>None</p></td>
@@ -557,6 +578,7 @@
<td><p>None</p></td>
<td><p>Sets the properties of all or selected pages of the document. Open a dialog allowing the user to
choose paper size, orientation, columns, margins, or whatever other attributes are applicable.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -574,6 +596,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Add Bookmark</gui></p></td>
<td><p><keyseq><key>Ctrl</key><key>D</key></keyseq></p></td>
@@ -589,6 +612,7 @@
<td><p>None</p></td>
<td><p>The user's current list of bookmarks for the application.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -611,6 +635,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Back</gui></p></td>
<td><p><keyseq><key>Alt</key><key>Left</key></keyseq></p></td>
@@ -636,6 +661,7 @@
<td><p><keyseq><key>Ctrl</key><key>L</key></keyseq></p></td>
<td><p>Navigates to a user-specified URI. Open a dialog into which the user can type a suitable URI, or
select one from a list where applicable (for example, a file selection dialog for applications that can
handle file:// URIs).</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -651,6 +677,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Previous Page</gui></p></td>
<td><p><key>PageUp</key></p></td>
@@ -676,6 +703,7 @@
<td><p><keyseq><key>Ctrl</key><key>End</key></keyseq></p></td>
<td><p>Navigates to the last page in the document.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -701,6 +729,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Save All</gui></p></td>
<td><p>None</p></td>
@@ -716,6 +745,7 @@
<td><p>None</p></td>
<td><p>Each menu item raises the corresponding window to the top of the window stack.</p></td>
</tr>
+</tbody>
</table>
</section>
@@ -733,6 +763,7 @@
<td><p>Description</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p><gui>Contents</gui></p></td>
<td><p><key>F1</key></p></td>
@@ -743,6 +774,7 @@
<td><p>None</p></td>
<td><p>Opens the About dialog for the application. Use the standard dialog provided by the GNOME libraries,
which contains the name and version number of the application, a short description of the application's
functionality, author contact details, copyright message and a pointer to the licence under which the
application is made available.</p></td>
</tr>
+</tbody>
</table>
</section>
diff --git a/hig3/C/notifications.page b/hig3/C/notifications.page
index 9c204d2..02b6b67 100644
--- a/hig3/C/notifications.page
+++ b/hig3/C/notifications.page
@@ -17,12 +17,12 @@
<title>Notifications</title>
-<p>Notifications enable you to inform the users about events when they are not using your application. They
also provide the ability for users to quickly respond to those events, using notification actions..</p>
+<p>Notifications enable you to inform the users about events when they are not using your application. They
also provide the ability for users to quickly respond to those events, using notification actions.</p>
<section id="notification-elements">
<title>Notification elements</title>
-Notifications in GNOME 3 have a number of standard components:
+<p>Notifications in GNOME 3 have a number of standard components:</p>
<table>
<tr>
diff --git a/hig3/C/typography.page b/hig3/C/typography.page
index 6d10709..d132483 100644
--- a/hig3/C/typography.page
+++ b/hig3/C/typography.page
@@ -50,6 +50,7 @@
<td><p>Usage</p></td><td><p>Incorrect</p></td><td><p>Correct</p></td><td><p>Unicode to use</p></td>
</tr>
</thead>
+<tbody>
<tr>
<td><p>Quotation</p></td><td><p>"quote"</p></td><td><p>“quote”</p></td><td><p>U+201C LEFT DOUBLE QUOTATION
MARK, U+201D RIGHT DOUBLE QUOTATION MARK</p></td>
</tr>
@@ -71,6 +72,7 @@
<tr>
<td><p>Ranges</p></td><td><p>June-July 1967</p></td><td><p>June–July 1967</p></td><td><p>U+2013 EN
DASH</p></td>
</tr>
+</tbody>
</table>
</section>
diff --git a/hig3/C/ui-elements.page b/hig3/C/ui-elements.page
index 02fdd36..26b4b1d 100644
--- a/hig3/C/ui-elements.page
+++ b/hig3/C/ui-elements.page
@@ -21,30 +21,30 @@
<table>
<tr>
<td><p><link xref="buttons">Buttons</link></p></td>
-<td><media xref="buttons" type="image" mime="image/png" src="figures/buttons.png"/></td>
-<td><p><link xref="check-boxes">Check boxes</link></p></td><td><media xref="check-boxes" type="image"
mime="image/png" src="figures/check-boxes.png"/></td>
+<td><media type="image" mime="image/png" src="figures/buttons.png"/></td>
+<td><p><link xref="check-boxes">Check boxes</link></p></td><td><media type="image" mime="image/png"
src="figures/check-boxes.png"/></td>
</tr>
<tr>
<td><p><link xref="drop-down-lists">Drop down lists</link></p></td>
-<td><media xref="drop-down-lists" type="image" mime="image/png" src="figures/drop-down-list.png"/></td>
+<td><media type="image" mime="image/png" src="figures/drop-down-list.png"/></td>
<td><p><link xref="menus">Menus</link></p></td>
-<td><media xref="menus" type="image" mime="image/png" src="figures/menu.png"/></td>
+<td><media type="image" mime="image/png" src="figures/menu.png"/></td>
</tr>
<tr>
<td><p><link xref="popovers">Popovers</link></p></td>
-<td><media xref="menus" type="image" mime="image/png" src="figures/popover.png"/></td>
+<td><media type="image" mime="image/png" src="figures/popover.png"/></td>
<td><p><link xref="radio-buttons">Radio buttons</link></p></td>
-<td><media xref="menus" type="image" mime="image/png" src="figures/radio-buttons.png"/></td>
+<td><media type="image" mime="image/png" src="figures/radio-buttons.png"/></td>
</tr>
<tr>
<td><p><link xref="switches">Switches</link></p></td>
-<td><media xref="switches" type="image" mime="image/png" src="figures/switches.png"/></td>
+<td><media type="image" mime="image/png" src="figures/switches.png"/></td>
<td><p><link xref="tabs">Tabs</link></p></td>
-<td><media xref="tabs" type="image" mime="image/png" src="figures/tabs.png"/></td>
+<td><media type="image" mime="image/png" src="figures/tabs.png"/></td>
</tr>
<tr>
<td><p><link xref="text-fields">Text fields</link></p></td>
-<td><media xref="tabs" type="image" mime="image/png" src="figures/text-fields.png"/></td>
+<td><media type="image" mime="image/png" src="figures/text-fields.png"/></td>
<td><p><link xref="menu-bars">Menu bars</link></p></td>
</tr>
</table>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
