home *** CD-ROM | disk | FTP | other *** search
/ Freelog 65 / Freelog065.iso / BAS / Bureautique / Gnumeric / gnumeric-1.3.92-rc1.exe / files-textsave.xml < prev    next >
Encoding:
Text File  |  2004-11-01  |  13.1 KB  |  459 lines
  1. <sect1 id="sect-file-textExport">
  2.   <title>Exporting Text Files</title>
  3.  
  4. <!-- TODO: Rewrite this sucker! Use the new screenshots. -->
  5.  
  6.   <para>
  7.     &gnum; can export worksheets to text files using some kind of data
  8.     structuring mechanism. Creating a text file requires, first, using
  9.     the <interface>Save As</interface> dialog to name the file,
  10.     select a folder in which to save it, and choose the file format
  11.     "Text export (configurable)", then, using the <interface>Text
  12.     Export</interface> druid to configure the characteristics of the
  13.     file structure. 
  14.   </para>
  15.  
  16.   <para>
  17.  
  18.  
  19.  
  20. files or file fragments that consist entirely of
  21.     text. Text files provide a basic, common format enabling programs
  22.     to share data.
  23.   </para>
  24.  
  25.   <para>
  26.     The <interface>Text Export</interface> Druid consists of two
  27.     panels. 
  28.  
  29.     The first panel...
  30.  
  31.     The second panel
  32.  
  33.   </para>
  34.  
  35.  
  36.   <tip>
  37.     <title>The steps involved in the text export druid.</title>
  38.  
  39.     <para></para>
  40. <!-- TODO: render hack- remove this spacing hack  -->
  41.  
  42.     <orderedlist>
  43.       <listitem>
  44.         <para>
  45.       Launch the  <interface>Text export</interface> druid using,
  46.       in the <guimenu>File</guimenu>, the
  47.       <guimenuitem>Save As</guimenuitem> and selecting the "Text export
  48.       (configurable)" file format type.
  49.     </para>
  50.       </listitem>
  51.       <listitem>
  52.         <para>
  53.       Select the worksheets to include in the exported file.
  54.     </para>
  55.       </listitem>
  56.       <listitem>
  57.         <para>
  58.       Configure the order of the worksheets for the exported file.
  59.     </para>
  60.       </listitem>
  61.       <listitem>
  62.         <para>
  63.       Go to the second panel.
  64.     </para>
  65.       </listitem>
  66.       <listitem>
  67.         <para>
  68.       Select the line termination character.
  69.     </para>
  70.       </listitem>
  71.       <listitem>
  72.         <para>
  73.       Select the value separating character or character sequence
  74.     </para>
  75.       </listitem>
  76.       <listitem>
  77.         <para>
  78.       Select when values should be surrounded by a text indicating character.
  79.     </para>
  80.       </listitem>
  81.       <listitem>
  82.         <para>
  83.       Select the character or sequence to use to indicate a text field.
  84.     </para>
  85.       </listitem>
  86.       <listitem>
  87.         <para>
  88.       Configure the character encoding to use for the file.
  89.     </para>
  90.       </listitem>
  91.       <listitem>
  92.         <para>
  93.       Select how to handle unknown characters.
  94.     </para>
  95.       </listitem>
  96.        <listitem>
  97.         <para>
  98.       Select whether to preserve the format of the cell contents.
  99.     </para>
  100.       </listitem>
  101.       <listitem>
  102.         <para>
  103.       Click on the <guibutton>Finish</guibutton> button to export
  104.       the file.
  105.     </para>
  106.       </listitem>
  107.     </orderedlist>
  108.  
  109.   </tip>
  110.  
  111.  
  112.   <sect2 id="note-file-textExport-druid">
  113.     <title>
  114.       The Components of the <interface>Text Export</interface> Druid
  115.     </title>
  116.  
  117.     <para>
  118.       The <interface>Text Export</interface> druid consists of two
  119.       panels. The first panel allows the user to select the worksheets
  120.       included in the export and their order. The second panel allows
  121.       the user to configure the structuring elements, the line
  122.       delimiting characters, value separating characters, text indicating
  123.       characters, and file encoding. 
  124.     </para>
  125.  
  126.     <sect3 id="sect-file-textExport-druid-panel1">
  127.       <title>
  128.         The first panel of the <interface>Text Export</interface> Druid.
  129.       </title>
  130.  
  131.       <para>
  132.         The first panel of the <interface>Text Export</interface>
  133.         Druid allows users to set the file encoding, to determine the
  134.         character sequences used to separate lines, configure the type
  135.         of structuring being used and select the lines of the file to
  136.         import.
  137.       </para>
  138.  
  139.       <figure id="fig-file-textExport-druid-panel1">
  140.         <title>
  141.       The first panel of the <interface>Text Import</interface>
  142.       druid with the component areas labeled with callouts.
  143.     </title>
  144.     <screenshot>
  145.           <mediaobject> 
  146.         <imageobject> 
  147.           <imagedata fileref="figures/textguru-export-panel1-withTags.png"
  148.                      format="PNG" />
  149.         </imageobject>
  150.         <textobject>
  151.           <para> 
  152.             This screenshot depicts the first panel 'Text Export'
  153.             druid with callouts labeling the different areas.
  154.           </para>
  155.         </textobject>
  156.         <caption>
  157.               <para>
  158.             The different components of the first panel of the
  159.             <interface>Text Export</interface> druid with each component
  160.             labeled with a callout.
  161.               </para>
  162.         </caption>
  163.       </mediaobject>
  164.     </screenshot>
  165.       </figure>
  166.  
  167.       <para>
  168.         The purpose of each labeled component in <xref
  169.         linkend="fig-file-textExport-druid-panel1" /> is
  170.         explained below:
  171.  
  172.     <variablelist>
  173.       <title>The components of the first panel</title>
  174.  
  175.       <varlistentry>
  176.         <term>
  177.           <emphasis role="bold">1</emphasis> - The worksheet
  178.           selection area.
  179.         </term>
  180.         <listitem>
  181.           <para>
  182.             This area allows the user to select the worksheets to
  183.           be included in the file. By default, only the top most
  184.           sheet will have its checkbox checked and be included in
  185.           the export. The user can add sheets by clicking in their
  186.           checkboxes to set the check marks.
  187.           </para>
  188.         </listitem>
  189.           </varlistentry>
  190.  
  191.       <varlistentry>
  192.         <term>
  193.           <emphasis role="bold">2</emphasis> - The worksheet
  194.           selection and ordering buttons.
  195.         </term>
  196.         <listitem>
  197.           <para>
  198.             The top two buttons allows the user quickly to select
  199.             or unselect all the worksheets to be included in the
  200.             export file. The bottom two buttons allow the user to
  201.             change the order of the worksheets in the file to be
  202.             exported.
  203.           </para>
  204.         </listitem>
  205.           </varlistentry>
  206.  
  207.        <varlistentry>
  208.         <term>
  209.           <emphasis role="bold">3</emphasis> - The button area.
  210.         </term>
  211.         <listitem>
  212.           <para>
  213.             These three buttons allow the user to navigate the
  214.             druid. 
  215. <!-- TODO: bug- text export needs a help button. -->
  216. <!--
  217.                 The <guibutton>Help</guibutton> button should
  218.             open the &gnum; manual to this section.
  219. -->
  220.                  The <guibutton>Cancel</guibutton> button will dismiss
  221.             the dialog and return the user to the worksheet. The
  222.             <guibutton>Back</guibutton> button is disable since
  223.             this is the first panel of the druid. The
  224.             <guibutton>Forward</guibutton> button will dismiss the
  225.             first panel and bring up the second panel of the druid.
  226.           </para>
  227.         </listitem>
  228.           </varlistentry>
  229.  
  230.        </variablelist>
  231.  
  232.       </para>
  233.  
  234.     </sect3>
  235.  
  236.      <sect3 id="sect-file-textExport-druid-panel2">
  237.       <title>
  238.         The second panel of the <interface>Text Export</interface> Druid.
  239.       </title>
  240.  
  241.       <para>
  242.         The second panel of the <interface>Text Export</interface>
  243.         Druid allows users to select the line termination character,
  244.         configure the value separating character, select the text
  245.         indicating character and set the character encoding.
  246.       </para>
  247.  
  248.       <figure id="fig-file-textExport-druid-panel2">
  249.         <title>
  250.       The second panel of the <interface>Text Import</interface>
  251.       druid with the component areas labeled with callouts.
  252.     </title>
  253.     <screenshot>
  254.           <mediaobject> 
  255.         <imageobject> 
  256.           <imagedata fileref="figures/textguru-export-panel2-withTags.png"                     format="PNG" />
  257.         </imageobject>
  258.         <textobject>
  259.           <para> 
  260.             This screenshot depicts the second panel 'Text Export'
  261.             druid with callouts labeling the different areas.
  262.           </para>
  263.         </textobject>
  264.         <caption>
  265.               <para>
  266.             The different components of the second panel of the
  267.             <interface>Text Export</interface> druid with each component
  268.             labeled with a callout.
  269.               </para>
  270.         </caption>
  271.       </mediaobject>
  272.     </screenshot>
  273.       </figure>
  274.  
  275.  
  276.       <para>
  277.         The purpose of each labeled component in <xref
  278.         linkend="fig-file-textExport-druid-panel2" /> is
  279.         explained below:
  280.  
  281.  
  282.     <variablelist>
  283.       <title>The components of the second panel</title>
  284.  
  285.       <varlistentry>
  286.         <term>
  287.           <emphasis role="bold">1</emphasis> - The export
  288.         characteristic menu buttons.
  289.         </term>
  290.         <listitem>
  291.           <para>
  292.             These drop down menus provide to set the different
  293.             configuration parameters for the exported file. The
  294.             various menus are as follows.
  295.         <itemizedlist>
  296.           <listitem>
  297.             <para>
  298.               Line Delimiting Character-
  299.             </para>
  300.             <para>
  301.               This button allows the user to activate a drop
  302.                   down list from which to select the character
  303.                   used to indicate the end of a line and beginning
  304.                   of the next. The three commonly used
  305.                   alternatives are provided. See <xref
  306.                   linkend="sect-file-textImport-complex-lineBreak"
  307.                   /> for more details.
  308.             </para>
  309.           </listitem>
  310.           <listitem>
  311.             <para>
  312.               Value Separating Character-
  313.             </para>
  314.             <para>
  315.               This button allows the user to select a character
  316.                   to use as a line separator. The "Custom" type
  317.                   will active the text entry area to allow the
  318.                   user to determine a particular character or
  319.                   character sequence to use to delimit data
  320.                   values. See <xref
  321.                   linkend="sect-file-textImport-complex-dataStruct"
  322.                   /> for more details.
  323.             </para>
  324.           </listitem>
  325.           <listitem>
  326.             <para>
  327.               Value Separating Character entry area-
  328.             </para>
  329.             <para>
  330.               This entry area allows the user to define
  331.                   explicitly the character or character sequence
  332.                   which should be used to separate each value field
  333.                   on every line. This area is only active if the
  334.                   "Custom" type has been selected from the list in
  335.                   the button above.
  336.             </para>
  337.           </listitem>
  338.           <listitem>
  339.             <para>
  340.               The Text Field Delimiter activity setting-
  341.             </para>
  342. <!-- TODO: ask- why does space require quotes in a csv file? -->
  343.             <para>
  344.               This button activates a list with three choices
  345.                   for the use of text field delimiters. Text
  346.                   fields can be delimited only where needed,
  347.                   meaning that the quote characters will only be
  348.                   used if the value contains the character used as
  349.                   a separator or a space. Alternatively the text
  350.                   field separators can be used around all values
  351.                   or never applied. See <xref
  352.                   linkend="sect-file-textImport-complex-dataStruct"
  353.                   /> for more details.
  354.             </para>
  355.           </listitem>
  356.           <listitem>
  357.             <para>
  358.               The Text Field Delimiter character entry area and list-
  359.             </para>
  360.             <para>
  361.               This area can be used as a text entry area to
  362.                   type the character to use to delimit text
  363.                   fields. Alternatively, three pre-selected
  364.                   characters, double quotes or single quotes, can
  365.                   be selected from the drop down list which
  366.                   appears by clicking on the downward pointing
  367.                   arrow to the right of the text field.
  368.             </para>
  369.           </listitem>
  370.           <listitem>
  371.             <para>
  372.               File encoding selection button-
  373.             </para>
  374.             <para>
  375.               This button allows the user to set the encoding
  376.                   scheme to use for the file.  By default, &gnum;
  377.                   selects the encoding scheme used by the locale
  378.                   of the user.  See <xref
  379.                   linkend="sect-file-textImport-complex-encoding"
  380.                   /> for more details.
  381.             </para>
  382.           </listitem>
  383. <!-- TODO: ask- how is this supposed to work? -->
  384.           <listitem>
  385.             <para>
  386.               The unknown character handling setting button-
  387.             </para>
  388.             <para>
  389.               This button selects whether to escape or
  390.                   transliterate characters which &gnum; does not
  391.                   recognize.
  392.             </para>
  393.           </listitem>
  394. <!-- TODO: ask- is this really what this does? -->
  395.           <listitem>
  396.             <para>
  397.               The format preservation checkbox-
  398.             </para>
  399.             <para>
  400.               This checkbox sets whether to preserve the
  401.                   number formats for formatted values.
  402.             </para>
  403.           </listitem>
  404.         </itemizedlist>.
  405.           </para>
  406.         </listitem>
  407.           </varlistentry>
  408.  
  409.       <varlistentry>
  410.         <term>
  411.           <emphasis role="bold">2</emphasis> - The button area.
  412.         </term>
  413.         <listitem>
  414.           <para>
  415.             These three buttons allow the user to navigate the
  416.             druid. 
  417. <!-- TODO: bug- text export needs a help button. -->
  418. <!--
  419.                 The <guibutton>Help</guibutton> button should
  420.             open the &gnum; manual to this section.
  421. -->
  422.                 The <guibutton>Cancel</guibutton> button will dismiss
  423.             the dialog and return the user to the worksheet. The
  424.             <guibutton>Back</guibutton> button is disable since
  425.             this is the first panel of the druid. The
  426.             <guibutton>Finish</guibutton> button will dismiss the
  427.             druid and cause the file to be saved using the
  428.             selected options.
  429.           </para>
  430.         </listitem>
  431.           </varlistentry>
  432.  
  433.  
  434.  
  435.         </variablelist>
  436.  
  437.       </para>
  438.  
  439.     </sect3>
  440.  
  441.   </sect2>
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458. </sect1>
  459.