GNOME.org
 

[gnome-user-docs] Re-indent mine pages properly and review

commit 3900f94eeda8c9cb3bb6bf99429762a018e0b4e9
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Thu Dec 11 21:32:09 2014 +0000

    Re-indent mine pages properly and review
    
    Stub the mime pages as they are very poor.

 .../C/mime-types-application-user.page             |   95 ------------
 .../C/mime-types-application-user.page.stub        |   90 +++++++++++
 system-admin-guide/C/mime-types-application.page   |   93 -----------
 .../C/mime-types-application.page.stub             |   87 +++++++++++
 system-admin-guide/C/mime-types-custom-user.page   |  107 -------------
 .../C/mime-types-custom-user.page.stub             |   95 ++++++++++++
 system-admin-guide/C/mime-types-custom.page        |  108 -------------
 system-admin-guide/C/mime-types-custom.page.stub   |   94 ++++++++++++
 system-admin-guide/C/mime-types.page               |  160 +++++++++-----------
 system-admin-guide/Makefile.am                     |    4 -
 10 files changed, 436 insertions(+), 497 deletions(-)
---
diff --git a/system-admin-guide/C/mime-types-application-user.page.stub 
b/system-admin-guide/C/mime-types-application-user.page.stub
new file mode 100644
index 0000000..5196bfd
--- /dev/null
+++ b/system-admin-guide/C/mime-types-application-user.page.stub
@@ -0,0 +1,90 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="mime-types-application-user">
+
+  <info>
+    <link type="guide" xref="software#management" />
+    <link type="seealso" xref="mime-types-custom-user" />
+    <link type="seealso" xref="mime-types-custom" />
+    <revision pkgversion="3.12" date="2014-06-17" status="review"/>
+
+    <credit type="author">
+      <name>Petr Kovar</name>
+      <email>pknbe volny cz</email>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <!-- TODO: This page needs to be re-written from a topic oriented perspective
+  and a description. The page ID and name may need to reflect the changes. Use
+  XIncludes for shared text with other files. -->
+
+  <title>Override the default registered application for individual
+  users</title>
+
+  <p>The <file>/usr/share/applications/defaults.list</file> file specifies
+  which application is registered to open specific MIME types by default. To
+  override the system defaults for individual users, you need to create a
+  <file>~/.local/share/applications/mimeapps.list</file> file with a list of
+  MIME types for which you want to override the default registered
+  application.</p>
+
+  <steps>
+    <title>Override the default registered application for individual users</title>
+    <item>
+      <p>Consult the <file>/usr/share/applications/defaults.list</file> file to
+      determine the MIME types for which you want to change the default
+      registered application. For example, the following sample of the
+      <file>defaults.list</file> file specifies the default registered
+      application for the <code>text/html</code> and
+      <code>application/xhtml+xml</code> MIME types:</p>
+      <code>[Default Applications]
+text/html=epiphany.desktop
+application/xhtml+xml=epiphany.desktop</code>
+      <p>The default application (<app>Epiphany</app>) is defined by specifying
+      its corresponding <file>.desktop</file> file
+      (<file>epiphany.desktop</file>). The system default location for other
+      applications' <file>.desktop</file> files is
+      <file>/usr/share/applications/</file>. Individual users'
+      <file>.desktop</file> files can be stored in
+      <file>~/.local/share/applications/</file>.</p>
+    </item>
+    <item>
+      <p>Create the <file>~/.local/share/applications/mimeapps.list</file>
+      file. In the file, specify the MIME types and their corresponding default
+      registered applications:</p>
+      <code>[Default Applications]
+text/html=<var>myapplication1.desktop</var>
+application/xhtml+xml=<var>myapplication2.desktop</var>
+
+[Added Associations]
+text/html=<var>myapplication1.desktop</var>;
+application/xhtml+xml=<var>myapplication2.desktop</var>;</code>
+      <p>This sets the default registered application for the
+      <code>text/html</code> MIME type to <code>myapplication1.desktop</code>,
+      and the default registered application for the
+      <code>application/xhtml+xml</code> MIME type to
+      <code>myapplication2.desktop</code>.</p>
+      <p>For these settings to function properly, ensure that both the
+      <file>myapplication1.desktop</file> and
+      <file>myapplication2.desktop</file> files are placed in the
+      <file>/usr/share/applications/</file> directory.</p>
+    </item>
+    <item>
+      <p>You can use the <cmd>gvfs-mime --query</cmd> command to verify that
+      the default registered application has been set correctly:</p>
+      <screen><output>$ </output><input>gvfs-mime --query text/html</input>
+Default application for 'text/html': myapplication1.desktop
+Registered applications:
+       myapplication1.desktop
+       epiphany.desktop
+Recommended applications:
+       myapplication1.desktop
+       epiphany.desktop</screen>
+    </item>
+  </steps>
+
+</page>
+
diff --git a/system-admin-guide/C/mime-types-application.page.stub 
b/system-admin-guide/C/mime-types-application.page.stub
new file mode 100644
index 0000000..2be5622
--- /dev/null
+++ b/system-admin-guide/C/mime-types-application.page.stub
@@ -0,0 +1,87 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="mime-types-application">
+
+  <info>
+    <link type="guide" xref="software#management" />
+    <link type="seealso" xref="mime-types-application-user" />
+    <link type="seealso" xref="mime-types-custom-user" />
+    <link type="seealso" xref="mime-types-custom" />
+    <revision pkgversion="3.12" date="2014-06-17" status="review"/>
+
+    <credit type="author">
+      <name>Petr Kovar</name>
+      <email>pknbe volny cz</email>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <!-- TODO: This page needs to be re-written from a topic oriented perspective
+  and a description. The page ID and name may need to reflect the changes. Use
+  XIncludes for shared text with other files. -->
+
+  <title>Override the default registered application for all users</title>
+
+  <p>The <file>/usr/share/applications/defaults.list</file> file specifies
+  which application is registered to open specific MIME types by default. To
+  override the system defaults for all users on the system, you need to create
+  a <file>/usr/share/applications/mimeapps.list</file> file with a list of MIME
+  types for which you want to override the default registered application.</p>
+
+  <steps>
+    <title>Override the default registered application for all users</title>
+    <item>
+      <p>Consult the <file>/usr/share/applications/defaults.list</file> file to
+      determine the MIME types for which you want to change the default
+      registered application. For example, the following sample of the
+      <file>defaults.list</file> file specifies the default registered
+      application for the <code>text/html</code> and
+      <code>application/xhtml+xml</code> MIME types:</p>
+      <code>[Default Applications]
+text/html=epiphany.desktop
+application/xhtml+xml=epiphany.desktop</code>
+      <p>The default application (<app>Epiphany</app>) is defined by specifying
+      its corresponding <file>.desktop</file> file
+      (<file>epiphany.desktop</file>). The default location for other
+      applications' <file>.desktop</file> files is
+      <file>/usr/share/applications/</file>.</p>
+    </item>
+    <item>
+      <p>Create the <file>/usr/share/applications/mimeapps.list</file> file. In
+      the file, specify the MIME types and their corresponding default
+      registered applications:</p>
+      <code>[Default Applications]
+text/html=<var>myapplication1.desktop</var>
+application/xhtml+xml=<var>myapplication2.desktop</var>
+
+[Added Associations]
+text/html=<var>myapplication1.desktop</var>;
+application/xhtml+xml=<var>myapplication2.desktop</var>;</code>
+      <p>This sets the default registered application for the
+      <code>text/html</code> MIME type to <code>myapplication1.desktop</code>,
+      and the default registered application for the
+      <code>application/xhtml+xml</code> MIME type to
+      <code>myapplication2.desktop</code>.</p> <p>For these settings to
+      function properly, ensure that both the
+      <file>myapplication1.desktop</file> and
+      <file>myapplication2.desktop</file> files are placed in the
+      <file>/usr/share/applications/</file> directory.</p>
+    </item>
+    <item>
+      <p>You can use the <cmd>gvfs-mime --query</cmd> command to verify that
+      the default registered application has been set correctly:</p>
+      <screen><output>$ </output><input>gvfs-mime --query text/html</input>
+Default application for 'text/html': myapplication1.desktop
+Registered applications:
+       myapplication1.desktop
+       epiphany.desktop
+Recommended applications:
+       myapplication1.desktop
+       epiphany.desktop</screen>
+    </item>
+  </steps>
+
+</page>
+
diff --git a/system-admin-guide/C/mime-types-custom-user.page.stub 
b/system-admin-guide/C/mime-types-custom-user.page.stub
new file mode 100644
index 0000000..9341f41
--- /dev/null
+++ b/system-admin-guide/C/mime-types-custom-user.page.stub
@@ -0,0 +1,95 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="mime-types-custom-user">
+
+  <info>
+    <link type="guide" xref="software#management" />
+    <link type="seealso" xref="mime-types" />
+    <revision pkgversion="3.12" date="2014-06-17" status="review"/>
+
+    <credit type="author">
+      <name>Petr Kovar</name>
+      <email>pknbe volny cz</email>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <!-- TODO: This page needs to be re-written from a topic oriented perspective
+  and a description. The page ID and name may need to reflect the changes. Use
+  XIncludes for shared text with other files. -->
+
+  <title>Add a custom MIME type for individual users</title>
+
+  <p>To add a custom MIME type for individual users and register a default
+  application for that MIME type, you need to create a new MIME type
+  specification file in the <file>~/.local/share/mime/packages/</file>
+  directory and a <file>.desktop</file> file in the
+  <file>~/.local/share/applications/</file> directory.</p>
+
+  <steps>
+    <title>Add a custom <code>application/x-newtype</code> MIME type for
+    individual users</title>
+    <item>
+      <p>Create the
+      <file>~/.local/share/mime/packages/application-x-newtype.xml</file>
+      file:</p>
+      <code mime="application/xml"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info";>
+  <mime-type type="application/x-newtype">
+    <comment>new mime type</comment>
+    <glob pattern="*.xyz"/>
+  </mime-type>
+</mime-info>]]></code>
+      <p>The sample <file>application-x-newtype.xml</file> file above defines a
+      new MIME type <sys>application/x-newtype</sys> and assigns file names
+      with the <file>.xyz</file> extension to that MIME type.</p>
+    </item>
+    <item>
+      <p>Create a new <file>.desktop</file> file named, for example,
+      <file>myapplication1.desktop</file>, and place it in the
+      <file>~/.local/share/applications/</file> directory:</p>
+      <code>[Desktop Entry]
+Type=Application
+MimeType=application/x-newtype
+Name=<var>My Application 1</var>
+Exec=<var>myapplication1</var></code>
+      <p>The sample <file>myapplication1.desktop</file> file above associates
+      the <code>application/x-newtype</code> MIME type with an application
+      named <app>My Application 1</app>, which is run by a command
+      <cmd>myapplication1</cmd>.</p>
+    </item>
+    <item>
+      <p>Update the MIME database for your changes to take effect:</p>
+      <screen><output>$ </output><input>update-mime-database ~/.local/share/mime</input></screen>
+    </item>
+    <item>
+      <p>Update the application database:</p>
+      <screen><output>$ </output><input>update-desktop-database ~/.local/share/applications</input></screen>
+    </item>
+    <item>
+      <p>To verify that you have successfully associated <file>*.xyz</file>
+      files with the <sys>application/x-newtype</sys> MIME type, first create
+      an empty file, for example <file>test.xyz</file>:</p>
+      <screen><output>$ </output><input>touch test.xyz</input></screen>
+      <p>Then run the <cmd>gvfs-info</cmd> command:</p>
+      <screen><output>$ </output><input>gvfs-info test.xyz | grep "standard::content-type"</input>
+  standard::content-type: application/x-newtype</screen>
+    </item>
+    <item>
+      <p>To verify that <file>myapplication1.desktop</file> has been correctly
+      set as the default registered application for the
+      <sys>application/x-newtype</sys> MIME type, run the <cmd>gvfs-mime
+      --query</cmd> command:</p>
+      <screen><output>$ </output><input>gvfs-mime --query application/x-newtype</input>
+Default application for 'application/x-newtype': myapplication1.desktop
+Registered applications:
+       myapplication1.desktop
+Recommended applications:
+       myapplication1.desktop</screen>
+    </item>
+  </steps>
+
+</page>
+
diff --git a/system-admin-guide/C/mime-types-custom.page.stub 
b/system-admin-guide/C/mime-types-custom.page.stub
new file mode 100644
index 0000000..81811e8
--- /dev/null
+++ b/system-admin-guide/C/mime-types-custom.page.stub
@@ -0,0 +1,94 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="mime-types-custom">
+
+  <info>
+    <link type="guide" xref="software#management" />
+    <link type="seealso" xref="mime-types" />
+    <link type="seealso" xref="mime-types-custom-user" />
+    <revision pkgversion="3.12" date="2014-06-17" status="review"/>
+
+    <credit type="author">
+      <name>Petr Kovar</name>
+      <email>pknbe volny cz</email>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <!-- TODO: This page needs to be re-written from a topic oriented perspective
+  and a description. The page ID and name may need to reflect the changes. Use
+  XIncludes for shared text with other files. -->
+
+  <title>Add a custom MIME type for all users</title>
+
+  <p>To add a custom MIME type for all users on the system and register a
+  default application for that MIME type, you need to create a new MIME type
+  specification file in the <file>/usr/share/mime/packages/</file> directory
+  and a <file>.desktop</file> file in the <file>/usr/share/applications/</file>
+  directory.</p>
+
+  <steps>
+    <title>Add a custom <sys>application/x-newtype</sys> MIME Type for All
+    Users</title>
+    <item>
+      <p>Create the
+      <file>/usr/share/mime/packages/application-x-newtype.xml</file> file:</p>
+      <code mime="application/xml"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info";>
+  <mime-type type="application/x-newtype">
+    <comment>new mime type</comment>
+    <glob pattern="*.xyz"/>
+  </mime-type>
+</mime-info>]]></code>
+      <p>The sample <file>application-x-newtype.xml</file> file above defines a
+      new MIME type <sys>application/x-newtype</sys> and assigns file names
+      with the <file>.xyz</file> extension to that MIME type.</p>
+    </item>
+    <item>
+      <p>Create a new <file>.desktop</file> file named, for example,
+      <file>myapplication1.desktop</file>, and place it in the
+      <file>/usr/share/applications/</file> directory:</p>
+      <code>[Desktop Entry]
+Type=Application
+MimeType=application/x-newtype
+Name=<var>My Application 1</var>
+Exec=<var>myapplication1</var></code>
+      <p>The sample <file>myapplication1.desktop</file> file above associates
+      the <sys>application/x-newtype</sys> MIME type with an application named
+      <app>My Application 1</app>, which is run by a command
+      <cmd>myapplication1</cmd>.</p>
+    </item>
+    <item>
+      <p>As root, update the MIME database for your changes to take effect:</p>
+      <screen><output># </output><input>update-mime-database /usr/share/mime</input></screen>
+    </item>
+    <item>
+      <p>As root, update the application database:</p>
+      <screen><output># </output><input>update-desktop-database /usr/share/applications</input></screen>
+    </item>
+    <item>
+      <p>To verify that you have successfully associated <file>*.xyz</file>
+      files with the <sys>application/x-newtype</sys> MIME type, first create
+      an empty file, for example <file>test.xyz</file>:</p>
+      <screen><output>$ </output><input>touch test.xyz</input></screen>
+      <p>Then run the <cmd>gvfs-info</cmd> command:</p>
+      <screen><output>$ </output><input>gvfs-info test.xyz | grep "standard::content-type"</input>
+  standard::content-type: application/x-newtype</screen>
+    </item>
+    <item>
+      <p>To verify that <file>myapplication1.desktop</file> has been correctly
+      set as the default registered application for the
+      <sys>application/x-newtype</sys> MIME type, run the <cmd>gvfs-mime
+      --query</cmd> command:</p>
+      <screen><output>$ </output><input>gvfs-mime --query application/x-newtype</input>
+Default application for 'application/x-newtype': myapplication1.desktop
+Registered applications:
+       myapplication1.desktop
+Recommended applications:
+       myapplication1.desktop</screen>
+    </item>
+  </steps>
+
+</page>
diff --git a/system-admin-guide/C/mime-types.page b/system-admin-guide/C/mime-types.page
index 2e6ff5c..e838ede 100644
--- a/system-admin-guide/C/mime-types.page
+++ b/system-admin-guide/C/mime-types.page
@@ -19,105 +19,85 @@
     <desc>MIME types are used to identify the format of a file.</desc>
   </info>
 
