html2index 1.2.1

data/doc/rst/html2index.rst

@@ -0,0 +1,265 @@
+==========================
+HTML2Index
+==========================
+--------------------------------------------------------------------
+  Creates an index or glossary of marked expressions in an HTML-file
+--------------------------------------------------------------------
+
+SYNOPSIS
+=========
+   **html2index -s input.html [-o output.html] [-t template.html] [-c config] [-d]**
+
+   **html2index -v**
+   
+   **html2index -h**
+
+DESCRIPTION
+============
+
+The program identifies in an HTML source all expressions which need to be copied
+to the generated index and searches given dictionaries on the Web for an
+explanation of each expression.
+
+The resulting glossary is written to a new HTML-file or its HTML-code printed to STDOUT.
+
+**NOTE**: The default dictionaries are French: Larousse and JargonF. Non-French speakers MUST define the dictionary by editing the configuration file ~/.config/HTML2Index/config as described under Configuration below.
+
+OPTIONS
+============================
+
+:-d, --debug:                    Be verbose
+
+:-s, --source=SOURCE:            Source is the the original html-file
+                                 which contains marked expressions (see
+                                 **Preparations**, below).
+
+:-o, --out=GLOSSARY:             Glossary is the generated file in HTML-format.
+
+:-t,  --template=TEMPLATE:        A html file containing placeholders for the references to the dictionaries used and
+                                 the generated glossary. The placeholders are
+                                 currently defined as %=dict_list=% and
+                                 %=glossary=%.  You can set different
+                                 field-delimiters and names in the
+                                 configuration-file. See below under
+                                 *EXAMPLE-Template* for a rudimentary example.
+
+:-c,  --config=CONFIG:            Configuration-file. Command-line arguments override the settings in this file. You find a functional
+                                 configuration after the first program-execution in *~/.config/HTML2Index*. The file is commented and
+                                 can immediately be adapted to your needs.
+
+Common Options
+----------------
+
+**-h, --help**                       Show this message
+
+**-v, --version**                    Show program version
+
+EXAMPLE Usage
+============================
+
+Here is a html-page containing instructions on how to enable and disable a
+touchpad using the xinput command (or any other HTML-file) in the French (or
+any other) language. 
+
+**touchpad_fr.html**
+
+Execution
+--------------------
+
+Executing HTML2Index with the -s argument and the HTML-file as its value, like this:
+
+::
+
+   :~$ html2index -s /[path]/touchpad_fr.html 
+
+will produce output like this with expressions from the HTML-file explained in
+the French language :
+
+::
+
+  vi
+    (JargonF): 1.   [Unix]. « Visual Interface » (littéralement, « interface
+    visuelle », ça ne s'invente pas !) éditeur de texte du pléistocène codé par
+    Bill Joy, aussi fondateur de Sun.  Des aficionados d'Unix s'en servent
+    encore, même s'il est très concurrencé par Emacs. Son principal avantage
+    est que quel que soit l'état de votre système (par exemple complètement
+    déglingué ou allégé) il a de fortes chances de fonctionner encore
+    correctement.
+    La version la plus répandue est vim.
+
+    2.   [nom de domaine]. Nom de domaine de premier niveau des îles Vierges étasuniennes.
+  ------------------------------------------------------------
+  xinput
+   (JargonF): commande.  [X11] Utilitaire facilitant la gestion des
+   périphériques X Window d'entrée.  Il peut en fournir la liste, détailler
+   leurs propriétés et modifier celles qui peuvent l'être.
+   http://www.souris-libre.fr/savoir_faire/touchpad/touchpad_fr.html Exemple
+   d'utilisation: désactivation et activation rapide du pavé tactile.
+
+If you name an output file with the -o option, html2index will direct its
+output in HTML-format to this file.
+
+Preparations
+-------------------------
+
+...................
+  Mark catchwords
+...................
+
+In the source-code of the original HTML- page, expressions for the future
+glossary are marked by means of 
+
+* a tag
+* an attribute of this tag 
+* the value of the attribute.
+
+By default, the *span*-tag with an attribute *lang="fy"* is used, 'fy' meaning
+Frisian, a language which is rarely used on the Web.., I venture.
+
+
+*Example*:
+::
+
+<span lang="fy" xml:lang="fy">pavé tactile</span>
+
+You can, though, define your own tag, attribute and attribute-value, if you prefer
+to mark expressions in your original html-file differently, like in
+
+*Example*:
+::
+
+<em class="expression">Tripane</em>
+
+Remember that you can combine css classes and thus economize on html-elements, if 
+you use them anyway to style your html-content. This would complicate the task for
+html2index only a little bit, as we will see further below. 
+
+.....................
+  Configuration
+.....................
+
+Apart from the way that expressions are marked in the original html, you can prepare
+a few settings for HTML2Index, which influence its behaviour. Command-line
+options override the values stored in the configuration-file.
+
+A default configuration will be stored in the file *~/.config/HTML2Index/config* the
+first time that you run html2index. It should be sufficiently commented to allow you
+to comprehend and alter any values in the file.
+
+However, an explanation of each one of the available variables follows:
+
+:debug:           Does the same as the command-line options '-d' or '--debug'.
+                  Accepts the values false or true or can be left empty.
+                  If set to true, this setting causes html2index to be very verbose.
+                  Usually, you do not need to change the default value to this
+                  variable, which is *false*.
+
+:dictionaries:    Here, you **HAVE** to define the online-dictionaries to
+                  consult, if you do not want to stick with the defaults, which are
+                  Larousse and JargonF, two French speaking sites, which also provide
+                  explanations in the French language only.
+
+                  The dictionaries are defined with four variables, each: *name, url, xpath, color*.
+                  Each dictionary-definition must start with a dash, followed by a white-space, then the
+                  first variable. Each variable-name must be enclosed by colons (see comments in the config-file).
+
+                  :name:  The name of the dictionary, how it will be referred to in the Glossary. An example could be 'Meriam-Webster'
+
+                  :url:   Note here the part from the url to a search-result in
+                          the chosen dictionary, which precedes the searched
+                          expression. You determine this string by doing a
+                          search in the online-dictionary, then copy&paste the
+                          url as it is displayed in your browser. Rearrange
+                          possible request-parameters (following '?') to ensure
+                          that the searched word or expression is the very last
+                          item in the url.  Remove only the searched expression
+                          and note the remainder as the value to the variable
+                          *url*.
+
+                  :xpath: This is the xpath which identifies the HTML-element
+                          in a search-result which contains the explanation of
+                          an expression. Many resources on the Web explain how
+                          to compose an xpath. Be as specific as possible, to
+                          avoid a miss-interpretation of the xpath-expression,
+                          use html-attributes which may be applied to an HTML
+                          container-tag.  Especially *id*, if present but also
+                          css-classes can help to identify a tag unambiguously.
+                   
+                  :color: A hexadecimal rgb color value in single quotes is
+                          attributed to each dictionary to facilitate the
+                          identification of the dictionary which provides a
+                          specific explanation in the glossary. Exemplary
+                          colors are *'800000'* or *'500050'*. Take care to
+                          choose colors which harmonize with the background in
+                          your template-file, if you use one.
+
+:template:  An HTML-file which contains placeholders. Two placeholders are needed
+            at the time of this writing, one to name the dictionaries which are
+            used to look-up definitions, another one to locate the spot where
+            the new glossary will be written. See below under *EXAMPLE-Template*
+            for a rudimentary example. The default template is internally defined.
+
+:fdelim:    A character sequence which is used to mark placeholders in the
+            HTML-template file. The default is '*%-*', meaning that a
+            percent-symbol followed by a dash marks the beginning, a dash
+            followed by a percent-symbol the end of a placeholder, like in
+            **%-dict-list-%** for the placeholder named 'dict-list'.
+
+:placeholders:  A list of placeholder names. Currently, there are only two
+                placeholders recognized by Html2Index: *dict_list* and
+                *glossary*. As the value to these two variables, note the name
+                that you chose for the placeholders in your HTML-template. The
+                defaults are *dict_list* for *dict_list* and *index* for
+                *glossary*.
+
+:html_tag: This is the tag which encloses marked expressions in the original
+           HTML-page (the source-file). Default is *span*
+
+:html_attribute: An attribute of the html_tag which encloses marked expressions
+                 in the original HTML-page (the source-file). Default is *lang*.
+
+:html_value: The value of an attribute of the html_tag which encloses marked
+             expressions in the original HTML-page (the source-file). Default is
+             *fy*.
+
+EXAMPLE-Template             
+============================
+  Assuming that the defaults are used, the following could be a working
+  HTML-template to use with HTML2Index:
+
+::
+
+  <html>
+    <head><title>Glossary</title></head>
+    <body>
+      <h1>Glossary</h1>
+      <h2>Dictionaries used to produce this glossary</h2>     
+      <!-- will be replaced by an unnumbered list <ul><li> ... </li></ul> -->
+      %-dict_list-%
+      <h2>Definitions</h2>
+      <!-- will be replaced by a definition list <dl><dt><dd>... </dd></dt></dl> -->
+      %-glossary-%
+    </body>
+  </html>
+
+ERRORS and WARNINGS
+============================
+
+  html2index warns you if the output-file exists and asks you if you want
+  to replace it with a new version.
+
+  The program also tries to determine the file-type of the input (HTML) file and
+  gives out a warning if the file is considered unsuitable. 
+
+  Each time, that an expression cannot be found in one of the targeted dictionaries,
+  a warning is given. All these problematic expressions will be listed in a
+  temporary file, which is named after html2index has terminated.
+
+SOURCE CODE and DEVELOPMENT
+============================
+html2index is developed in Ruby and can be installed as a Ruby-Gem. As Ruby is
+an interpreter-language, the source-code of the installed version is always
+accessible. You can also decompress the gem-file to take a look at the code.
+
+:AUTHOR: Michael Uplawski <michael[dot]uplawski[at]uplawski[dot]eu>
+

