module Nametrainer
Name¶ ↑
nametrainer - name learning trainer
Description¶ ↑
nametrainer
is a name learning trainer using Ruby and the Qt GUI
toolkit. It will assist you in learning people’s names from a collection of images.
See also¶ ↑
Use nametrainer --help
to display a brief help message.
The full documentation for nametrainer
is available on the project home page.
Author¶ ↑
Copyright © 2012-2013 Marcus Stollsteimer
License GPLv3+: GNU GPL version 3 or later <gnu.org/licenses/gpl.html>
This module contains the classes for the nametrainer
tool.
Constants
- COPYRIGHT
- DATE
- FILE_EXTENSIONS
- HOMEPAGE
- PROGNAME
- QT_LOAD_ERROR
- VERSION
Public Class Methods
collection_empty_message()
click to toggle source
Returns the warning message for an empty collection.
# File lib/nametrainer.rb, line 52 def self.collection_empty_message 'Could not load collection.<br><br>' + "Maybe the specified directory does not exist or contains no #{extension_string} files." end
extension_string()
click to toggle source
Returns a string with all accepted image file extensions.
# File lib/nametrainer.rb, line 47 def self.extension_string "#{FILE_EXTENSIONS[0...-1].join(', ').upcase}, or #{FILE_EXTENSIONS.last.upcase}" end
help_message()
click to toggle source
Returns the text for the help window.
# File lib/nametrainer.rb, line 58 def self.help_message <<-HELPTEXT <big>Basic Functions / Keyboard Shortcuts</big><br> <table> <tr><td>Display name </td> <td>Shows the person's name (<strong>D</strong>)</td></tr> <tr><td>Correct</td> <td>You know this person (<strong>S</strong>)</td></tr> <tr><td>Wrong</td> <td>You do not know this person yet (<strong>F</strong>)</td></tr> <tr><td>Quit</td> <td>Quit (<strong>Ctrl+W</strong>)</td></tr> </tr> </table> <br><br> <big>Collections</big><br><br> A collection is simply a diretory with image files. #{PROGNAME} uses the file name as the person's display name or the content of a corresponding TXT file.<br><br> Accepted file formats: #{extension_string}.<br><br> Please note: JPG files may not be supported on Windows; in this case use PNG images instead.<br><br> <big>About</big><br><br> <b>#{PROGNAME}</b> version #{VERSION} (#{DATE})<br><br> Project home page: <a href='#{HOMEPAGE}'>#{HOMEPAGE.gsub(%r{https?://}, '')}</a><br><br> #{COPYRIGHT.lines.first.gsub(/\(C\)/, '©')}<br> For license information use <code>#{PROGNAME} -v</code>. HELPTEXT end