GNOME.org
 

[gnome-devel-docs] update organisation of the essentials pages

commit 4f15ecc2d913924b98c046eb9afb983ece2417d3
Author: Allan Day <allanpday gmail com>
Date:   Tue Aug 19 19:49:32 2014 +0100

    update organisation of the essentials pages

 ...an-application.page => application-basics.page} |   22 ++++++---
 hig3/C/compatibility.page                          |    1 -
 hig3/C/design-principles.page                      |    1 -
 hig3/C/essentials.page                             |   53 +++++++++++++++++++-
 hig3/C/icons-and-artwork.page                      |    3 +-
 hig3/C/keyboard-input.page                         |    1 -
 hig3/C/pointer-and-touch-input.page                |    1 -
 hig3/C/typography.page                             |    1 -
 hig3/C/visual-layout.page                          |    1 -
 hig3/C/writing-style.page                          |    1 -
 10 files changed, 67 insertions(+), 18 deletions(-)
---
diff --git a/hig3/C/what-is-an-application.page b/hig3/C/application-basics.page
similarity index 77%
rename from hig3/C/what-is-an-application.page
rename to hig3/C/application-basics.page
index a819306..59ac778 100644
--- a/hig3/C/what-is-an-application.page
+++ b/hig3/C/application-basics.page
@@ -1,25 +1,24 @@
 <page xmlns="http://projectmallard.org/1.0/";
       type="topic"
-      id="what-is-an-application">
+      id="application-basics">
 
   <info>
-    <link type="guide" xref="essentials" group="what-is-an-application"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
     </credit>
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
-    <desc>Guidelines for system integration and basic behavior.</desc>    
+    <desc>Basic application characteristics.</desc>    
   </info>
 
-<title>What is an application?</title>
+<title>Application basics</title>
 
 <p>These Human Interface Guidelines are concerned with the creation of applications. An understanding of 
what an application is will help you to distribute your software more effectively, as well as ensure 
effective and consistent system integration.</p>
 
 <p>The application provides a model with which users can understand their software, both in terms of how it 
is distributed, installed and removed, but also how that software behaves when in use. Ensuring that your 
software behaves according to the application model will help to ensure that it conforms to user 
expectations, and is therefore predictable. It will also ensure coherent integration with system tools for 
installing and removing applications.</p>
 
-<section id="a-definition">
-<title>A definition</title>
+<section id="application-definition">
+<title>Application definition</title>
 
 <quote><p>An application is a distinct and independent piece of software that incorporates useful 
functionality, and which can be installed on a user's system.</p></quote>
 
@@ -29,7 +28,9 @@
 <item><p>Can be individually installed and removed from the system.</p></item>
 <item><p>Do not rely on other applications in order to run.</p></item>
 <item><p>Contain functionality of their own.</p></item>
+<item><p>Provide at least one <link xref="primary-windows">primary window</link>.</p></item>
 <item><p>Do not affect or interfere with the behavior of other applications.</p></item>
+<item><p>Have a unique name and <link xref="icons-and-artwork#application-icons">icon</link>.</p></item>
 </list>
 
 <p>At the heart of this definition is a model that allows the modular installation and use of software, in a 
way that avoids dependency issues between modules, and ensures simplicity of use.</p>
@@ -44,6 +45,13 @@ Applications are launched and switched to via their launchers...
 
 </section>
 
-<!-- A successful application does one thing, and does it well. -->
+<section id="application-names">
+<title>Naming your application</title>
+
+
+
+</section>
+
+<!-- Possible additional section on defining scope. "A successful application does one thing, and does it 
well." -->
 
 </page>
diff --git a/hig3/C/compatibility.page b/hig3/C/compatibility.page
index 01b9361..104b66e 100644
--- a/hig3/C/compatibility.page
+++ b/hig3/C/compatibility.page
@@ -3,7 +3,6 @@
       id="compatibility">
 
   <info>
-    <link type="guide" xref="essentials" group="compatibility"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
diff --git a/hig3/C/design-principles.page b/hig3/C/design-principles.page
index fe3c730..f6fac85 100644
--- a/hig3/C/design-principles.page
+++ b/hig3/C/design-principles.page
@@ -3,7 +3,6 @@
       id="design-principles">
 
   <info>
-    <link type="guide" xref="essentials" group="design-principles"/>
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
diff --git a/hig3/C/essentials.page b/hig3/C/essentials.page
index 8f2b337..abff473 100644
--- a/hig3/C/essentials.page
+++ b/hig3/C/essentials.page
@@ -12,8 +12,57 @@
 
 <title>Essentials</title>
 
-<p>This section covers essential themes.</p>
+<p>This section of the Human Interface Guidelines covers essential themes. It provides an initial starting 
point when designing an application, as well as common design guidelines that are necessary when using all 
the patterns and user interface elements found in later sections.</p>
 
-<links style="2column" type="topic" groups="design-principles compatibility visual-layout icons-and-artwork 
writing-style typography keyboard-input"/>
+<section id="getting-started">
+<title>Getting started</title>
 
