Commits

Blaz Zupan committed 3912cba

Updated documentation for the Save widget.

  • Participants
  • Parent commits 575acdb

Comments (0)

Files changed (7)

File Orange/OrangeWidgets/Data/OWSave.py

         button.setSizePolicy(QSizePolicy.Maximum, QSizePolicy.Fixed)
 
         fbox = OWGUI.widgetBox(self.controlArea, "Save")
-        self.save = OWGUI.button(fbox, self, "Save current data", callback = self.saveFile, default=True)
+        self.save = OWGUI.button(fbox, self, "Save", callback = self.saveFile, default=True)
         self.save.setDisabled(1)
         
         OWGUI.rubber(self.controlArea)

File docs/widgets/rst/data/file.rst

 
 .. _my-reference-label:
 
-Section to cross-reference
---------------------------
-
-This is the text of the section.
-
-It refers to the section itself, see :ref:`my-reference-label`.
-
-
 Description
 -----------
 
 File widget reads the input data file (data table with data instances)
 and sends the data set to its output channel. It maintains
-a history of most recently opened files. For convenience, the history also includes
-a directory with the sample data sets that come pre-installed with Orange.
+a history of most recently opened files. For convenience, the history also
+includes a directory with the sample data sets that come
+pre-installed with Orange.
 
 The widget reads data from simple tab-delimited or comma-separated files,
 as well as files in
 
     .. image :: images/spacer.png
 
-Tab-delimited data file can include user defined symbols for undefined values. The symbols for
-"don't care" and "don't know" values can be specified in the corresponding edit lines. 
-The default values for "don't know" and "don't care" depend upon format. Most users will 
-use tab-delimited files: keep the field empty or put a question mark in there and that's 
-it. Most algorithms do not differ between don't know and don't care values, so consider 
-them both to mean undefined.
+Tab-delimited data file can include user defined symbols for undefined
+values. The symbols for "don't care" and "don't know" values can be
+specified in the corresponding edit lines.  The default values for
+"don't know" and "don't care" depend upon format. Most users will use
+tab-delimited files: keep the field empty or put a question mark in
+there and that's it. Most algorithms do not differ between don't know
+and don't care values, so consider them both to mean undefined.
 
-Orange will usually treat the attributes with the same name
-but appearing in different files as the same attribute, so a classifier which uses the 
-attribute "petal length" from the first will use the attribute of the same name from 
-the second. In cases when attributes from different files just accidentally bear different 
-names, one can instruct Orange to either always construct new attribute or construct them when 
-they differ in their domains. Use the options on dealing with new attributes
-with great care (if at all).
+Orange will usually treat the attributes with the same name but
+appearing in different files as the same attribute, so a classifier
+which uses the attribute "petal length" from the first will use the
+attribute of the same name from the second. In cases when attributes
+from different files just accidentally bear different names, one can
+instruct Orange to either always construct new attribute or construct
+them when they differ in their domains. Use the options on dealing
+with new attributes with great care (if at all).
 
 Example
 -------
 
-Most Orange workflows would probably start with the File widget. In the schema below,
-the widget is used to read the data that is sent to both :ref:`Data Table` widget and
-to widget that displays :ref:`Attribute Statistics`.
+Most Orange workflows would probably start with the File widget. In
+the schema below, the widget is used to read the data that is sent to
+both :ref:`Data Table` widget and to widget that displays
+:ref:`Attribute Statistics`.
 
 .. image:: images/File_schema.png
    :alt: Example schema with File widget

File docs/widgets/rst/data/images/Save-Example.png

Old
Old image
New
New image

File docs/widgets/rst/data/images/Save-stamped.png

Added
New image

File docs/widgets/rst/data/images/Save-tags.txt

+0	162	58
+1	274	58
+2	244	127

File docs/widgets/rst/data/images/Save.png

Old
Old image
New
New image

File docs/widgets/rst/data/save.rst

 ====
 
 .. image:: ../../../../Orange/OrangeWidgets/Data/icons/Save.svg
+   :alt: Save widget icon
+   :class: widget-category-data widget-icon
 
 Saves data to a file.
 
 -------
 
 Inputs:
-   - Examples (ExampleTable)
-      Attribute-valued data set.
+   - :obj:`Data`
+        Attribute-valued data set.
 
 Outputs:
    - (None)
 Description
 -----------
 
-.. image:: images/Save.png
+Save widget considers a data set provided on the input channel and
+saves it to a data file with the specified name. The widget remembers
+a history of the most recent file names. It can save into
+tab-delimited and comma-separated files, as well as the C4.5's format
+and Weka's .arrf files.
 
-Takes a data set provided at the input channel and saves it to a
-data file with the specified name. The widget remembers a history of the most recent file names.
-It can save into tab-delimited and comma-separated files, as well as the
-C4.5's format and Weka's .arrf files.
+By design, the widget does not save the data every time it receives a
+new signal on the input as this would constantly (and, mostly,
+inadvertently) overwrite the file. Instead, the data is saved only
+after a new file name is set or the user pushes :obj:`Save` button.
 
-The widget does not save the data every time it receives a new signal on
-the input as this would constantly (and, mostly, inadvertently) overwrite
-the file. Instead the data is saved after a new file name is set or the
-user pushes :obj:`Save current data`.
+.. image:: images/Save-stamped.png
+   :alt: File widget with loaded Iris data set
+   :align: right
+
+.. rst-class:: stamp-list
+
+    1. Selected from the file names and locations from the past
+       saves.
+    #. Specify a new data file to save to.
+    #. Save the data to a chosen data file.
+
+.. container:: clearer
+
+    .. image :: images/spacer.png
+
 
 Example
 -------
 
-The schema below can be used to train the naive Bayesian classifier on the data loaded
-from a file, use the classifier on data from another file and save the misclassified examples
-(or the correctly classified, depending on what we select in the Confusion Matrix) into a file.
+In the workflow below we load the data into a :ref:`Scatter Plot`
+widget, where we select a subset of the data instances and push them
+to Save widget to store them in a data file.
 
 .. image:: images/Save-Example.png
    :alt: Schema with Save widget