GNOME.org
 

OAF documentation fix

This patch fixes a handful of typos in the liboaf docs, plus adds
<sect1> id's so the generated HTML files all have meaningful names.

John

-- 
dusk ravendusk org                            http://www.gnome.org
jsheets codeweavers com                  http://www.worldforge.org
jsheets users sourceforge net     http://openbooks.sourceforge.net
               http://advogato.org/person/jsheets

? oaf-docs.diff
Index: api-docs/architecture.sgml
===================================================================
RCS file: /cvs/gnome/oaf/api-docs/architecture.sgml,v
retrieving revision 1.3
diff -u -r1.3 architecture.sgml
--- api-docs/architecture.sgml	2000/10/06 04:25:32	1.3
+++ api-docs/architecture.sgml	2000/11/20 20:47:33
@@ -1,7 +1,7 @@
 <chapter id="architecture">
 <title>OAF Architecture</title>
 
-<sect1>
+<sect1 id="oaf-daemon">
 <title>The OAF daemon</title>
 <para>
 OAF is nothing but a daemon implementing a set of CORBA interfaces.
@@ -12,13 +12,13 @@
 </para>
 
 <para>
-The OAF daemon features a powerful query langage which allows ou to 
+The OAF daemon features a powerful query langage which allows you to 
 ask for certain services rather than for certain applications.
 </para>
 
 <para>
 C programmers who wish to access these services do not need to make
-raw CORBA calls: they can use a set of conveniance functions implemented
+raw CORBA calls: they can use a set of convenience functions implemented
 in the liboaf library. This library acts as a wrapper on top of the CORBA
 server. The API documentation for the liboaf library is available there.
 (XXX: add pointer to the API ref).
@@ -26,12 +26,12 @@
 
 </sect1>
 
-<sect1>
+<sect1 id="server-arch">
 <title>Server architecture</title>
 
 <para>
-The OAF server is splitted in 2 parts: The <classname>ObjectDirectory</classname> which contains the list
-of all servers on a given machine. The <classname>ActivationContext</classname> which contains the
+The OAF server is split in 2 parts: the <classname>ObjectDirectory</classname> which contains the list
+of all servers on a given machine, and the <classname>ActivationContext</classname> which contains the
 list of all ObjectDirectories. It contains by default the local ObjectDirectory
 and you can add inside other distant ObjectDirectories.
 </para>
@@ -99,7 +99,7 @@
 
 </sect1>
 
-<sect1>
+<sect1 id="async-activation">
 <title>Async Activation</title>
 
 <para>
Index: api-docs/configuring.sgml
===================================================================
RCS file: /cvs/gnome/oaf/api-docs/configuring.sgml,v
retrieving revision 1.2
diff -u -r1.2 configuring.sgml
--- api-docs/configuring.sgml	2000/08/11 16:20:16	1.2
+++ api-docs/configuring.sgml	2000/11/20 20:47:33
@@ -22,7 +22,7 @@
 </para>
 
 <para>
-The above env variables are kept for comatibility purposes with older versions of 
+The above env variables are kept for compatibility purposes with older versions of 
 OAF and for GNOME integration. OAF has a much nicer configuration file which allows 
 you to control which directories are parsed by OAF. This XML configuration file
 is located in ${prefix}/etc/oaf/oaf-config.xml. An empty oaf-config.xml and 
Index: api-docs/migrating.sgml
===================================================================
RCS file: /cvs/gnome/oaf/api-docs/migrating.sgml,v
retrieving revision 1.3
diff -u -r1.3 migrating.sgml
--- api-docs/migrating.sgml	2000/08/11 23:15:56	1.3
+++ api-docs/migrating.sgml	2000/11/20 20:47:33
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="migrating">
 <title>Migrating from gnorba to OAF</title>
 
    <sect1>
Index: api-docs/oafinfo-ref.sgml
===================================================================
RCS file: /cvs/gnome/oaf/api-docs/oafinfo-ref.sgml,v
retrieving revision 1.2
diff -u -r1.2 oafinfo-ref.sgml
--- api-docs/oafinfo-ref.sgml	2000/08/11 16:20:16	1.2
+++ api-docs/oafinfo-ref.sgml	2000/11/20 20:47:35
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="oafinfo-ref">
 <title><filename>.oafinfo</filename> file format reference</title>
 
 <para>
@@ -7,31 +7,34 @@
 interfaces they support.
 </para>
 