-    <title>What are MIME types?</title>
-    <p>
-      In GNOME, MIME (<em>Multipurpose Internet Mail Extension</em>)
-      types are used to identify the format of a file. The GNOME Desktop
-      uses MIME types to:
-    </p>
-    <list>
-      <item>
-        <p>
-          Determine which application should open a specific file format by
-          default.
-        </p>
-      </item>
-      <item>
-        <p>
-          Register other applications that can also open a specific file format.
-        </p>
-      </item>
-      <item>
-        <p>
-          Provide a string describing the type of a file, for example,
-          in a file properties dialog of the <app>Files</app>
-          application.
-        </p>
-      </item>
-      <item>
-        <p>
-          Provide an icon representing a specific file format, for
-          example, in a file properties dialog of the <app>Files</app>
-          application.
-        </p>
-      </item>
-    </list>
-    <p>
-      MIME type names follow a given format:
-    </p>
-<screen>
-<var>media-type</var>/<var>subtype-identifier</var>
-</screen>
-<p>
-      <sys>image/jpeg</sys> is an example of a MIME type where
-      <sys>image</sys> is the media type, and <sys>jpeg</sys>
-      is the subtype identifier.
-</p>
-    <p>
-      GNOME follows the <em>freedesktop.org Shared MIME Info</em>
-      specification to determine:
-    </p>
-    <list>
+  <title>What are MIME types?</title>
+
+  <p>In GNOME, MIME (<em>Multipurpose Internet Mail Extension</em>) types are
+  used to identify the format of a file. The GNOME Desktop uses MIME types
+  to:</p>
+
+  <list>
     <item>
