Author: emap Date: Fri Nov 4 17:31:40 2011 New Revision: 66709 URL: http://svn.opensuse.org/viewcvs/yast?rev=66709&view=rev Log: edited by emap Modified: trunk/autoinstallation/doc/xml/ASKSection.xml Modified: trunk/autoinstallation/doc/xml/ASKSection.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/autoinstallation/doc/xml/ASKSection.xml?rev=66709&r1=66708&r2=66709&view=diff ============================================================================== --- trunk/autoinstallation/doc/xml/ASKSection.xml (original) +++ trunk/autoinstallation/doc/xml/ASKSection.xml Fri Nov 4 17:31:40 2011 @@ -26,10 +26,10 @@ </para> <para> You have the option to let the user decide the values of specific - parts of the profile during the installation. If you use that feature, - a popup will come up during the installation and will ask the user to - enter a specific part of the profile. So if you want a full auto installation - but you want the user to set the password of the local account, you can do + parts of the profile during the installation. If you use this feature, + a popup will ask the user to + enter a specific part of the profile during installation. If you want a full auto installation, + but the user should set the password of the local account, you can do this via the <emphasis>ask</emphasis> directive in the profile. </para> <para> @@ -51,44 +51,44 @@ <entry>question</entry> <entry><para>The question you want to ask the user.</para> <screen><question>Enter the LDAP server</question></screen></entry> - <entry>The default value is the path to the element (the path often looks strange, so I recommend to enter a question)</entry> + <entry>The default value is the path to the element (the path often looks strange, so we recommend to enter a question)</entry><remark>emap 2011-11-04: not sure I understand this.</remark> </row> <row> <entry>default</entry> - <entry><para>you can set a pre-selection for the user. A textentry will be filled out with this value, - a checkbox will be "true" or "false" and a selection will have this default "value" pre-selected. + <entry><para>Set a pre-selection for the user. A textentry will be filled out with this value. + A checkbox will be "true" or "false" and a selection will have this default "value" pre-selected. </para><screen><default>dc=suse,dc=de</default></screen></entry> - <entry>optional</entry> + <entry>Optional.</entry> </row> <row> <entry>help</entry> <entry><para>An optional helptext that is shown on the left side of the question. </para><screen><help>Enter the LDAP server address.</help></screen></entry> - <entry>optional</entry> + <entry>Optional.</entry> </row> <row> <entry>title</entry> <entry><para>An optional title that is shown above the questions. </para><screen><title>LDAP server</title></screen></entry> - <entry>optional</entry> + <entry>Optional.</entry> </row> <row> <entry>type</entry> - <entry><para>the type of the element you want to change. Possible values are "symbol","boolean","string" and "integer". + <entry><para>The type of the element you want to change. Possible values are "symbol","boolean","string" and "integer". The filesystem in the partition section is a symbol, while the "encrypted" element in the user configuration is a boolean. You can see the type of that element if you look in your profile at the config:type="...." attribute. Since openSUSE 11.2 and SLES11-SP2 you can use "static_text" as type too. A static_text is just a text that does not require any user input and can be used to show information if it's not wanted in the help text. </para><screen><type>symbol</type></screen></entry> - <entry>optional. The defaul is string. If type is "symbol" you must provide the selection element too (see below)</entry> + <entry>Optional. The defaul is string. If type is "symbol", you must provide the selection element too (see below).</entry> </row> <row> <entry>password</entry> - <entry><para>if this boolean is set to "true", a password dialog pops up instead of a simple text entry. Setting this + <entry><para>If this boolean is set to "true", a password dialog pops up instead of a simple text entry. Setting this to "true" makes only sense if "type" is string. </para><screen><password config:type="boolean">true</password></screen></entry> - <entry>optional. The default is "false"</entry> + <entry>Optional. The default is "false".</entry> </row> <row> <entry>path (deprecated since openSUSE 11.0 - use pathlist)</entry> @@ -99,43 +99,43 @@ set the path to "users,0,user_password". The "0" indicates the first user in the <users config:type="list"> list of users in the profile. </para><screen><path>networking,dns,hostname</path></screen></entry> - <entry>this information is optional but you should at least provie <emphasis>path</emphasis> or <emphasis>file</emphasis></entry> + <entry>This information is optional, but you should at least provide <emphasis>path</emphasis> or <emphasis>file</emphasis>.</entry> </row> <row> <entry><para>pathlist (available since openSUSE 11.0 and replaces <emphasis>path</emphasis>)</para></entry> - <entry><para>a list of <emphasis>path</emphasis> elements (see above) + <entry><para>A list of <emphasis>path</emphasis> elements (see above). </para><screen><pathlist config:type="list"><path>networking,dns,hostname</path><path>...</path></screen></entry> - <entry><para>this information is optional but you should at least provie <emphasis>path</emphasis> or <emphasis>file</emphasis></para></entry> + <entry><para>This information is optional but you should at least provide <emphasis>path</emphasis> or <emphasis>file</emphasis>.</para></entry> </row> <row> <entry>file (available since SLES10 SP1 and SL 10.2)</entry> - <entry><para>you can store the answer to a question in a file, to use it in one of your scripts later. If you ask during stage=inital and you want to use the answer in stage2, then you have to copy the answer-file in a chroot script that is running as chrooted=false. Do it like this "cp /tmp/my_answer /mnt/tmp/". The reason for that is, that /tmp in stage1 is just in the RAM disk and will get lost after the reboot but the installed system is already mounted at /mnt/ + <entry><para>You can store the answer to a question in a file, to use it in one of your scripts later. If you ask during stage=inital and you want to use the answer in stage2, then you have to copy the answer-file in a chroot script that is running as chrooted=false. Use the commnad: "cp /tmp/my_answer /mnt/tmp/". The reason is that /tmp in stage1 is just in the RAM disk and will get lost after the reboot, but the installed system is already mounted at /mnt/. </para><screen><file>/tmp/answer_hostname</file></screen></entry> - <entry><para>this information is optional but you should at least provie <emphasis>path</emphasis> or <emphasis>file</emphasis></para></entry> + <entry><para>This information is optional, but you should at least provide <emphasis>path</emphasis> or <emphasis>file</emphasis></para></entry> </row> <row> <entry>password</entry> - <entry><para>if this boolean is set to "true", a password dialog pops up instead of a simple text entry. Setting this + <entry><para>If this boolean is set to "true", a password dialog pops up instead of a simple text entry. Setting this to "true" makes only sense if "type" is string. </para><screen><password config:type="boolean">true</password></screen></entry> - <entry>optional. The default is "false"</entry> + <entry>Optional. The default is "false".</entry> </row> <row> <entry>stage</entry> - <entry><para>stage configures the installation stage where the question pops up. You can set this value to "cont" or - "initial". "initial" means the popup comes up very early in the installation, short after the pre-script - has run. "cont" means, that the dialog with the question comes after the first reboot, when the system + <entry><para>Stage configures the installation stage in which the question pops up. You can set this value to "cont" or + "initial". "initial" means the popup comes up very early in the installation, shortly after the pre-script + has run. "cont" means, that the dialog with the question comes after the first reboot when the system boots for the very first time. Questions you answer during the "inital" stage, will write their answer into the profile on the harddisk. You should know that if you enter cleartext passwords during "initial". - Of course it does not make sense to ask for a filesystem to use in the "cont" phase. The harddisk is already + Of course it does not make sense to ask for the filesystem to use during the "cont" phase. The harddisk is already partitioned at that stage and the question will have no effect. </para><screen><stage>cont</stage></screen></entry> - <entry>optional. The default is "initial"</entry> + <entry>Optional. The default is "initial".</entry> </row> <row> <entry>selection</entry> - <entry><para>the selection element contains a list of <entry> elements. Each entry represents a possible option - for the user to choose. So the user can't enter a value in a textfield, but he can choose from a list + <entry><para>The selection element contains a list of <entry> elements. Each entry represents a possible option + for the user to choose. The user cannot enter a value in a textfield, but he can choose from a list of values. </para><screen> <selection config:type="list"> @@ -156,59 +156,58 @@ </label> </entry> </selection></screen></entry> - <entry>optional for type=string, not possible for type=boolean and a must have for type=symbol</entry> + <entry>Optional for type=string, not possible for type=boolean and mandatory for type=symbol.</entry> </row> <row> <entry>dialog (available since SL 10.3 and SLES10 SP2)</entry> - <entry><para>Since OpenSUSE 10.3 you can have more than one question per dialog. To make that possible you have - to specifiy the dialog-id with an integer. All questions with the same dialog-id are on the same dialog. + <entry><para>Since OpenSUSE 10.3, you can ask more than one question per dialog. To do so, specifiy the dialog-id with an integer. All questions with the same dialog-id belong to the same dialog. The dialogs are sorted by the id too. </para><screen><dialog config:type="integer">3</dialog></screen></entry> - <entry>optional</entry> + <entry>Optional.</entry> </row> <row> <entry>element (available since SL 10.3 and SLES10 SP2)</entry> - <entry><para>Since OpenSUSE 10.3 you can have more than one question per dialog. To make that possible you have - to specifiy the element-id with an integer. The questions on a dialog are sorted by the id. + <entry><para>Since OpenSUSE 10.3, you can have more than one question per dialog. To make that possible you have + to specifiy the element-id with an integer. The questions in a dialog are sorted by id. </para><screen><element config:type="integer">1</element></screen></entry> - <entry>optional (see dialog></entry> + <entry>Optional (see dialog>.</entry> </row> <row> <entry>frametitle (available since SL 10.3 and SLES10 SP2)</entry> - <entry><para>Since OpenSUSE 10.3 you can have more than one question per dialog. Each question on a dialog has - a frame that can have a frametitle. A small caption for each question if you want so. Since openSUSE 11.3 you can put multiple elements into one frame. They have to have the same frametitle then. + <entry><para>Since OpenSUSE 10.3, you can have more than one question per dialog. Each question on a dialog has + a frame that can have a frame title, a small caption for each question. Since openSUSE 11.3, you can put multiple elements into one frame. They have to have the same frame title. </para><screen><frametitle>User data</frametitle></screen></entry> - <entry>optional (default is no frametitle)</entry> + <entry>Optional. Default is no frame title.</entry> </row> <row> - <entry>script (available since SL 10.3 not in SLES10 SP1)</entry> - <entry><para>with 10.3 you can run scripts after a question has been answered (see the table below for detailed instructions about scripts) + <entry>script (available since SL 10.3, not in SLES10 SP1)</entry> + <entry><para>Since 10.3, you can run scripts after a question has been answered (see the table below for detailed instructions about scripts). </para><screen><script>...</script></screen></entry> <entry>optional (default is no script)</entry> </row> <row> - <entry>ok_label (available since openSUSE 11.2 / SLES11 SP2</entry> - <entry><para>You can change the Label on the "Ok" button. The last element that specifies the label for a dialog wins. + <entry>ok_label (available since openSUSE 11.2 and SLES11 SP2</entry> + <entry><para>You can change the label on the "Ok" button. The last element that specifies the label for a dialog wins. </para><screen><ok_label>Finish</ok_label></screen></entry> - <entry>optional</entry> + <entry>Optional.</entry> </row> <row> - <entry>back_label (available since openSUSE 11.2 / SLES11 SP2</entry> - <entry><para>You can change the Label on the "Back" button. The last element that specifies the label for a dialog wins. + <entry>back_label (available since openSUSE 11.2 and SLES11 SP2</entry> + <entry><para>You can change the label on the "Back" button. The last element that specifies the label for a dialog wins. </para><screen><back_label>change values</back_label></screen></entry> - <entry>optional</entry> + <entry>Optional.</entry> </row> <row> - <entry>timeout (available since openSUSE 11.2 / SLES11-SP2</entry> - <entry><para>You can specify an integer here that is used as timeout in seconds. If the user does not answer the question before the timeout, the default value is taken as answer. When the user touches/changes any widget in the dialog, the timeout is turned off and the dialog has to be confirmed by the ok-button. + <entry>timeout (available since openSUSE 11.2 and SLES11-SP2</entry> + <entry><para>You can specify an integer here that is used as timeout in seconds. If the user does not answer the question before the timeout, the default value is taken as answer. When the user touches or changes any widget in the dialog, the timeout is turned off and the dialog has to be confirmed via the ok-button. </para><screen><timeout config:type="integer">30</timeout></screen></entry> - <entry>optional. A missing value is interpreted as 0 which means that there is no timeout</entry> + <entry>Optional. A missing value is interpreted as 0, which means that there is no timeout.</entry> </row> <row> - <entry>default_value_script (available since openSUSE 11.2 / SLES11-SP2)</entry> - <entry><para>you can run scripts to set the default value for a question(see the table below for detailed instructions about default value scripts). It's useful if you can "calculate" a useful default value, especially in combination with the "timeout" option. + <entry>default_value_script (available since openSUSE 11.2 and SLES11-SP2)</entry> + <entry><para>You can run scripts to set the default value for a question (see the table below for detailed instructions about default value scripts). This feature is useful if you can "calculate" a useful default value, especially in combination with the "timeout" option. </para><screen><default_value_script>...</default_value_script></screen></entry> - <entry>optional (default is no script)</entry> + <entry>Optional. Default is no script.</entry> </row> </tbody> </tgroup> @@ -216,7 +215,7 @@ </table> <para> - The following elements must be between the <ask-list config:type="list"><ask><default_value_script>...</default_value_script>...</ask></ask-list> tags in the <general> section. It's available since 11.2 and SLES11-SP2 + The following elements must be between the <ask-list config:type="list"><ask><default_value_script>...</default_value_script>...</ask></ask-list> tags in the <general> section. This is available since 11.2 and SLES11-SP2. </para> <table frame='top'> <title>XML representation</title> @@ -231,15 +230,15 @@ <tbody> <row> <entry>source</entry> - <entry><para>the source code of the script. Whatever you echo to STDOUT will be used as default value for the ask-dialog. If your script has an exit code other than 0, the normal default element is used. Take care you echo with "echo -n" to suppress the '\n' and that you echo reasonable values and not "okay" for a boolean + <entry><para>The source code of the script. Whatever you <command>echo</command> to STDOUT will be used as default value for the ask-dialog. If your script has an exit code other than 0, the normal default element is used. Take care you use <command>echo -n</command> to suppress the <literal>\n</literal> and that you echo reasonable values and not "okay" for a boolean </para><screen><source>...</source></screen></entry> - <entry>this value is required. Otherwise nothing would be executed</entry> + <entry>This value is required, otherwise nothing would be executed.</entry> </row> <row> <entry>interpreter</entry> - <entry><para>the interpreter to use + <entry><para>The interpreter to use. </para><screen><interpreter>perl</interpreter></screen></entry> - <entry>default is shell (you can set "/bin/myinterpreter" as value too)</entry> + <entry>The default is shell. You can also set "/bin/myinterpreter" as value.</entry> </row> </tbody> </tgroup> @@ -247,7 +246,7 @@ <para> - The following elements must be between the <ask-list config:type="list"><ask><script>...</script>...</ask></ask-list> tags in the <general> section. It's available since 10.3 (not SLES10 SP1). + The following elements must be between the <ask-list config:type="list"><ask><script>...</script>...</ask></ask-list> tags in the <general> section. Available since 10.3 (not SLES10 SP1). </para> <table frame='top'> <title>XML representation</title> @@ -262,39 +261,39 @@ <tbody> <row> <entry>filename</entry> - <entry><para>the filename of the script + <entry><para>The filename of the script. </para><screen><filename>my_ask_script.sh</filename></screen></entry> - <entry>default is ask_script.sh</entry> + <entry>The default is ask_script.sh</entry> </row> <row> <entry>source</entry> - <entry><para>the source code of the script. Together with "rerun_on_error" on you check the value that was entered for sanity (since 11.0 only). Your script can create a file "/tmp/next_dialog" with a dialog id in it. That's the next dialog autoyast will raise then. A value of -1 terminates the ask sequence. If that file is not created, autoyast will run the dialogs in a normal order (since 11.0 only) + <entry><para>The source code of the script. Together with "rerun_on_error" activated, you check the value that was entered for sanity (since 11.0 only). Your script can create a file "/tmp/next_dialog" with a dialog id specifying the next dialog &ay; will raise. A value of -1 terminates the ask sequence. If that file is not created, &ay; will run the dialogs in the normal order (since 11.0 only). </para><screen><source>...</source></screen></entry> - <entry>this value is required. Otherwise nothing would be executed</entry> + <entry>This value is required, otherwise nothing would be executed.</entry> </row> <row> <entry>environment</entry> - <entry><para>a boolean that passes the "value" of the answer to the question as an environment variable to the script. The variable is named "VAL". + <entry><para>A boolean that passes the "value" of the answer to the question as an environment variable to the script. The variable is named "VAL". </para><screen><environment config:type="boolean">true</environment></screen></entry> - <entry>optional (default is "false").</entry> + <entry>Optional. Default is "false".</entry> </row> <row> <entry>feedback</entry> - <entry><para>a boolean that turns on feedback for the script execution. That means that STDOUT will be shown in a popup box that must be confirmed after the script execution. + <entry><para>A boolean that turns on feedback for the script execution. STDOUT will be displayed in a popup window that must be confirmed after the script execution. </para><screen><feedback config:type="boolean">true</feedback></screen></entry> - <entry>optional (default is "false").</entry> + <entry>Optional, default is "false".</entry> </row> <row> <entry>debug</entry> - <entry><para>a boolean that turns on debugging for the script execution + <entry><para>A boolean that turns on debugging for the script execution. </para><screen><debug config:type="boolean">true</debug></screen></entry> - <entry>optional (default is "true"). This value needs feedback to be turned on too.</entry> + <entry>Optional, default is "true". This value needs "feedback" to be turned on too.</entry> </row> <row> <entry>rerun_on_error (available since openSUSE 11.0)</entry> - <entry><para>a boolean that keeps the dialog open until the script has an exit code of 0 (zero). So you can parse and check the answers the user gave in the script and popup an error with the "feedback" option. + <entry><para>A boolean that keeps the dialog open until the script has an exit code of 0 (zero). So you can parse and check the answers the user gave in the script and display an error with the "feedback" option. </para><screen><rerun_on_error config:type="boolean">true</rerun_on_error></screen></entry> - <entry>optional (default is "false"). This value should be used together with the feedback option.</entry> + <entry>Optional, default is "false". This value should be used together with the feedback option.</entry> </row> </tbody> </tgroup> @@ -371,7 +370,7 @@ </screen> <para> -The following example is a nice way to choose between autoyast profiles. Autoyast will read the "modified.xml" file again after the ask-dialogs are done. So we can fetch a complete new profile. +The following example is a nice way to choose between &ay; profiles. &ay; will read the <filename>modified.xml</filename> file again after the ask-dialogs are done. This way you can fetch a complete new profile. </para> <screen> @@ -407,7 +406,7 @@ </ask> </screen> <para> -Since openSUSE 11.0 you can verify the answer of a question with a script like this: +Since openSUSE 11.0, you can verify the answer of a question with a script like this: </para> <screen> -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org