data/html2index.gemspec

@@ -0,0 +1,21 @@
+require_relative "lib/version"
+# require_relative "lib/constants"
+require 'date'
+
+Gem::Specification.new do |s|
+  s.version     = VERSION
+  s.name        = File.basename(__FILE__, '.gemspec')
+  s.date        = Date.today.strftime('%F')
+  s.summary     = "updated dependencies, updated use of the URI module."
+  s.description = "creates a glossary from HTML"
+  s.authors     = ["Michael Uplawski"]
+  s.email       = 'michael.uplawski@uplawski.eu'
+  s.files  	=  %w~html2index~.collect{|f| 'bin/' << f} + %w~version.rb argparser.rb configuration.rb constants.rb dictionary.rb html2index.rb logging.rb translating.rb user_input.rb definition.rb file_checking.rb log.conf template.rb translations~.collect{|f| 'lib/' << f} + %w~html2index.gemspec~.collect{|f|f} + %w~html/html2index.html man/html2index.1.gz pdf/html2index.pdf rst/html2index.rst~.collect{|f| 'doc/' << f}
+  s.homepage    = 'http://www.souris-libre.fr'
+  s.requirements = 'nokogiri, ruby-filemagic'
+  s.add_runtime_dependency 'nokogiri', '~> 1.10', '>= 1.10.9'
+  s.add_runtime_dependency 'ruby-filemagic', '~> 0.7', '>= 0.7.2'
+  s.executables = 'html2index'
+  s.license     = 'GPL-3.0'
+  s.required_ruby_version = '>= 2.7.1'
+end

