RubyGems - timequiz - Versions diffs - 0.1.3 - Mend

timequiz 0.1.3

Files changed (21) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf32c95c2a8240d508dd756014c4d007f8fad25d
+  data.tar.gz: 6ae09086d0af2afe9d06db6777910295236db67e
+SHA512:
+  metadata.gz: 166123609c82a502915d03474dc9f8fe4e8cb358ce1d4709db5d6d9dc295b6a96ec208b0f35d3acb8f99fd2dd8dd6111b513866a94754a2a120c554f92d3546b
+  data.tar.gz: 17cd0020f495adf460913f0343300fb1186ffcd489753629cd80497d022ba7f0b0a19c9e84e263604ef4390996e3bd70867a47a398b4c275f6cf2332b978ef47

data/bin/timequiz ADDED

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2017-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 "../lib/timequiz.rb"
+Timequiz.new(ARGV)

data/doc/html/timequiz.html ADDED

@@ -0,0 +1,515 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.13.1: http://docutils.sourceforge.net/" />
+<title>Timequiz</title>
+<style type="text/css">
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+Default cascading style sheet for the HTML output of Docutils.
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+.hidden {
+  display: none }
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+blockquote.epigraph {
+  margin: 2em 5em ; }
+dl.docutils dd {
+  margin-bottom: 0.5em }
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+div.abstract {
+  margin: 2em 5em }
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+div.system-messages {
+  margin: 5em }
+div.system-messages h1 {
+  color: red }
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+div.topic {
+  margin: 2em }
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+h1.title {
+  text-align: center }
+h2.subtitle {
+  text-align: center }
+hr.docutils {
+  width: 75% }
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+.align-left {
+  text-align: left }
+.align-center {
+  clear: both ;
+  text-align: center }
+.align-right {
+  text-align: right }
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+/* div.align-center * { */
+/*   text-align: left } */
+.align-top    {
+  vertical-align: top }
+.align-middle {
+  vertical-align: middle }
+.align-bottom {
+  vertical-align: bottom }
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+ol.arabic {
+  list-style: decimal }
+ol.loweralpha {
+  list-style: lower-alpha }
+ol.upperalpha {
+  list-style: upper-alpha }
+ol.lowerroman {
+  list-style: lower-roman }
+ol.upperroman {
+  list-style: upper-roman }
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+p.caption {
+  font-style: italic }
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+p.label {
+  white-space: nowrap }
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+p.topic-title {
+  font-weight: bold }
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+span.interpreted {
+  font-family: sans-serif }
+span.option {
+  white-space: nowrap }
+span.pre {
+  white-space: pre }
+span.problematic {
+  color: red }
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+table.docinfo {
+  margin: 2em 4em }
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+ul.auto-toc {
+  list-style-type: none }
+</style>
+</head>
+<body>
+<div class="document" id="timequiz">
+<h1 class="title">TIMEQUIZ</h1>
+<h2 class="subtitle" id="play-a-history-quiz-game">play a history quiz game</h2>
+<div class="section" id="synopsis">
+<h1>SYNOPSIS</h1>
+<p>timequiz [options]</p>
+<p>Called without any option, the game is started with the events that are included
+in the installed program package. There are not many.</p>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>The general idea is to put historical events in the right order. In the
+beginning, a limited number of events (3 at the time of this writing) is
+presented and you have to indicate the right order of these events. All the
+following rounds will confront you with just 1 additional event and you must
+find for the new event the right spot in the previously ordered list, i.e.
+after one of the listed events or earlier than any of the known events. After
+each round, the first one inclusive, your performance is evaluated. You can
+then choose to continue with a new event or, if you like, read a short
+description of any of the events, already in the list.</p>
+<p>The game continues in this way until you push the 'q' button to quit or until
+all the events that are known to the game, are listed.</p>
+<div class="section" id="you-do-not-need-to-know-it-all">
+<h2>You do not need to know it all</h2>
+<p>Beware that to win a round, it is oftentimes not necessary to really know the
+date of an event. Pure logic and reasonable guesses may be sufficient to find
+the right spot within a historical context or to exclude events as too far in
+the past or future of the currently handled event. Reading the descriptive
+comments to an event may later help you get different events into context.</p>
+</div>
+</div>
+<div class="section" id="options">
+<h1>OPTIONS</h1>
+<p><strong>-a, --add</strong>                       Add a new event</p>
+<p><strong>-e, --event</strong> [EVENT]             Name of the new event</p>
+<p><strong>-y, --year</strong> [YEAR]               Year of the new event</p>
+<p><strong>-b, --background</strong> [INFO]         Background information for the new event</p>
+<p><strong>-f, --file</strong> [FILE]               The file, where events are read from or written to</p>
+<p><strong>-d, --debug</strong>                     Be verbose</p>
+<p><strong>-v, --version</strong>                   Show program version</p>
+<p><strong>-h, --help</strong>                      Show a help text</p>
+<div class="section" id="the-options-in-detail">
+<h2>The Options in detail:</h2>
+<dl class="docutils">
+<dt>-a --add</dt>
+<dd>This option imposes that -e, -y, and -f be given, too. In consequence, it
+will be considered superfluous and removed in future versions of the program.</dd>
+<dt>-e --event</dt>
+<dd>Name the event to add to the events-file. For this option to take effect, -a,
+-y and -f are needed, too. Beware to enclose the value with quotes, like in, e.g.
+--event &quot;Some guy was born and something broke&quot;</dd>
+<dt>-y --year</dt>
+<dd>Is followed by a year, like -y 1244</dd>
+<dt>-b --background</dt>
+<dd>Should be used to provide background-information to an event. While this
+option is ... optional, the information will help solving quizzes and may be
+educative to the player... do not abuse, though.
+Example: -b &quot;The phenomenon was bearing no significance whatsoever&quot;</dd>
+<dt>-f --file</dt>
+<dd>Name the “events-file” which will be used for either creating the quizzes
+randomly or adding events to an existing list of events. The file must be
+readable to serve for a quiz and writable to accept new events. If it does
+not exist, it is created and some exemplary events are included on top.
+Example: --file ~/my_history_quiz</dd>
+<dt>-d --debug</dt>
+<dd>Be verbose. This switches on the output of debug-messages that have been left
+in the program code. Probably useless.</dd>
+<dt>-v --version</dt>
+<dd>Shows the program version</dd>
+<dt>-h --help</dt>
+<dd>Shows the option-summary.</dd>
+</dl>
+</div>
+</div>
+<div class="section" id="game-example">
+<h1>GAME EXAMPLE</h1>
+<p>Calling timequiz without arguments on the command-line, you are confronted with
+three arbitrary, historical events, like in the following screen:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="100%" />
+</colgroup>
+<tbody valign="top">
+<tr><td><p class="first">Put the following events into the right chronological order (e.g.: 2 3 1).</p>
+<ol class="arabic simple">
+<li>The Roman emperor Diocletian devides the empire in two</li>
+<li>End of the &quot;War of the mercenaries&quot;</li>
+<li>Destruction of Nimrod and Ninive by the Medians and Neo-Babylonians</li>
+</ol>
+<p class="last">Available: 1, 2, 3)</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p>You type in the three numbers in the order that you consider chronologically
+correct, like &quot;321&quot; (you do not have to push return after each number). The
+game will respond by showing you the correct order of events with the
+corresponding years and an evaluation of your input. You are also prompted to
+decide if you want to play with a new arbitrary event or first be shown some
+information about the listed events:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="100%" />
+</colgroup>
+<tbody valign="top">
+<tr><td>Enter number for more information about an event, 'a' to play with one new, random event, 'q' to quit.</td>
+</tr>
+</tbody>
+</table>
+<p>If you push 'a', a new event is shown:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="100%" />
+</colgroup>
+<tbody valign="top">
+<tr><td><p class="first">Indicate the event from the previous list, which precedes the following, or '0' (zero) to put it in front:</p>
+<p class="last">The Italian painter Lorenzo Lotto dies.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p>You can now decide, which of the three previous events precedes the death of
+the Italian painter and either put in the (current) number of that previous
+event or the number 0 (zero) if you consider that Lorenzo Lotto died well
+before any of the other events (which would, of course, be false in the
+example).  You have to push the return-button after your input, as it can
+contain an arbitrary number of ciphers, later in the game.</p>
+</div>
+<div class="section" id="other-information">
+<h1>Other Information</h1>
+<dl class="docutils">
+<dt>Development and source code</dt>
+<dd>timequiz has been written in Ruby. As Ruby is an interpreted programming
+language, the executable file and all those that it may refer to at one point
+in time, are themselves the source-files of the current program-version. You
+can open them in any text-editor to scrutinize the source-code. If you have
+received the program as a Ruby-gem, you can also decompress a copy of the
+gem-file with <em>tar -x</em>, then <em>tar -xzf</em>.</dd>
+<dt>Bugs</dt>
+<dd>At one time during the game, the list of already known events is incorrectly
+wrapped and continues to be.</dd>
+<dt>License</dt>
+<dd>timequiz is distributed under the conditions of the GNU General Public
+License, version 3.</dd>
+<dt>Author</dt>
+<dd>timequiz has been developed by Michael Uplawski
+&lt;<a class="reference external" href="mailto:michael.uplawski&#64;uplawski.eu">michael.uplawski&#64;uplawski.eu</a>&gt;</dd>
+</dl>
+</div>
+</div>
+</body>
+</html>