+<table>
+<tr>
+<td><p><link xref="application-basics"><em style="strong">Application basics</em></link></p></td>
+<td><p>Basic application behavior and characteristics.</p></td>
+</tr>
+<tr>
+<td><p><link xref="compatibility"><em style="strong">Compatibility</em></link></p></td>
+<td><p>Using the HIG for cross-platform or GNOME 2 style applications.</p></td>
+</tr>
+<tr>
+<td><p><link xref="design-principles"><em style="strong">Design principles</em></link></p></td>
+<td><p>General design guidelines and advice.</p></td>
+</tr>
+</table>
+
+</section>
+
+<section id="common-guidelines">
+<title>Common guidelines</title>
+
+<table>
+<tr>
+<td><p><link xref="visual-layout"><em style="strong">Visual layout</em></link></p></td>
+<td><p>Arranging elements within user interfaces.</p></td>
+</tr>
+<tr>
+<td><p><link xref="writing-style"><em style="strong">Writing style</em></link></p></td>
+<td><p>Writing text for your user interface, including capitalization rules.</p></td>
+</tr>
+<tr>
+<td><p><link xref="icons-and-artwork"><em style="strong">Icons and artwork</em></link></p></td>
+<td><p>Guidelines on selecting and creating icons.</p></td>
+</tr>
+<tr>
+<td><p><link xref="typography"><em style="strong">Typography</em></link></p></td>
+<td><p>Advice on font sizes, weights and styles, as well as special characters.</p></td>
+</tr>
+<tr>
+<td><p><link xref="pointer-and-touch-input"><em style="strong">Pointer and touch input</em></link></p></td>
+<td><p>Mouse, touchpad and touchscreen interaction.</p></td>
+</tr>
+<tr>
+<td><p><link xref="keyboard-input"><em style="strong">Keyboard input</em></link></p></td>
+<td><p>Keyboard navigation, access and shortcut keys.</p></td>
+</tr>
+</table>
+
+</section>
 </page>
diff --git a/hig3/C/icons-and-artwork.page b/hig3/C/icons-and-artwork.page
index 3d0b3f0..80999a3 100644
--- a/hig3/C/icons-and-artwork.page
+++ b/hig3/C/icons-and-artwork.page
@@ -3,7 +3,6 @@
       id="icons-and-artwork">
 
   <info>
-    <link type="guide" xref="essentials" group="icons-and-artwork"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
@@ -73,7 +72,7 @@
 <section id="application-icons">
 <title>Application Icons</title>
 
-<p>Every application should have a unique and beautiful application icon. It is the face of the application, 
and the first visual element a user sees when browsing for new applications.</p>
+<p>Every application should have a unique and beautiful application icon. It is the face of the application, 
and the first visual element a user sees when browsing for new applications. The <link 
xref="application-basics">application basics page</link> includes details on what an application is, and when 
to provide an application icon.</p>
 
 <p>Because application icons are presented at larger sizes, legacy Tango styled 48x48px or SVG icons no 
longer suffice (lacking detail). It is essential your application has a 256x256px size. With the advent of 
high-DPI displays, a 512x512px variant is recommended.</p>
 
diff --git a/hig3/C/keyboard-input.page b/hig3/C/keyboard-input.page
index eacc135..31350c6 100644
--- a/hig3/C/keyboard-input.page
+++ b/hig3/C/keyboard-input.page
@@ -3,7 +3,6 @@
       id="keyboard-input">
 
   <info>
-    <link type="guide" xref="essentials" group="keyboard-input"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
diff --git a/hig3/C/pointer-and-touch-input.page b/hig3/C/pointer-and-touch-input.page
index cc769c5..1ef66d2 100644
--- a/hig3/C/pointer-and-touch-input.page
+++ b/hig3/C/pointer-and-touch-input.page
@@ -3,7 +3,6 @@
       id="pointer-and-touch-input">
 
   <info>
-    <link type="guide" xref="essentials" group="pointer-and-touch-input"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
diff --git a/hig3/C/typography.page b/hig3/C/typography.page
index 6c47bcd..b53dfc6 100644
--- a/hig3/C/typography.page
+++ b/hig3/C/typography.page
@@ -3,7 +3,6 @@
       id="typography">
 
   <info>
-    <link type="guide" xref="essentials" group="typography"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
diff --git a/hig3/C/visual-layout.page b/hig3/C/visual-layout.page
index ef6b2d7..6aaf058 100644
--- a/hig3/C/visual-layout.page
+++ b/hig3/C/visual-layout.page
@@ -3,7 +3,6 @@
       id="visual-layout">
 
   <info>
-    <link type="guide" xref="essentials" group="visual-layout"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
diff --git a/hig3/C/writing-style.page b/hig3/C/writing-style.page
index 3e75eff..963a68f 100644
--- a/hig3/C/writing-style.page
+++ b/hig3/C/writing-style.page
@@ -3,7 +3,6 @@
       id="writing-style">
 
   <info>
-    <link type="guide" xref="essentials" group="writing-style"/>   
     <credit type="author">
       <name>Allan Day</name>
       <email>aday gnome org</email>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]