-      <p>
-        The machine-wide and user-specific location to store all MIME type
-        specification files.
-      </p>
+      <p>Determine which application should open a specific file format by
+      default.</p>
     </item>
     <item>
-      <p>
-        How to register a MIME type so that the desktop environment knows which
-        applications can be used to open a specific file format.
-      </p>
+      <p>Register other applications that can also open a specific file
+      format.</p>
     </item>
     <item>
-      <p>
-        How the user can change which applications should open what file formats.
-      </p>
+      <p>Provide a string describing the type of a file, for example, in a file
+      properties dialog of the <app>Files</app> application.</p>
     </item>
-    </list>
-    <section id="mime-database">
-      <title>What is the MIME database?</title>
-      <p>
-        The MIME database is a collection of all MIME type specification files
-        that GNOME uses to store information about known MIME types.
-      </p>
-      <p>
-        The most important part of the MIME database from the system administrator's
-        point of view is the <file>/usr/share/mime/packages/</file>
-        directory where the MIME type related files specifying information on
-        known MIME types are stored. One example of such a file is
-        <file>/usr/share/mime/packages/freedesktop.org.xml</file>, specifying
-        information about the standard MIME types available on the system by
-        default. That file is provided by the <sys>shared-mime-info</sys>
-        package.
-      </p>
-    </section>
-    <section id="mime-types-more-information">
+    <item>
+      <p>Provide an icon representing a specific file format, for example, in a
+      file properties dialog of the <app>Files</app> application.</p>
+    </item>
+  </list>
+
+  <p>MIME type names follow a given format:</p>
+
+  <screen><var>media-type</var>/<var>subtype-identifier</var></screen>
+
+  <p><sys>image/jpeg</sys> is an example of a MIME type where <sys>image</sys>
+  is the media type, and <sys>jpeg</sys> is the subtype identifier.</p>
+
+  <p>GNOME follows the <em>freedesktop.org Shared MIME Info</em> specification
+  to determine:</p>
+
+  <list>
+    <item>
+      <p>The machine-wide and user-specific location to store all MIME type
+      specification files.</p>
+    </item>
+    <item>
+      <p>How to register a MIME type so that the desktop environment knows
+      which applications can be used to open a specific file format.</p>
+    </item>
+    <item>
+      <p>How the user can change which applications should open what file
+      formats.</p>
+    </item>
+  </list>
+
+  <section id="mime-database">
+    <title>What is the MIME database?</title>
+
+    <p>The MIME database is a collection of all MIME type specification files
+    that GNOME uses to store information about known MIME types.</p>
+
+    <p>The most important part of the MIME database from the system
+    administrator's point of view is the <file>/usr/share/mime/packages/</file>
+    directory where the MIME type related files specifying information on known
+    MIME types are stored. One example of such a file is
+    <file>/usr/share/mime/packages/freedesktop.org.xml</file>, specifying
+    information about the standard MIME types available on the system by
+    default. That file is provided by the <sys>shared-mime-info</sys>
+    package.</p>
+
+  </section>
+
+  <section id="mime-types-more-information">
     <title>Get more information</title>
-    <p>
-      For detailed information describing the MIME type system, see the
-      <em>freedesktop.org Shared MIME Info specification</em> located at the
-      freedesktop.org website:
-    </p>
+
+    <p>For detailed information describing the MIME type system, see the
+    <em>freedesktop.org Shared MIME Info specification</em> located at the
+    freedesktop.org website:</p>
+
     <list>
       <item>
-        <p>
-           <link href="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/";>
-           http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/</link>
-        </p>
+        <p><link 
href="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/";>http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/</link></p>
       </item>
     </list>
-    </section>
-</page>
+  </section>
 
+</page>
diff --git a/system-admin-guide/Makefile.am b/system-admin-guide/Makefile.am
index 5ca9377..b0ec5a6 100644
--- a/system-admin-guide/Makefile.am
+++ b/system-admin-guide/Makefile.am
@@ -30,10 +30,6 @@ HELP_FILES = \
        login-fingerprint.page \
        login-userlist-disable.page \
        mime-types.page \
-       mime-types-application.page \
-       mime-types-application-user.page \
-       mime-types-custom.page \
-       mime-types-custom-user.page \
        network-printer-config.page \
        session-custom.page \
        session-user.page \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]