GNOME.org
 

[gnome-user-docs] Stylistic and validation changes

commit 7de62834f3d6157a49c54057fe108729d21ab20e
Author: Jana Svarova <jsvarova redhat com>
Date:   Mon Jun 10 09:54:50 2013 +0200

    Stylistic and validation changes

 system-admin-guide/C/gdm-restart.page      |   35 +++++++++----
 system-admin-guide/C/login-background.page |   24 +++++++--
 system-admin-guide/C/login-banner.page     |   72 ++++++++--------------------
 system-admin-guide/C/login-logo.page       |   29 ++++++-----
 4 files changed, 80 insertions(+), 80 deletions(-)
---
diff --git a/system-admin-guide/C/gdm-restart.page b/system-admin-guide/C/gdm-restart.page
index c82c73d..fa13167 100644
--- a/system-admin-guide/C/gdm-restart.page
+++ b/system-admin-guide/C/gdm-restart.page
@@ -4,7 +4,7 @@
       id="gdm-restart">
 
   <info>
-    <link type="guide" xref="index" group="login" />
+    <links type="guide" xref="index" group="login" />
     <revision pkgversion="3.8" version="0.1" date="2013-06-05" status="draft"/>
 
     <credit type="author">
@@ -18,21 +18,34 @@
       <years>2013</years>
     </credit>
 
-    <desc>How to restart <sys its:translate="no">GDM</sys>.</desc>
-  </info>
-  
-<title>Restart <sys its:translate="no">GDM</sys></title>
+    <desc>How to restart GDM.</desc>
 
-  <p>In certain cases you might want to restart <sys its:translate="no">GDM</sys>
-  to make sure that the settings you have made are properly reloaded.
-  On <sys its:translate="no">systemd</sys>-based systems, run the following
-  command:</p>
+</info>
 
-  <p><cmd>systemctl restart gdm.service</cmd></p>
+<title>Restart GDM</title>
+
+  <p>When you make changes to configuration of the login screen banner message,
+  login screen logo or login screen background, you need to restart
+  <sys its:translate="no">GDM</sys> to reload the new settings.</p>
 
   <note>
   <p>Keep in mind that restarting the service interrupts any currently running
-   GNOME session.</p>
+  GNOME session.</p>
   </note>
+  
+  <section id="restart-gdm-systemd">
+  
+  <title>Restart GDM on systemd-based systems</title>
+  <p>To restart the <sys its:translate="no">GDM</sys> service on
+  <sys its:translate="no">systemd</sys>-based systems, run the
+  following command:</p> 
+  <p><cmd>systemctl restart gdm.service</cmd></p>
+  
+  </section>
 
+<!-- 
+  <section id="other-systems">
+  <title>Restart GDM on other systems</title>
+  </section>
+-->
 </page>
diff --git a/system-admin-guide/C/login-background.page b/system-admin-guide/C/login-background.page
index 8f8fb85..d2b8926 100644
--- a/system-admin-guide/C/login-background.page
+++ b/system-admin-guide/C/login-background.page
@@ -27,6 +27,9 @@
 
   <title>Change the background of the login screen</title>
 
+<section id="change-background">
+<title>Change your background</title>
+
   <comment>
     <cite date="2012-11-07" href="mailto:mdhillca gmail com">Michael Hill</cite>
     <p>Adapted from l-g-o SysAdminGuide page.</p>
@@ -44,17 +47,28 @@
   <item><p>Run the <input>dconf update</input> command.</p></item>
 </steps>
 
-  <p>Here is an example keyfile that could be stored as <file>/etc/dconf/db/gdm.d/corp-login</file>:</p>
+  <p>Here is an example keyfile that you can store as
+  <file>/etc/dconf/db/gdm.d/corp-login</file>:</p>
 
 <code>
 [org/gnome/desktop/background]
-picture-uri='file:///opt/corp/background.jpg'
+picture-uri='file:///<input its:translate="yes">opt/corp/background.jpg</input>'
 </code>
 
-
   <note>
-    <p>Note that these DConf key files are slightly different from gsettings
-    override files.</p>
+    <p><sys its:translate="no">dconf</sys> key files are slightly different
+    from <sys its:translate="no">GSettings</sys> override files.</p>
   </note>
