timequiz 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b091415dfe525da2e52aac9047c44ab09b4d4a3aba68091be2e537a409610d4
-  data.tar.gz: 10ce3ea7d1e5eb27ac3a25ff51dd787696c826859b12861b4a3caf3c71702e14
+  metadata.gz: 5e948f6d1620c67a90d6ab3ababb36b60f3d1f3b72d08143fd0b52151c3c91c6
+  data.tar.gz: 1550aaa1b619b8518098f0bf985b859f13a34b1e3edb8ba50d156e6d3de5a0f5
 SHA512:
-  metadata.gz: a7779e38b0ddcd686b1c08ccbff7fca8625eb49bccbefb6ee917ff3cce064deed65d5efd1fb12f01a0f38cc953b537e0eeb2a353825b3069d6051fda1cd53855
-  data.tar.gz: 67fe251eb42dd86133ab690b0512a6cbe77312a919fdf76bfba05257eccebe1fb4c35da661089227feda88c874e8a35f22c35a281d5b7eb9e1087054b08ff5f0
+  metadata.gz: 911b0a8d718d210b06c44c7e0e59aea19d0e80d35c98dfcbdb7e75a417e639b2cd12a144b14e6c81a5402253f6fd4637571692015e9a5d14c3fafd5a47bfb26b
+  data.tar.gz: 0b53734c06f47146692c1a1bb2f40dc302113993496ace128360b3e722fc149e10618154988a648926b2c49a8b8edb0a7023c8b08cab01ce6bd609196d09e960

data/changes.txt

@@ -1,3 +1,10 @@
+V 1.4
+    -) Provided, the manpages gem is installed, man timequiz
+       will open the man page for timequiz. Initially
+       execute 
+            gem manpages --update-all 
+       to be sure.
+
 V 1.3
     -) When the game ends, either after the maximum number 
        of events have been handled or because there are no

data/doc/html/timequiz.html

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <meta name="generator" content="vim - Vi Improved, a programmer's editor; HTML Tidy for Linux version 5.8.0
+  <meta name="generator" content="vim - Vi Improved, a programmer's editor; HTML Tidy for Linux version 5.9.20
 "/>
    <meta charset="utf-8" />
   <link rel="preload" as="font" crossorigin="" href=
@@ -22,9 +22,6 @@
   "width=device-width, initial-scale=1" />
   <title>Timequiz</title>
   <link rel="stylesheet" href="timequiz.css" type="text/css" />
-  <link rel="stylesheet" href="fonts.css" type="text/css" />
-  <link rel="stylesheet" href="https://www.uplawski.eu/ups.css"
-  type="text/css" />
 </head>
 <body>
   <main id="timequiz">
@@ -287,11 +284,40 @@
           "mailto:michael.uplawski@uplawski.eu">michael.uplawski@uplawski.eu</a>&gt;</p>
         </dd>
       </dl>
+
+      <section id="this-document">
+        <h3>This document</h3>
+
+        <blockquote>
+          <p>©Michael Uplawski &lt;<a class="reference external"
+          href=
+          "mailto:michael.uplawski@uplawski.eu">michael.uplawski@uplawski.eu</a>&gt;</p>
+
+          <p>License: <a class="reference external" href=
+          "https://creativecommons.org/licenses/by-nd/4.0/">CC
+          BY-ND 4.0</a></p>
+
+          <p>Date: 2026-09-22</p>
+        </blockquote>
+
+        <p>The man page can be accessed in the ordinary way, by
+        executing <em>man</em> timequiz, <strong>if</strong> the
+        <a class="reference external" href=
+        "https://rubygems.org/gems/manpages">manpages</a> gem is
+        installed. Initially, executing <em>gem manpages
+        --update-all</em> will ensure that the man pages for all
+        packages which provide such documentation are copied to the
+        default locations for man pages.</p>
+      </section>
     </section>
 
     <section id="section-1">
       <h2>Ω</h2>
     </section>
   </main>
+
+  <div id='page_dt'>
+    2026-09-22
+  </div>
 </body>
 </html>

data/doc/rst/timequiz.rst

@@ -5,6 +5,11 @@
 Play a history-quiz game
 ----------------------------------------
 
+.. _manpages: https://rubygems.org/gems/manpages
+.. _CC By-ND 4.0: https://creativecommons.org/licenses/by-nd/4.0/
+.. |date| date::
+
+
 SYNOPSIS
 =======================
 timequiz [options]
@@ -147,5 +152,19 @@ License
 Author
   Developed by Michael Uplawski <michael.uplawski@uplawski.eu>
 