-<sect1>
+<sect1 id="server-tag">
 <title>The &lt;oaf_server> tag</title>
 
 <para>
-Here folows a simple example of a minimalist .oafinfo file.
+Here follows a simple example of a minimalist .oafinfo file.
 <programlisting>
 &lt;oaf_info>
-&lt;oaf_server iid="OAFIID:oaf_naming_service:7e2b90ef-eaf0-4239-bb7c-812606fcd80d" type="exe" location="oafd">
+&lt;oaf_server iid="OAFIID:oaf_naming_service:7e2b90ef-eaf0-4239-bb7c-812606fcd80d" 
+  type="exe" location="oafd">
 &lt;/oaf_server>
 &lt;oaf_info>
 </programlisting>
-Each oaf_server entry conventionaly has 3 mandatory properties: <emphasis>iid</emphasis>
+Each oaf_server entry conventionally has 3 mandatory properties: <emphasis>iid</emphasis>
 (an iid generated by <emphasis>uuidgen</emphasis>), <emphasis>type</emphasis> (can be 
 <emphasis>exe</emphasis>, <emphasis>factory</emphasis> and <emphasis>shlib</emphasis>) and 
 <emphasis>location</emphasis>. If the type is <emphasis>exe</emphasis>, location is the name of 
 the executable which creates the CORBA interfaces associated to this entry and registers 
 them to OAF. It the type is <emphasis>factory</emphasis>, location is the iid of the component 
-which can create the corresponding CORBA server. Here folows a simple example of this:
+which can create the corresponding CORBA server. Here follows a simple example of this:
 <programlisting>
 &lt;oaf_info>
 
-&lt;oaf_server iid="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5" type="exe" location="bonobo-echo">
+&lt;oaf_server iid="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5"
+  type="exe" location="bonobo-echo">
 &lt;/oaf_server>
 
-&lt;oaf_server iid="OAFIID:demo_echo:fe45dab2-ae27-45e9-943d-34a49eefca96" type="factory" location="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5">
+&lt;oaf_server iid="OAFIID:demo_echo:fe45dab2-ae27-45e9-943d-34a49eefca96"
+  type="factory" location="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5">
 &lt;/oaf_server>
 
 &lt;/oaf_info>
@@ -49,18 +52,19 @@
 
 </sect1>
 
-<sect1>
+<sect1 id="attribute-tag">
 <title>The &lt;oaf_attribute> tag</title>
 
 <para>
-Defining servers is usefull (that is what .goad files did light-years ago)  but to 
+Defining servers is useful (that is what .goad files did light-years ago)  but to 
 use all the power of OAF (ie: queries ;-), you have to define <emphasis>oaf_attributes</emphasis> 
-for each of those <emphasis>oaf_server</emphasis> entry. 
+for each of those <emphasis>oaf_server</emphasis> entries. 
 An example is worth all words.
 <programlisting>
 &lt;oaf_info>
 
-&lt;oaf_server iid="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5" type="exe" location="bonobo-echo">
+&lt;oaf_server iid="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5"
+  type="exe" location="bonobo-echo">
 &lt;oaf_attribute name="repo_ids" type="stringv">
 &lt;item value="IDL:GNOME/GenericFactory:1.0"/>
 &lt;/oaf_attribute>
@@ -68,7 +72,8 @@
 &lt;oaf_attribute name="description" type="string" value="Bonobo Echo server factory"/>
 &lt;/oaf_server>
 
-&lt;oaf_server iid="OAFIID:demo_echo:fe45dab2-ae27-45e9-943d-34a49eefca96" type="factory" location="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5">
+&lt;oaf_server iid="OAFIID:demo_echo:fe45dab2-ae27-45e9-943d-34a49eefca96"
+  type="factory" location="OAFIID:demo_echo_factory:a7080731-d06c-42d2-852e-179c538f6ee5">
 &lt;oaf_attribute name="repo_ids" type="stringv">
 &lt;item value="IDL:Demo/Echo:1.0"/>
 &lt;/oaf_attribute>
@@ -85,7 +90,7 @@
 </para>
 
 <para>
-<emphasis>stringv</emphasis> types value is represented as folows:
+<emphasis>stringv</emphasis> types value is represented as follows:
 <programlisting>
 &lt;oaf_attribute name="repo_ids" type="stringv">
 &lt;item value="IDL:GNOME/GenericFactory:1.0"/>