+</section>
+
+<section id="troubleshooting-background">
+  <title>Troubleshooting: what if the background does not update?</title>
+  
+  <p>Make sure that you have run the <cmd its:translate="no">dconf update</cmd>
+  command to update the system databases.</p>
 
+  <p>In case the logo does not update, try restarting <sys>GDM</sys>. For more
+  information see <link xref="gdm-restart">Restart GDM</link>.</p>
+  
+</section>
 </page>
diff --git a/system-admin-guide/C/login-banner.page b/system-admin-guide/C/login-banner.page
index 34e07a9..76c4c72 100644
--- a/system-admin-guide/C/login-banner.page
+++ b/system-admin-guide/C/login-banner.page
@@ -5,7 +5,7 @@
 
   <info>
     <revision pkgversion="3.8" version="0.1" date="2013-04-19" status="review"/>
-    <link type="guide" xref="index" group="login" />
+    <link type="guide" xref="index" group="login"/>
     <link type="seealso" xref="gdm-restart"/>
 
 
@@ -34,29 +34,31 @@
     profile to display a text banner on the login screen.</desc>
   </info>
 
-  <title>Add text to the login screen</title>
+  <title>Display a text banner on the login screen</title>
 
   <comment>
     <cite date="2012-11-07" href="mailto:mdhillca gmail com">Michael Hill</cite>
     <p>Adapted from l-g-o SysAdminGuide page.</p>
   </comment>
 
+<section id="display-login-banner">
+  <title>Display a text banner</title>
   <p>The text banner on the login screen is controlled by the following
   <sys its:translate="no">GSettings</sys> keys:</p>
 
 <terms>
   <item>
-      <title>org.gnome.login-screen.banner-message-enable</title>
+      <title><code>org.gnome.login-screen.banner-message-enable</code></title>
       <p>enables showing the banner message</p>
   </item>
   <item>
-  <title>org.gnome.login-screen.banner-message-text</title>
+  <title><code>org.gnome.login-screen.banner-message-text</code></title>
       <p>shows the text banner message in the login window</p>
   </item>
 </terms>
 
 <steps>
-  <title>To add text to the login screen:</title>
+  <title>Display a text banner on the login screen:</title>
   <item><p>Add a key file to the
   <file its:translate="no">/etc/dconf/db/gdm.d</file> directory and name it,
   for example, <file>01-banner-message</file>.</p></item>
@@ -69,56 +71,24 @@ banner-message-text='<input its:translate="yes">Type the banner message here.</i
   <item><p>Run the <cmd its:translate="no">dconf update</cmd> command.</p></item>
 </steps>
 
-  <p>Note that <sys its:translate="no">dconf</sys> key files are slightly different
+<note>
+  <p><sys its:translate="no">dconf</sys> key files are slightly different
   from <sys its:translate="no">GSettings</sys> override files.</p>
+</note>
+</section>
+
+<section id="troubleshooting-banner">
+<title>Troubleshooting: what if the banner message does not update?</title>
+  <p>If the banner message does not show, make sure you have run the
+  <cmd>dconf update</cmd> command.</p>
+  <p>In case the banner message does not update, try restarting
+  <sys>GDM</sys>. For more information see
+  <link xref="gdm-restart">Restart GDM</link>.</p>
 
-<list>
-<title>Troubleshooting</title>
-  <item><p>If the banner message does not show up, make sure you have run the
-  <cmd>dconf update</cmd> command.</p></item>
-  <item><p>In case the banner message does not update, try restarting
-  <sys>GDM</sys>.</p></item>
-</list>
 
 <note>
-  <p>You should keep the banner message reasonably short.</p>
+  <p>You should keep the banner message reasonably short as longer texts do not
+  fit in the screen.</p>
 </note>
-
-<!--
-<section id="not-display">
-  <title>What if the banner message does not display?</title>
-  <comment>
-    <cite>Kat</cite>
-    <p>Apparently the message may not be displayed if the theme does not
-    support it. Find out if this is really the case and how to check the
-    theme.</p>
-  </comment>
 </section>