+This document
+-------------
+  ©Michael Uplawski <michael.uplawski@uplawski.eu>
+
+  License: `CC BY-ND 4.0`_
+
+  Date: |date|
+  
+The man page can be accessed in the ordinary way, by executing *man*
+timequiz, **if** the `manpages`_ gem is installed. Initially, executing *gem
+manpages --update-all* will ensure that the man pages for all packages which
+provide such documentation are copied to the default locations for man pages.
+
+
 Ω
 ============

data/lib/console.rb

@@ -40,7 +40,7 @@ module Console
   @@fail_sequence = %w":-|\  :-|\  :-[\  :-[\  :-(\  :-(\  8-(\  8-(\  8-(\  8-(\  8-(\  8-(\  8-(\  8-(\  .... |... lo.. Los. LOso LOSe LOSE lOSE loSE lose"
   @@points = 0
   # start with some arbitrary events
-  def start_game
+  def play_game
     available = $events
     clear
     puts bold("\nPut the following events into the correct chronological order (e.g.: 2 3 1).")

data/lib/events.rb

@@ -15,6 +15,8 @@
 =end
 
 # All events known.
+$events << ['Coronation Of Frederick II as Holy Roman Emperor', 1220, 'Five years after having been coronated as German king and only after negociations with two popes, Frederick was crowned as emperor in Rome on 20 November 1220. His court became one of the leading intellectual centers of the 13th century (Wikipedia).']
+$events << ['Construction of Hadrian\'s Wall across the north of England', 122, 'The Wall served as frontier between the Roman territories in Britain and the unconquered Caledonia in the north. In times of unrest and rebellion in numerous Roma provinces, the wall was also a symbol of the Roman emperor\'s determination to keep the empire intact.']
 $events << ['The Liberation of Dachau Concentration Camp', 1945, 'The 42nd and 45th Infantry Divisions, as well as the 20th Armored Division of the US Army liberate approximately 32,000 prisoners at Dachau on April 29, 1945. Unprepared for the situation, the smell of decaying bodies and human excrement and the sight of naked, emaciated bodies induced vomiting, crying, disbelief, and rage in the advancing troops. Some of the SS-men who were in charge of the camp were killed by US soldiers after having surrendered, which is considered a war crime. But any charges against the men involved in the killings were dismissed by General George S. Patton.']
 $events << ['The Massacre of Béziers', 1209, 'At the beginning of the Albigensian Crusade against the Cathar movement in the Longuedoc (France), Béziers was the first town that was besieged and conquered by the Crusader army, commanded by the papal legate Arnaud Almaric on 22 July 1209. Almarics own receit of the siege and massacre includes this passage: "Our men spared no one, irrespective of rank, sex or age, and put to the sword almost 20,000 people. After this great slaughter the whole city was despoiled and burnt, as divine vengeance miraculously raged against it."']
 $events << ['Ibn Battuta visits the sultanate of Mali', 1352, 'Ibn Battuta, the great Morrocan voyager, in his journal described many of the territories under Muslim domination and became, thus, the only eyewitness of West-African societies and their political organization at that time. His writings contrast with that of later authors who – often in a colonial context – deny the existence of developped societies in this part of the world and, thus, imposed that “Africa has had no history”.']

data/lib/timequiz.rb

@@ -27,7 +27,7 @@ require_relative 'basic_logging'
 require 'date'
 
 # Main program class. All action is within the initialize() method, or, more
-# precisely in the start_game() method which has to be defined by an
+# precisely in the play_game() method which has to be defined by an
 # interface-module. 
 class Timequiz
   include BasicLogging
@@ -140,7 +140,7 @@ class Timequiz
 
     # start the chosen interface
     if(game_ok)
-      start_game 
+      play_game 
     else
       error("Cannot play with the events in " << options.file)
       error("PSE verify that there are at least 3 events defined!") 

data/lib/version.rb

@@ -16,7 +16,7 @@
 =end
 
 APPNAME = 'Timequiz'
-VERSION = '1.3'
+VERSION = '1.4'
 SUMMARY = 'Play a history game'
 AUTHOR = 'Michael Uplawski'
 AUTHOR_MAIL = '<michael.uplawski@uplawski.eu>'

data/man/timequiz.6

