Author: locilka Date: Thu Aug 14 14:29:35 2008 New Revision: 50072 URL: http://svn.opensuse.org/viewcvs/yast?rev=50072&view=rev Log: - Added documentation for add_on_products and its new format add_on_products.xml (FATE #303675). Added: trunk/installation/doc/features/examples/add_on_products trunk/installation/doc/features/examples/add_on_products.xml Modified: trunk/installation/doc/features/features.xml trunk/installation/package/yast2-installation.changes Added: trunk/installation/doc/features/examples/add_on_products URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/features/examples/add_on_products?rev=50072&view=auto ============================================================================== --- trunk/installation/doc/features/examples/add_on_products (added) +++ trunk/installation/doc/features/examples/add_on_products Thu Aug 14 14:29:35 2008 @@ -0,0 +1,3 @@ +http://some.product.repository/url1/ +http://some/product.repository/url2/ /relative/product/path +http://some.product.repository/url3/ / Product-1 Product-2 Added: trunk/installation/doc/features/examples/add_on_products.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/features/examples/add_on_products.xml?rev=50072&view=auto ============================================================================== --- trunk/installation/doc/features/examples/add_on_products.xml (added) +++ trunk/installation/doc/features/examples/add_on_products.xml Thu Aug 14 14:29:35 2008 @@ -0,0 +1,42 @@ +<?xml version="1.0"?> +http://www.suse.com/1.0/yast2ns" + xmlns:config="http://www.suse.com/1.0/configns"> + <!-- List of available products --> + + + <!-- The first product item --> + + <!-- Product name visible in UI when offered to user (optional item) --> + <name>Add-on Name to Display</name> + <!-- Product URL (mandatory item) --> + <url>http://product.repository/url/</url> + <!-- Product path, default is "/" (optional item) --> + <path>/relative/product/path</path> + <!-- + List of products to install from media, by default all products + from media are installed (optional item) + --> + + <!-- + Product to install - matching the metadata product 'name' + (mandatory to fully define 'install_products') + --> + <product>Product-ID-From-Repository</product> + <product>...</product> + + <!-- + If set to 'true', user is asked whether to install this product, + default is 'false' (optional) + --> + true + <!-- + Connected to 'ask_user', sets the default status of product, + default is 'false' (optional) + --> + <selected config:type="boolean">true</selected> + + + <!-- Another product item --> + + + Modified: trunk/installation/doc/features/features.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/features/features.xml?rev=50072&r1=50071&r2=50072&view=diff ============================================================================== --- trunk/installation/doc/features/features.xml (original) +++ trunk/installation/doc/features/features.xml Thu Aug 14 14:29:35 2008 @@ -5,6 +5,129 @@ <para>This section contains description of several installation features.</para> - <!-- FIXME: describe add_on_products.xml file format, placement, and usage --> - <!-- FIXME: describe add_on_products file format, placement, and usage --> -</section> \ No newline at end of file + <section id="add_on_products_general"> + <title>Additional Products Automatically Added with Installation Repository</title> + + <para>You can easily add several additional products automatically just by using + a modified installation repository or media.</para> + + <para>During installation or upgrade from media (CD, DVD, HTTP server, ...) + installation adds a primary installation repository, this repository can contain + special configuration file with list of additional repositories that would be + automatically added by YaST.</para> + + <para>The configuration is written in XML - which means extending the format + (adding new features) is easier comparing to the old plain-file format.</para> + + <section id="installation_features_add_on_products.xml"> + <title>Configuration file <emphasis>add_on_products.xml</emphasis></title> + <!-- FIXME: describe add_on_products.xml file format, placement, and usage --> + + <para>File <emphasis>add_on_products.xml</emphasis> is placed in the + media root.</para> + + <para>Commented example:</para> + <programlisting>http://www.w3.org/2001/XInclude"/></programlisting> + + <itemizedlist> + <title>Mandatory items:</title> + <listitem> + <para>(string) <emphasis>url</emphasis> - repository URL; absolute or relative + to the base installation repository; relative URL is useful when the same + repository is used via several access methods (e.g., NFS+HTTP+FTP).</para> + + <para>Absolute:</para> + <programlisting><url>http://example.com/SUSE_5.0/<url>;</programlisting> + + <para>Relative:</para> + <programlisting><url>../SUSE_5.0/<url></programlisting> + </listitem> + </itemizedlist> + + <itemizedlist> + <title>Optional items:</title> + + <listitem> + <para>(string) <emphasis>name</emphasis> - Product name used when repositories + are offered to user in UI before adding them, see <emphasis>ask_user</emphasis> + for more; if not set, product URL and/or other items are used instead.</para> + </listitem> + + <listitem> + <para>(string) <emphasis>path</emphasis> - Additional product path in the + repository, useful when there are more product at one URL; the default is + <emphasis>/</emphasis> if not set.</para> + </listitem> + + <listitem> + <para>(boolean) <emphasis>ask_user</emphasis> - Users are asked whether to + add such a product; products without this parameter are added automatically; + default is <emphasis>false</emphasis></para> + </listitem> + + <listitem> + <para>(boolean) <emphasis>selected</emphasis> - Defines the default state of + <emphasis>pre-selected</emphasis> state in case of <emphasis>ask_user</emphasis> + used; default is <emphasis>false</emphasis></para> + </listitem> + + <listitem> + <para>(list <string>) <emphasis>install_products/product</emphasis> - List of + products to add if there are more than one products at the repository URL; + if not defined, all products are installed.</para> + </listitem> + </itemizedlist> + </section> + + <section id="installation_features_add_on_products"> + <title>Configuration file <emphasis>add_on_products</emphasis></title> + + <para>File <emphasis>add_on_products</emphasis> is an obsolete format of + <emphasis><link linkend="installation_features_add_on_products.xml">add_on_products.xml</link></emphasis> + described above. It does not have additional features of the newer format and it is almost + impossible to extend it.</para> + + <para>Repositories listed in this file are added automatically with the primary installation + repository.</para> + + <para>Example:</para> + <programlisting>http://www.w3.org/2001/XInclude"/></programlisting> + + <para>Repository entries are newline-separated, repository items are white-space-separated + (<emphasis>tab</emphasis> or <emphasis>space</emphasis>).</para> + + <itemizedlist> + <title>Mandatory items:</title> + <listitem> + <para>First item: (string) <emphasis>url</emphasis> - repository URL; absolute or relative + to the base installation repository; relative URL is useful when the same + repository is used via several access methods (e.g., NFS+HTTP+FTP).</para> + + <para>Absolute:</para> + <programlisting><url>http://example.com/SUSE_5.0/<url>;</programlisting> + + <para>Relative:</para> + <programlisting><url>../SUSE_5.0/<url></programlisting> + </listitem> + </itemizedlist> + + <itemizedlist> + <title>Optional items:</title> + + <listitem> + <para>Second item: (string) <emphasis>path</emphasis> - Additional product path in the + repository, useful when there are more product at one URL; the default is + <emphasis>/</emphasis> if not set.</para> + </listitem> + + <listitem> + <para>Third .. <emphasis>n</emphasis> item: (string) <emphasis></emphasis> - products + to add if there are more than one products at the repository URL; if not defined, + all products are installed.</para> + </listitem> + </itemizedlist> + </section> + </section> +</section> Modified: trunk/installation/package/yast2-installation.changes URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/package/yast2-installation.changes?rev=50072&r1=50071&r2=50072&view=diff ============================================================================== --- trunk/installation/package/yast2-installation.changes (original) +++ trunk/installation/package/yast2-installation.changes Thu Aug 14 14:29:35 2008 @@ -1,4 +1,10 @@ ------------------------------------------------------------------- +Thu Aug 14 14:28:33 CEST 2008 - locilka@suse.cz + +- Added documentation for add_on_products and its new format + add_on_products.xml (FATE #303675). + +------------------------------------------------------------------- Wed Aug 13 18:23:57 CEST 2008 - locilka@suse.cz - Dropped some obsolete documentation. -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org