Author: jw Date: Thu Oct 27 12:19:12 2011 New Revision: 66617 URL: http://svn.opensuse.org/viewcvs/yast?rev=66617&view=rev Log: From: Martina Dejmek: anbei der erste Schwung geproofter Dateien, die auf proofed gesetzt werden koennen Added: trunk/autoinstallation/doc/test.jw Modified: trunk/autoinstallation/doc/xml/CreateProfile.xml trunk/autoinstallation/doc/xml/Introduction.xml trunk/autoinstallation/doc/xml/Profile.xml Added: trunk/autoinstallation/doc/test.jw URL: http://svn.opensuse.org/viewcvs/yast/trunk/autoinstallation/doc/test.jw?rev=66617&view=auto ============================================================================== --- trunk/autoinstallation/doc/test.jw (added) +++ trunk/autoinstallation/doc/test.jw Thu Oct 27 12:19:12 2011 @@ -0,0 +1 @@ +see if I can write the tree.. Modified: trunk/autoinstallation/doc/xml/CreateProfile.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/autoinstallation/doc/xml/CreateProfile.xml?rev=66617&r1=66616&r2=66617&view=diff ============================================================================== --- trunk/autoinstallation/doc/xml/CreateProfile.xml (original) +++ trunk/autoinstallation/doc/xml/CreateProfile.xml Thu Oct 27 12:19:12 2011 @@ -1,25 +1,31 @@ - +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//Novell//DTD NovDoc XML V1.0//EN" "novdocx.dtd" +[ +<!ENTITY % NOVDOC.DEACTIVATE.IDREF "INCLUDE"> +<!ENTITY % entities SYSTEM "entity-decl.ent"> +%entities; +]> <chapter id="CreateProfile"> <title >Creating A Control File</title> <para> </para> <section id="Autoinstallation.collectInfo"> - <title>Collect information</title> + <title>Collecting Information</title> <para> - In order to create the control file, first you need to collect + In order to create the control file, you need to collect information about the systems your are going to - install. This includes among other things hardware data and network - information. Make sure you know the following about the machines you want to install: + install. This includes hardware data and network + information among other things. Make sure you have the following information about the machines you want to install: </para> <itemizedlist> <listitem> <para>Hard disk types and sizes</para> </listitem> <listitem> - <para>Graphic interface and attached monitor if any</para> + <para>Graphical interface and attached monitor, if any</para> </listitem> <listitem> - <para>Network interface and MAC address if known (i.e. when using &dhcp;)</para> + <para>Network interface and MAC address if known (for example, when using DHCP)</para> </listitem> </itemizedlist> <para> @@ -29,18 +35,18 @@ </section> <section id="CreateProfile.CMS"> <title> - Using the Configuration Management System + Using the Configuration Management System (CMS) </title> <para> In order to create the control file for one or more computers, a configuration - interface based on &yast2; is provided. This system depends on existing modules + interface based on &yast;2 is provided. This system depends on existing modules which are usually used to configure a computer in regular operation mode, - i.e. after &company-suse; Linux is installed. + for example, after SUSE Linux is installed. </para> <para> The configuration management system lets you create control files easily and - additionally it lets you manage a repository of configurations for use - in a networked environment and with multiple clients. + lets you manage a repository of configurations for the use + in a networked environment with multiple clients. </para> <figure> <title>Configuration System</title> @@ -48,24 +54,24 @@ </figure> <section> - <title>Creating a new Profile</title> + <title>Creating a New Profile</title> <para> With some exceptions, almost all resources of the control file can be configured using the configuration management system. The system - offers flexibility and configuration of some resources is - identical to this available in the &yast2; Control Center. In + offers flexibility and the configuration of some resources is + identical to the one available in the &yast;2 Control Center. In addition to the existing and familiar modules new interfaces were created for special and complex configurations, - for example for partitioning, general options and software. + for example for partitioning, general options and software. </para> <para> - Furthermore, using the &cms; guarantees that the resulting control file is - valid and insures that it can be used directly to start automated installation. + Furthermore, using a CMS guarantees the validity of the resulting control file + and its direct use for starting automated installation. </para> <para> Make sure the configuration system is installed (package <emphasis>autoyast2</emphasis>) and call it using the <emphasis>YaST2 - Control Center</emphasis> or call it directly as root with the + Control Center</emphasis> or as root with the following command (make sure the <emphasis>DISPLAY</emphasis> variable is set correctly to start the graphical user interface instead of the text based one): </para> @@ -81,30 +87,29 @@ <section id="CreateProfile.Manual"> <title>Creating/Editing a Control File Manually</title> <para> - If you edit the control file manually, make sure it has a valid syntax. To - check the syntax, use some tools already available - on the distribution. For example to verify that the file is well - formed, use the utility <command>xmllint</command> available with the + If editing the control file manually, make sure it has a valid syntax. To + check the syntax, use the tools already available + on the distribution. For example, to verify that the file is well-formed, use the utility <command>xmllint</command> available with the <emphasis>libxml2</emphasis> package: </para> <screen> xmllint <control file> </screen> <para> - If the control file is not well formed, i.e. if a tag is not closed, + If the control file is not well formed, for example, if a tag is not closed, <command>xmllint</command> will report about the errors. </para> <para> - Before going on with the auto-installation, please fix any errors - resulting from such checks. The auto-installation process can't be - started with an invalid and non-well formed control file. + Before going on with the autoinstallation, fix any errors + resulting from such checks. The autoinstallation process cannot be + started with an invalid and not well-formed control file. </para> <para> - You can use any XML editor available on your system or use your - favorite text editor with XML support (i.e. Emacs, Vim). However, it is not quite - optimal to create the control file manually for large number of machines - and it should only be seen as an interface between the auto-installation + You can use any XML editor available on your system or your + favorite text editor with XML support (for example, Emacs, Vim). However, it is not + optimal to create the control file manually for a large number of machines + and it should only be seen as an interface between the autoinstallation engine and the Configuration Management System (<abbrev>CMS</abbrev>). </para> @@ -116,15 +121,14 @@ </section> <section id="CreateProfile.XSLT"> - <title>Creating a Profile (control file) via Script with XSLT</title> + <title>Creating a Profile (Control File) via Script with XSLT</title> <para> - For the case you have a template and just want to change a few things via script or command line, - you can use a XSLT processor like <emphasis>sablot</emphasis> for this. Lets say you have an autoyast profile - and you want to fillout the hostname via script for any reason (maybe because you have to do it - so often, you want to script it) + If you have a template and want to change a few things via script or command line, + use an XSLT processor like <emphasis>sablot</emphasis>. For example, if you have an &ay; profile + and want to fillout the hostname via script for any reason (if doing this so often, you want to script it) </para> <para> - First you have to create an XSL file + First, create an XSL file </para> <example> <title>Example file for replacing hostname/domain by script</title> @@ -133,21 +137,22 @@ </screen> </example> <para> - As you can see, this file expects the "hostname" and the "domain" as parameters from the user. + This file expects the "hostname" and the "domain" as parameters from the user. </para> <screen><xsl:param name="hostname"/> <xsl:param name="domain"/></screen> - <para>There will be a "copy" of those parameters in the "dns" section of the control file. That means, - if there already is a domain element in the dns section, you'll get a second one (no good).</para> + <para>There will be a copy of those parameters in the dns section of the control file. That means, + if there already is a domain element in the dns section, you will get a second one (no good).</para> + <remark>mdejmek: why is this no good? please explain</remark> <para> - If you want to create a new autoyast profile now from the template plus the XSL file, run the following command: + If you want to create a new &ay; profile now from the template plus the XSL file, run the following command: </para> <screen>sabcmd add_hostname.xsl \$hostname=myHost \$domain=my.domain template.xml</screen> <para> - You'll get a filled out autoyast profile then on STDOUT. + You will get a filled out &ay; profile then on STDOUT. </para> <para> - If you have multiple XSL files you want to apply to a template, do it like this: + If you have multiple XSL files you want to apply to a template, do the following: </para> <screen> sabcmd add_hd_vg.xsl \$device=/dev/sda \$partition=p2 \$vg=system \ @@ -156,10 +161,10 @@ | sabcmd add_hostname.xsl \$hostname=myHost \$domain=my.domain </screen> <para> - So you just pipe the output of each sabcmd to the next sabcmd. + Pipe the output of each sabcmd to the next sabcmd. </para> <para> - For more information aout XSLT, go to the official webpage <ulink url="http://www.w3.org/TR/xslt">www.w3.org/TR/xslt</ulink> + For more information about XSLT, go to the official Web page <ulink url="http://www.w3.org/TR/xslt">www.w3.org/TR/xslt</ulink> </para> </section> @@ -171,3 +176,4 @@ sgml-parent-document: ("autoyast.xml" "book" "chapter") End: --> + Modified: trunk/autoinstallation/doc/xml/Introduction.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/autoinstallation/doc/xml/Introduction.xml?rev=66617&r1=66616&r2=66617&view=diff ============================================================================== --- trunk/autoinstallation/doc/xml/Introduction.xml (original) +++ trunk/autoinstallation/doc/xml/Introduction.xml Thu Oct 27 12:19:12 2011 @@ -1,26 +1,32 @@ - <chapter id="introduction"> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//Novell//DTD NovDoc XML V1.0//EN" "novdocx.dtd" +[ +<!ENTITY % NOVDOC.DEACTIVATE.IDREF "INCLUDE"> +<!ENTITY % entities SYSTEM "entity-decl.ent"> +%entities; +]> +<chapter id="introduction"> <title>Introduction</title> <para> - &autoyast2; is a system for installing one or more SuSE Linux systems - automatically and without user intervention. &autoyast2; installations - are performed using an autoyast profile with installation and configuration + &ay;2 is a system for installing one or more SUSE Linux systems + automatically and without user intervention. &ay;2; installations + are performed using an &ay; profile with installation and configuration data. That profile can be created using the configuration insterface - of &autoyast2; and can be provided to &yast2; during installation in + of &ay;2; and can be provided to &yast;2 during installation in different ways. </para> <section id="avail"> <title>Availability</title> <para> - &autoyast2; is available with recent &company-suse; products starting - from <emphasis>SuSE Linux 8.0</emphasis> and business products starting from - <emphasis>SLES 8</emphasis>. + &ay;2; is available with recent SUSE products starting + from SUSE Linux 8.0 and business products starting from SLES 8. </para> <para>Products prior to SuSE Linux 8.0 and business products based - on <emphasis>SLES 7</emphasis> have an auto-installation - system based on <emphasis>YaST1</emphasis>. A configuration management - system is provided by <emphasis>ALICE</emphasis> for these products. + on SLES 7 have an auto-installation + system based on Y&yast;1. A configuration management + system is provided by ALICE for these products. </para> <note> <title>Updated documentation</title> @@ -63,7 +69,7 @@ <para> Regular installation of SuSE Linux is semi-automated by default. The user is requested to select the necessary information at the beginning of the - installation (In most cases language only), &yast2; then generates a + installation (In most cases language only), &yast;2 then generates a proposal for the underlying system depending on different factors and system paramters. In most cases, and especially for new systems, such a proposal can be @@ -74,16 +80,16 @@ prompted at the end of the installation to configure hardware and network services. </para> <para> - &autoyast2; can be used where no user intervention is required or - where customization is required. Using an autoyast profile, &yast2; + &ay;2; can be used where no user intervention is required or + where customization is required. Using an &ay; profile, &yast;2 prepares the system for a custom installation and avoids any interaction with the user, unless specified in the file controling the installation. </para> <para> - &autoyast2; is not an automated GUI system. This means that in most + &ay;2; is not an automated GUI system. This means that in most cases many screen will be skipped, i.e. you will never see the language - selection interface. &autoyast2; will simply pass the language + selection interface. &ay;2; will simply pass the language parameter to the sub-system without displaying any language related interface. </para> @@ -93,18 +99,18 @@ <section id="overviewandconcept"> <title>Overview and Concept</title> <para> - Using &autoyast2;, multiple systems sharing the same environment and - similar but not necesserily identical hardware performing similar - tasks can easily be installed in parallel and in a short time. A - configuration file (referred to as "autoyast profile") is created using + Using &ay;2;, multiple systems sharing the same environment and + similar but not necesserily identical hardware and performing similar + tasks, can easily be installed in parallel and quickly. A + configuration file— referred to as "&ay; profile"— is created using existing configuration resources. The profile file can be easily tailored for any specific environment. </para> <para> - Unlike autoinstallation systems available with older &company-suse; - releases, &autoyast2; is fully integrated and provides various options for + Unlike autoinstallation systems available with older SUSE + releases, &ay;2; is fully integrated and provides various options for installing and configuring a system. The main advantage over older systems and other auto-installation systems is the possibility to configure a computer by using existing modules and avoiding using custom scripts which @@ -112,7 +118,7 @@ </para> <para> - This document will guide you through the three steps of auto-installation: + This document will guide you through the three steps of auto-installation: </para> <itemizedlist> <listitem> @@ -120,30 +126,30 @@ Preparation: All relevant information about the target system are collected and turned into the appropriate directives of the profile. The profile file is transferred onto the target system where - its directives will be parsed and transformed to &yast2; conforming + its directives will be parsed and transformed to &yast;2 conforming data. </para> </listitem> <listitem> <para> - Installation: follows the instructions given in the profile and + Installation: Follows the instructions given in the profile and installs the base system. </para> </listitem> <listitem> <para> - Configuration: &yast2; in addition to user-defined post-install - scripts complete the system configuration + Configuration: &yast;2 in addition to user-defined post-install + scripts, complete the system configuration. </para> </listitem> </itemizedlist> <para> - The complete and detailed process is illustrated in the following figure: + The complete and detailed process is illustrated in the following figure: </para> <?anas-pagebreak?> <figure id="process"> <title id="process.title">Auto-installation process</title> - <mediaobject>&autoyast-oview;</mediaobject> + <mediaobject>&ay;-oview;</mediaobject> </figure> </section> @@ -159,3 +165,5 @@ End: --> + + Modified: trunk/autoinstallation/doc/xml/Profile.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/autoinstallation/doc/xml/Profile.xml?rev=66617&r1=66616&r2=66617&view=diff ============================================================================== --- trunk/autoinstallation/doc/xml/Profile.xml (original) +++ trunk/autoinstallation/doc/xml/Profile.xml Thu Oct 27 12:19:12 2011 @@ -1,4 +1,10 @@ - +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//Novell//DTD NovDoc XML V1.0//EN" "novdocx.dtd" +[ +<!ENTITY % NOVDOC.DEACTIVATE.IDREF "INCLUDE"> +<!ENTITY % entities SYSTEM "entity-decl.ent"> +%entities; +]> <chapter id="Profile"> <title>The Control File</title> <para> @@ -9,10 +15,10 @@ </title> <para> - The control file is in most cases a configuration description for a + The control file is in most cases a configuration description for a single system. It consists of sets of resources with properties including support for complex - structures representations such as lists, records, trees and large + structures representations such as lists, records, trees and large embedded or referenced objects. </para> @@ -28,9 +34,9 @@ </para> <para> Using XML, you can eliminate (nearly) all of the configuration - file parsing and error handling - an external XML parser can do that instead - - (especially if it is a validating parser). To make sure the control file is - well-formatted and that the syntax is valid, you can run the control file + file parsing and error handling— an external XML parser can do that instead + (especially if it is a validating parser). To make sure the control file is + well-formatted and the syntax valid, you can run the control file through a validating parser before it is actually used for automatic installation. This is especially required if you prefer to edit the profile manually. @@ -130,8 +136,8 @@ </title> <para> A resource element either contains multiple and distinct property and - resource elements or contains multiple instances of the same resource - element or is empty. The permissible content of a resource element is + resource elements, or multiple instances of the same resource + element, or it is empty. The permissible content of a resource element is specified in the schema files. </para> <para> @@ -141,7 +147,7 @@ </para> <para> An element can be either a container of other elements (a resource) or - have a literal value (a property), it can never be both. This + it has a literal value (a property); it can never be both. This restriction is specified in the schema files. A configuration component with more than one value must either be represented as some kind of embedded list in a property value or as a nested resource. @@ -152,7 +158,7 @@ Nested Resources </title> <para> - Nested resource elements allow a tree like structure of configuration + Nested resource elements allow a tree-like structure of configuration components to be built to any level. </para> <example> @@ -187,17 +193,17 @@ size and mount property. </para> <para> - Although it is specified in the schema files that the partitions resource - contains multiple instances, it is still required to specify this to - avoid wrong data typing in &yast2;. Using the example above, imagine having a - drive with only one partition. This will result in interpreting the - partition resource as a property. To avoid this the following syntax +In the schema files is specified that the partitions resource + contains multiple instances, but it is still required to specify this to + avoid wrong data typing in &yast2;. Using the example above, if having a + drive with only one partition this would result in interpreting the + partition resource as a property. To avoid this, the following syntax must be used when defining multiple instances. For more information - about type attributes, see next section. + about type attributes, see the next section. </para> <example> <title> - Nested Resources with type attributes + Nested Resources with Type Attributes </title> <screen>