@@ -0,0 +1,199 @@
+'\" t
+.\" Man page generated from reStructuredText
+.\" by the Docutils 0.23 manpage writer.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH timequiz "6" "Tue 22 Sep 2026" "3" "Games Manual"
+.SH Name
+TIMEQUIZ \- Play a history-quiz game
+.SH SYNOPSIS
+.sp
+timequiz [options]
+.sp
+Run timequiz without any options to begin a quiz using the default set of
+historical events—the provided collection is modest in size.
+.SH DESCRIPTION
+.sp
+The game presents a limited number of historical events (currently three) in
+random order. Your task is to correctly arrange them chronologically. In each
+subsequent round, a single new event appears—you must place it in the correct
+position relative to the previously ordered events (either before one of the
+listed events or later).
+.sp
+After every round—including the first—your performance is assessed. You may
+then choose to proceed with another event or review the brief description of
+any event already in the sequence.
+.sp
+The game continues until you press q to quit or until the maximum of 15 events
+have been played.
+.SS YOU DON’T NEED TO KNOW EVERY DATE
+.sp
+Winning often does not require exact historical knowledge. Instead, logical
+reasoning or educated guesses—eliminating events that are clearly too early or
+too late—usually suffices. Reading the event descriptions may also help you
+situate other events in historical context later on.
+.SH OPTIONS (not needed to play)
+.sp
+\fB\-a, \-\-add\fP                       Add a new event to the game
+.sp
+\fB\-e, \-\-event\fP [EVENT]             Provide a name of the new event
+.sp
+\fB\-y, \-\-year\fP [YEAR]               Specify the year of the new event
+.sp
+\fB\-b, \-\-background\fP [INFO]         Supply background information for the new event
+.sp
+\fB\-f, \-\-file\fP [FILE]               Specify the file for reading/writing events
+.sp
+\fB\-d, \-\-debug\fP                     Enable verbose debug output
+.sp
+\fB\-v, \-\-version\fP                   Display program version
+.sp
+\fB\-h, \-\-help\fP                      Show help message
+.SS The Options in detail:
+.INDENT 0.0
+.TP
+.B \-a \-\-add
+Requires \-e, \-y, and \-f. This redundancy may be removed in future versions.
+.TP
+.B \-e \-\-event [EVENT]
+The name of the event to add. Requires \-\-add, \-\-year, and \-\-file. Use quotes
+for multi\-word events, e.g., \-\-event \(dqSome Guy Was Born and Something Broke\(dq.
+.TP
+.B \-y \-\-year [YEAR]
+The year of the event, e.g., \-y 1244.
+.TP
+.B \-b \-\-background [INFO]
+Optional context to help with the quiz—use sparingly. For example: \-b \(dqThe
+phenomenon was of no significance whatsoever\(dq.
+.TP
+.B \-f \-\-file [FILE]
+Path to the events file used for quizzes or for adding new events. If the file
+does not exist, it is created with some sample events. It must be readable for
+quizzes and writable for additions.
+.TP
+.B \-d \-\-debug
+Enables verbose debugging output. Mainly useful for developers.
+.TP
+.B \-v \-\-version
+Display the current version of the program.
+.TP
+.B \-h \-\-help
+Show this list of options and usage instructions.
+.UNINDENT
+.SH GAME EXAMPLE
+.sp
+Launching timequiz with no options displays three random historical events,
+prompting:
+.TS
+box center;
+l.
+T{
+Put the following events into the right chronological order (e.g.: 2 3 1).
+.INDENT 0.0
+.IP 1. 3
+The Roman emperor Diocletian devides the empire in two
+.IP 2. 3
+End of the \(dqWar of the mercenaries\(dq
+.IP 3. 3
+Destruction of Nimrod and Ninive by the Medians and Neo\-Babylonians
+.UNINDENT
+.sp
+Available: 1, 2, 3)
+T}
+.TE
+.sp
+Enter your sequence (e.g., 321) without needing to press Enter after each
+number. The game then shows the correct order with years and evaluates your
+input. You’ll be asked if you wish to continue with a new event or view more
+info on the listed events.
+.TS
+box center;
+l.
+T{
+Enter number for more information about an event, \(aqa\(aq to play with one new, random event, \(aqq\(aq to quit.
+T}
+.TE
+.sp
+To continue:
+.sp
+Press a number to view an event’s details,
+.sp
+\fBa\fP to add a new random event, or
+.sp
+\fBq\fP to quit.
+.sp
+If you choose \fBa\fP, here’s how the next prompt may appear:
+.TS
+box center;
+l.
+T{
+Indicate the event from the previous list, which precedes the following, or \(aq0\(aq (zero) to put it in front:
+.sp
+The Italian painter Lorenzo Lotto dies.
+T}
+.TE
+.sp
+You must then enter the corresponding number or 0 if you believe that the event
+occurred before all listed events (which, in this case, would be historically
+inaccurate). Press Enter to submit your answer.
+.SH ADDITIONAL INFORMATION
+.INDENT 0.0
+.TP
+.B Development & Source Code
+timequiz is written in Ruby. As it\(aqs interpreted, the executable is
+essentially the source code—you can open it in any text editor. If installed
+from a Ruby gem, you can extract it using \fBtar \-x\fP, then \fBtar \-xzf\fP\&.
+.TP
+.B Known Bug
+At times, the list of events may wrap incorrectly in the display.
+.TP
+.B License
+Timequiz is distributed under the WTFPL\-2.0 or later License.
+For more details, visit \%<http://\:www\:.wtfpl\:.net/\:txt/\:copying/>
+.TP
+.B Author
+Developed by Michael Uplawski <\%<michael\:.uplawski@\:uplawski\:.eu>>
+.UNINDENT
+.SS This document
+.INDENT 0.0
+.INDENT 3.5
+©Michael Uplawski <\%<michael\:.uplawski@\:uplawski\:.eu>>
+.sp
+License: CC BY\-ND 4.0 \%<https://\:creativecommons\:.org/\:licenses/\:by-nd/\:4\:.0/>
+.sp
+Date: 2026\-09\-22
+.UNINDENT
+.UNINDENT
+.sp
+The man page can be accessed in the ordinary way, by executing \fIman\fP
+timequiz, \fBif\fP the manpages \%<https://\:rubygems\:.org/\:gems/\:manpages> gem is installed. Initially, executing \fIgem
+manpages \-\-update\-all\fP will ensure that the man pages for all packages which
+provide such documentation are copied to the default locations for man pages.
+.SH Ω
+.\" End of generated man page.

data/timequiz.gemspec

@@ -9,14 +9,15 @@ Gem::Specification.new do |s|
   s.description = "A game that makes you put historical events in chronological order."
   s.authors     = ["Michael Uplawski"]
   s.email       = 'michael.uplawski@uplawski.eu'
-  s.files  	=  %w~timequiz~.collect{|f| 'bin/' << f} + %w~basic_logging.rb version.rb adder.rb argparser.rb busy_indicator.rb color_output.rb console.rb constants.rb event.rb events.rb extstring.rb user_input.rb timequiz.rb~.collect{|f| 'lib/' << f} + %w~timequiz.gemspec changes.txt README.md~.collect{|f|f} + %w~man/timequiz.6.gz html/timequiz.html pdf/timequiz.pdf rst/timequiz.rst license.txt~.collect{|f| 'doc/' << f} 
+  s.homepage    = 'https://www.uplawski.eu/software/timequiz/'
+  s.files  	=  %w~timequiz~.collect{|f| 'bin/' << f} + %w~basic_logging.rb version.rb adder.rb argparser.rb busy_indicator.rb color_output.rb console.rb constants.rb event.rb events.rb extstring.rb user_input.rb timequiz.rb~.collect{|f| 'lib/' << f} + %w~timequiz.gemspec changes.txt README.md man/timequiz.6~.collect{|f|f} + %w~man/timequiz.6.gz html/timequiz.html pdf/timequiz.pdf rst/timequiz.rst license.txt~.collect{|f| 'doc/' << f} 
   #s.requirements = ''
   #s.add_runtime_dependency ''
   s.executables = 'timequiz'
   s.license     = 'WTFPL'
   s.required_ruby_version = '>= 2.7'
   s.metadata = {
-    "homepage_uri" => 'https://www.uplawski.eu/software/timequiz/',
+    "homepage_uri" => s.homepage,
     "documentation_uri" => 'https://www.uplawski.eu/software/timequiz/man_timequiz.html',
     "changelog_uri" => 'https://www.uplawski.eu/software/timequiz/changes.txt'
   }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: timequiz
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - Michael Uplawski
 bindir: bin
 cert_chain: []
-date: 2026-09-13 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies: []
 description: A game that makes you put historical events in chronological order.
 email: michael.uplawski@uplawski.eu
@@ -37,7 +37,9 @@ files:
 - lib/timequiz.rb
 - lib/user_input.rb
 - lib/version.rb
+- man/timequiz.6
 - timequiz.gemspec
+homepage: https://www.uplawski.eu/software/timequiz/
 licenses:
 - WTFPL
 metadata:
@@ -58,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Play a history game
 test_files: []