@@ -97,7 +102,7 @@
 
 <para>
 A certain number of attributes have been normalized for OAF. Some of them are mandatory.
-Their list folows.
+Their list follows.
 
 	<table frame="all">
 	<title>Normalized attributes</title>
Index: api-docs/query-langage.sgml
===================================================================
RCS file: /cvs/gnome/oaf/api-docs/query-langage.sgml,v
retrieving revision 1.2
diff -u -r1.2 query-langage.sgml
--- api-docs/query-langage.sgml	2000/08/11 16:20:16	1.2
+++ api-docs/query-langage.sgml	2000/11/20 20:47:37
@@ -4,7 +4,7 @@
 <sect1>
 <title>The OAF query langage</title>
 <para>
-OAF has a query langage used to request components with
+OAF has a query language used to request components with
 specific properties from the OAF daemon.
 The API call <function>oaf_activate</function> takes a
 <emphasis>requirements</emphasis> parameter which is
@@ -31,7 +31,7 @@
 </para>
 </sect1>
 
-<sect1>
+<sect1 id="query-syntax">
 <title>Syntax</title>
 
 <sect2 id="oaf-query-ref-types">
Index: api-docs/tutorial.sgml
===================================================================
RCS file: /cvs/gnome/oaf/api-docs/tutorial.sgml,v
retrieving revision 1.3
diff -u -r1.3 tutorial.sgml
--- api-docs/tutorial.sgml	2000/08/11 23:15:56	1.3
+++ api-docs/tutorial.sgml	2000/11/20 20:47:38
@@ -1,4 +1,4 @@
-<chapter>
+<chapter id="tutorial">
 <title>OAF tutorial</title>
 
    <sect1>
@@ -57,17 +57,17 @@
 
       <para>
       Basically, OAF keeps track of all the CORBA servers installed on your machine and
-      can track any other machine CORBA servers provided you set up OAF correctly and 
+      can track any other machine's CORBA servers provided you set up OAF correctly and 
       allows you to perform queries on the properties of these servers.
-      The folowing very simple example will make things rather clear:
+      The following very simple example will make things rather clear:
 
       <programlisting>
 CORBA_Object o = oaf_activate ("repo_ids.has ('IDL:GNOME/Graph/Layout:1.0')",
                                NULL, 0, NULL, &amp;ev);
       </programlisting>
 
-      This will ask for a component which supports the GNOME/Graph/Lyout:1.0 interface.
-      You can also do much more complicated things. OAf will find one whcih matches the 
+      This will ask for a component which supports the GNOME/Graph/Layout:1.0 interface.
+      You can also do much more complicated things. OAF will find one whcih matches the 
       query and will take all the necessary measures required to get the server running
       (if it is a shared library progam, it will load the relevant library in memory.
       If you need a Factory, it will launch the factory and request the factory to create
@@ -81,7 +81,7 @@
       <title>Getting started</title>
 
       <para>
-      Here folows a very simple-stupid example of what you can do with OAF.
+      Here follows a very simple-stupid example of what you can do with OAF.
       The complete API description of liboaf, the OAF query langage reference and the
       <filename>.oafinfo</filename> file format reference are included in this 
       document and are recommended readings. Reading <xref linkend="architecture"> is
@@ -92,17 +92,17 @@
 
    </sect1>
 
-   <sect1>
+   <sect1 id="checklist">
    <title>Checklist</title>
 
    <para>
-   If you plan to use OAF for your own CORBA servers, you should use the folowing simple 
+   If you plan to use OAF for your own CORBA servers, you should use the following simple 
    checklist.
    <itemizedlist>
 
    <listitem>
    <para>
-   Create a unique UUID for your CORBA server by using the libuuid and uuidgen
+   Create a unique UUID for your CORBA server by using libuuid and uuidgen
    (both are available by anonymous ftp from tsx-11.mit.edu in 
    <filename>/pub/linux/packages/ext2fs</filename>. These are part of the 
    <filename>e2fsprogs</filename> package.
@@ -126,7 +126,7 @@
 
    </itemizedlist>
 
-   If you are a client wiling to activate a few servers, it is a little simpler: you 
+   If you are a client willing to activate a few servers, it is a little simpler: you 
    just must make sure you call the <function>oaf_init</function> function and you can then
    call <function>oaf_query</function> or <function>oaf_activate</function> or 
    <function>oaf_activate_from_id</function>.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]