-
-<section id="prob-update">
-  <title>What if the banner message does not update?</title>
-</section>
-
-#gnome-os:
-<pmkovar> mclasen: so no need to cover questions like What if the banner message does not display? or What 
if the banner message does not update? in the login banner topic?
-<fmuellner> if the latter is false, the message in the former doesn't matter
-<pmkovar> fmuellner: right, we already have this documented 
-<fmuellner> pmkovar: then I  guess you are covered :)
-<pmkovar> fmuellner: cool, thanks :-)
-<pmkovar> jsvarova: ^ ;-)
-<mclasen> you could include a reminder to keep the message reasonably short
-<mclasen> do you explain the logo support in the same page ?
-<pmkovar> mclasen: not yet. are there any special keys for that one?
-<pmkovar> will include that reminder, thanks.
-<pmkovar>  mclasen:  actually, we have a separate page for the logo topic: 
https://git.gnome.org/browse/gnome-user-docs/tree/system-admin-guide/C/login-logo.page
-<mclasen> fmuellner: whats the logo key ?
-<mclasen> oh, ok
-<pmkovar> eg. /etc/dconf/db/gdm.d/01-logo i guess?
-<pmkovar> on that page, we have drafted a troubleshooting section titled What if the logo does not update?
-<pmkovar> fmuellner: anything we could cover there ^ ?
-<fmuellner> mmh
-<fmuellner> I *think* it's "restart gdm"
-<fmuellner> e.g. I don't think dconf sends change notifications for keys set via overrides
-<pmkovar>  fmuellner: ok
--->
 </page>
diff --git a/system-admin-guide/C/login-logo.page b/system-admin-guide/C/login-logo.page
index 1649de6..39800e6 100644
--- a/system-admin-guide/C/login-logo.page
+++ b/system-admin-guide/C/login-logo.page
@@ -4,9 +4,9 @@
       id="login-logo">
 
   <info>
-    <link type="guide" xref="index" group="login" />
     <revision version="0.1" date="2012-05-21" status="draft"/>
     <revision pkgversion="3.8" version="0.1" date="2013-04-24" status="review"/>
+    <link type="guide" xref="index" group="login" />
     <link type="seealso" xref="gdm-restart"/>
 
     <credit type="author copyright">
@@ -42,11 +42,14 @@
     <p>Adapted from l-g-o SysAdminGuide page.</p>
   </comment>
 
+<section id="greeter-logo">
+  <title>Add a greeter logo</title>
+
   <p>The logo on the login screen is controlled by the
   <cmd>org.gnome.login-screen.logo</cmd>
-  <sys its:translate="no">GSettings</sys> key.
+  <sys its:translate="no">GSettings</sys> key. Since
   <sys its:translate="no">GDM</sys> uses its own
-  <sys its:translate="no">dconf</sys> profile. Change settings in the
+  <sys its:translate="no">dconf</sys> profile, change settings in the
   <sys its:translate="no">dconf</sys> profile to add a greeter logo to the login
   screen.</p>
 
@@ -57,26 +60,26 @@
   <item><p>Run the <cmd its:translate="no">dconf update</cmd> command.</p></item>
 </steps>
 
-  <p>Here is a sample <file its:translate="no">/etc/dconf/db/gdm.d/01-logo</file>
-    file:</p>
+  <p>Below is an example <file its:translate="no">/etc/dconf/db/gdm.d/01-logo</file>
+  file:</p>
 <code its:translate="no">[org/gnome/login-screen]
 logo='<input>/usr/share/pixmaps/logo/greeter-logo.png</input>'
 </code>
 
-
   <note>
     <p><sys its:translate="no">dconf</sys> key files are slightly different
     from <sys its:translate="no">GSettings</sys> override files.</p>
   </note>
+</section>
+
+<section id="troubleshooting-logo">
 
-<section id="prob-login-logo-update">
-  <title>What if the logo does not update?</title>
-  
+  <title>Troubleshooting: what if the logo does not update?</title>
   <p>Make sure that you have run the <cmd its:translate="no">dconf update</cmd>
-   command to update the system databases.</p>
-  
-  <p>You can also restart <sys its:translate="no">GDM</sys> to make sure that
-   the settings are properly reloaded.</p>
+  command to update the system databases.</p>
+
+  <p>In case the logo does not update, try restarting <sys>GDM</sys>. For more
+  information see <link xref="gdm-restart">Restart GDM</link>.</p>
 
 </section>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]