lib/ctioga2/data/backends/backends/text.rb in ctioga2-0.3 vs lib/ctioga2/data/backends/backends/text.rb in ctioga2-0.4
- old
+ new
@@ -23,11 +23,11 @@
# For separated sets
require 'stringio'
module CTioga2
- Version::register_svn_info('$Revision$', '$Date$')
+ Version::register_svn_info('$Revision: 372 $', '$Date: 2012-12-28 18:13:15 +0100 (Fri, 28 Dec 2012) $')
module Data
# A module for easy use of NaN in operations
@@ -54,10 +54,20 @@
include Dobjects
describe 'text', 'Text format', <<EOD
This backend reads text files in a format close to the one understood
-by gnuplot and the like.
+by gnuplot and the like. More specifically, it reads text files organized
+in columns.
+
+The column separator is specified by the @separator@ option or using
+the {command: text-separator} command; it is a {type: regexp}
+
+By default, the {command: text} backend only loads the column 1 as X
+and 2 as Y, but that can be changed either by specifiying a default
+column spec using either the @default_column_spec@ option or by adding
+a specification directly after the file name.
+
EOD
# Inherit the baseline handling, can be useful !
# inherit_parameters :base_line