data/lib/argparser.rb

@@ -0,0 +1,111 @@
+#encoding: UTF-8 
+=begin
+/***************************************************************************
+ *   ©2016-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require_relative 'logging'
+require_relative 'version'
+# require_relative 'translating'
+require_relative 'constants'
+
+class ArgParser 
+  # Class level logger. This is a static class. 
+  self.extend(Logging)
+  # self.extend(Translating)
+  @@log = init_logger()
+
+  # Returns a structure describing the options.
+  #
+  def self.parse(args)
+    if args.empty?
+      puts usage 
+      exit true
+    end
+    # The options specified on the command line will be collected in
+    # <b>options</b>.  No defaults. Most options are optional and do not
+    # have to be set at all.
+    # The others must be named for each transformation or be set in the
+    # configuration-file.
+    options = OpenStruct.new
+    options.target = nil
+
+    op = OptionParser.new do |opts|
+      opts.banner = usage
+
+      opts.on("-d", "--debug", 'Be verbose') do  
+        $log_level = Logger::DEBUG
+        @@log.level = $log_level
+      end
+
+      opts.on("-sOURCE", "--source=SOURCE", 'Source document (html)') do |so|
+        options.source = so
+      end
+
+      opts.on("-oUT", "--out=GLOSSAR", 'Glossar-file (html)') do |ta|
+        options.target = ta
+      end
+
+      opts.on("-tEMPLATE", "--template=TEMPLATE", 'Template (html)') do |tpl|
+        options.template = tpl
+      end
+
+      opts.on("-cONFIG", "--config=CONFIG", 'Configuration-file') do |cfg|
+        options.config = cfg
+      end
+
+      opts.on("-h", "--help", 'Show this message') do  
+        puts opts
+        exit true
+      end
+
+      opts.on("-v", "--version", 'Show program version') do  
+        puts APPNAME.dup << ", version " << VERSION
+        exit true
+      end
+    end
+    begin
+      op.parse!(args)
+    rescue OptionParser::ParseError => er
+      msg = "ERROR! Unsuitable or incomplete program-arguments" << ": %s" %er.message	
+      puts msg
+      puts "Start this program with parameter -h or --help to see the usage-message."
+      exit false
+    end
+    @@log.debug('options are ' << options.to_s)
+
+    options
+  end  # parse()
+
+=begin
+        Shows the usage-message
+=end
+  def self::usage
+    msg = "\n\tUsage: html2index -s input.html [-o output.html] [-c config-file] [-t template.html] [-d]"
+    msg << "\n\n\t* Will print to stdout, if the output-file is not provided."
+    msg << "\n\t* Adapt ~/.config/HTML2Index/config to your needs.\n\n"
+  end
+
+
+end  
+

data/lib/configuration.rb

@@ -0,0 +1,183 @@
+#encoding: UTF-8 
+=begin
+/***************************************************************************
+ *   ©2016-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+require 'yaml'
+require 'singleton'
+require 'ostruct'
+require_relative 'constants'
+require_relative 'file_checking'
+require_relative 'logging'
+require_relative 'translating'
+
+class Configuration
+  include File_Checking
+  include Translating
+  include Logging
+
+  # default configuration file
+  @@config_file = File::dirname(__FILE__) << File::Separator << 'config'
+
+  # do initializations
+  def initialize(options)
+    init_logger(STDOUT)
+    @log.level = $log_level
+    set(options)
+    @log.debug('config-file is ' << @@config_file)
+  end
+
+  def user_conf
+    confdir = ENV['HOME'].dup << File::Separator << '.config'
+    Dir.mkdir(confdir) if !Dir.exist?(confdir)
+    confdir = confdir << File::Separator << APPNAME
+    Dir.mkdir(confdir) if !Dir.exist?(confdir)
+    config = confdir << File::Separator << 'config'
+    if(!File.exist?(config ) )
+      begin
+        File.open(config, 'w') {|co| co.write(File.read(@@config_file))}
+        @log.info("Created user-version of the configuration-file in\n\t" << config)
+      rescue Exception => ex
+        @log.error('Cannot create the configuration: ' << ex.message)
+        give_up
+      end
+    end
+    return config
+  end
+
+  attr_reader :dicts, :template, :fields, :placeholders, :fdelim
+
+  # return any value stored in @config
+  def method_missing(msg, *args)
+    ms = msg.to_sym
+    # Exception-handling is not a control-structure.
+    # This is.
+    if @config[ms]
+      return @config[ms]
+    else
+      return nil
+    end
+  end
+
+  private
+
+  # Configure with the command-line arguments.
+  def set(options)
+    @log.debug('merging options ' << options.to_s)
+    # User-provided configuration-file?
+    if(options['config'])
+      cf = options['config'] 
+      @log.debug('config should be ' << cf.to_s)
+      msg = file_check(cf, :file, :readable)
+      if(!msg) 
+        @@config_file = cf
+      else
+        msg = ("The file %s " << msg.split[1,100].join(' ')) %msg.split[0]
+        @log.error(("ERROR! Unsuitable file") << ' ' << msg)
+        give_up
+      end
+    else
+      @@config_file = user_conf
+    end
+
+    @log.debug('config-file is ' << @@config_file)
+
+    # read defaults from configuration-file
+    co = OpenStruct.new(YAML::load_file(@@config_file))
+
+    # merge and overwrite with the command-line arguments
+    @config = co.to_h.update(options.to_h)
+    if(! @config[:source] )
+      msg = ('missing argument %s') %'source' 
+      @log.error msg
+      @log.error(("Start this program with parameter -h or --help to see the usage-message.") )
+      give_up
+    end
+
+    # ----- define the template html ----
+    warn = false
+    # set template
+    if @config[:template]
+      @template = @config[:template] 
+    else
+      @log.warn 'Using default-template!'
+      warn ||= true
+    end
+    # fields in the template file 
+    if @config[:placeholders] && @config[:template]
+      @placeholders = @config[:placeholders]
+      @log.debug('placeholders from config: ' << @placeholders.to_s)
+    else
+      @placeholders = Template.default(:placeholders)
+      if @config[:placeholders]
+        @log.warn 'Placeholders are defined, but no template-file is given.'
+      else
+        @log.warn 'Template is given, but placeholders are not defined.'
+      end
+      @log.warn 'Using default placeholders ' << @placeholders.to_a.collect{|p|p.join(': ')}.join(', ') 
+      warn = true
+    end
+    @fields = [@placeholders[:dict_list], @placeholders[:glossary]]
+    # the field-delimiter
+    if @config[:fdelim] && @config[:template]
+      @fdelim = @config[:fdelim]
+    else
+      @fdelim = Template.default(:fdelim)
+      if @config[:template]
+        @log.warn 'Template is given, but field delimiters are not defined.'
+      else
+        @log.warn 'Field delimiters are defined but no template is given.'
+      end
+      @log.warn 'Using default delimiters ' << @fdelim << ', ' << @fdelim.reverse 
+      warn ||= true
+    end
+ 
+    # ----------- template is defined --------
+    dictionaries = @config[:dictionaries]
+    @dicts = Array.new
+    if(dictionaries)
+      dictionaries.each do |d| 
+        @dicts << Dictionary.new(d[:name], d[:url], d[:xpath], d[:color]) 
+      end
+      @log.debug('dicts are from config' << @dicts.to_s)
+    else
+      @log.warn( %~NO DICTIONARIES have been set in the configuration!
+Will use the defaults, which is probably NOT what you want!                
+Defaults are: %s~ %[URL_DICT1.dup << ', ' << URL_DICT2.dup])
+      warn ||= true
+      @dicts << Dictionary.new(NAME_DICT1, URL_DICT1,XPATH_DICT1, DICT_COLORS[0])
+      @dicts << Dictionary.new(NAME_DICT2, URL_DICT2, XPATH_DICT2, DICT_COLORS[1])
+      @log.debug('dicts are from constants' << @dicts.to_s)
+    end
+    @log.warn "HINT: Adapt #{@@config_file} to avoid warnings in the future." if warn
+  end
+
+  # exit on error
+  def give_up
+    @log.error("\t" << ("Aborting. Bye!"))
+    exit false
+  end
+end
+
+#------- TEST -----------
+if __FILE__ == "$0"
+  conf = Configuration.new
+  conf.set({})
+end
+#eof

data/lib/constants.rb

@@ -0,0 +1,55 @@
+#encoding: UTF-8 
+=begin
+/***************************************************************************
+ *   ©2015-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+require_relative 'dictionary'
+require 'logger'
+require 'date'
+
+APPNAME = 'HTML2Index'
+
+# URL and xpath for the definitions.
+#
+# The expression is added to the URL. Example:
+# Taken a dictionary url like
+# URL_MY_DICT = "http://my_technical_dictionary.somewhere.com/words/
+# the url to search an expression will be
+# URL_MY_DICT = "http://my_technical_dictionary.somewhere.com/words/expression
+# In other words: Note here the part of the url *before* the expression
+# ---
+# The xpath must identify any HTML-elements, containing definitions.
+#
+NAME_DICT1 ||= 'Larousse' 
+URL_DICT1 ||= "http://www.larousse.com/fr/dictionnaires/francais/"
+XPATH_DICT1 ||= ".//li[@class='DivisionDefinition']"
+
+NAME_DICT2 ||= 'JargonF'
+URL_DICT2 ||= "http://jargonf.org/wiki/"
+XPATH_DICT2 ||= ".//div[@id='mw-content-text']/*"
+
+# colors which are connected to one dictionary, each
+DICT_COLORS ||= ['a000a0', '00a000']
+
+# definitions which cause problems are logged.
+PROBLEM_LOG ||= 'html2index_problems.txt'
+$log_level = Logger::INFO
+
+# meta-tag for the html-output
+GeneratorMeta = "<meta name=\"generator\" content=\"HTML2Index ©2015-#{Date.today.strftime('%Y')} michael.uplawski@uplawski.eu\" />"

data/lib/definition.rb

@@ -0,0 +1,43 @@
+#encoding: UTF-8 
+=begin
+/***************************************************************************
+ *   ©2015-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+require 'constants'
+require_relative 'translating'
+
+class Definition
+	include Comparable
+
+	attr_reader :origin, :expression, :definition
+	attr_accessor :color
+
+	def initialize(origin, expression, definition)
+		@origin = origin
+		@expression = expression
+		@definition = definition
+		@color = nil
+	end
+
+	def <=>(other_def)
+		return @expression <=> other_def.expression 
+	end
+end
+
+