studium 0.16.9

data/lib/studium/base/base.rb

@@ -0,0 +1,3229 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Base
+#
+# This is the base class for other classes that are part of the Studium
+# namespace.
+#
+# Not every class needs it though, so it is recommended to only make use
+# of it if you need some "commonly shared functionality".
+#
+# Classes that belong to the Studium::Exams namespace should subclass
+# from this class here as well.
+# =========================================================================== #
+# To require this base class, do:
+#
+#   require 'studium/exams/base.rb'
+#
+# Then, to subclass from it, do:
+#
+#   < Studium::Base
+#
+# In a shorter variant combining the two lines above, do this:
+#
+#   require 'studium/base/base.rb'; < ::Studium::Base
+#
+# =========================================================================== #
+require 'studium/base/prototype/prototype.rb'
+
+module Studium
+
+class Base # === Studium::Base
+
+  begin # Try to pull in code from the colours gem.
+    require 'colours/toplevel_methods/misc.rb'
+  rescue LoadError; end
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  begin
+    require 'roebe/requires/require_kde_konsole.rb'
+  rescue LoadError; end
+
+  begin
+    require 'open/in_browser/in_browser.rb'
+  rescue LoadError; end
+
+  # require 'studium/base/encoding.rb' # This also pulls in studium/encoding/encoding.rb
+  # ========================================================================= #
+  # We must support different encodings, so pull in the important files next.
+  # ========================================================================= #
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/requires/require_the_studium_constants.rb'
+  require 'studium/logging/html_log_directory.rb'
+  require 'studium/logging/log_directory.rb'
+
+  # ========================================================================= #
+  # Add the necessary (and important) toplevel_methods next:
+  # ========================================================================= #
+  require 'studium/toplevel_methods/available_topics.rb'
+  require 'studium/toplevel_methods/curriculum_related_code.rb'
+  require 'studium/toplevel_methods/does_this_course_require_mandatory_presence.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/editor.rb'
+  require 'studium/toplevel_methods/esystem.rb'
+  require 'studium/toplevel_methods/filter_away_invalid_questions.rb'
+  require 'studium/toplevel_methods/find_exam_topic_and_exam_title.rb'
+  require 'studium/toplevel_methods/is_on_roebe.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/methods_related_to_files_and_directories.rb'
+  require 'studium/toplevel_methods/misc.rb'
+  require 'studium/toplevel_methods/regexes.rb'
+  require 'studium/toplevel_methods/remove_tags.rb'
+  require 'studium/toplevel_methods/report.rb'
+  require 'studium/toplevel_methods/return_all_exams_on_this_day.rb'
+  require 'studium/toplevel_methods/return_dataset_for_this_exam_topic.rb'
+  require 'studium/toplevel_methods/return_ects_from_this_lecture_stored_in_the_file_lecture_information.rb'
+  require 'studium/toplevel_methods/return_lva_number_of_this_lecture.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+  require 'studium/toplevel_methods/set_this_cd_alias_to.rb'
+  require 'studium/toplevel_methods/spacer.rb'
+  require 'studium/toplevel_methods/time.rb'
+  require 'studium/toplevel_methods/total_ects_points_passed.rb'
+  require 'studium/toplevel_methods/url.rb' # Has Studium.sanitize_url().
+  require 'studium/toplevel_methods/write_into_file_related_functionality.rb'
+  require 'studium/toplevel_methods/yes_or_no_ja_oder_nein.rb'
+
+  # ========================================================================= #
+  # === Base::N_CHARACTERS_PER_LINE
+  #
+  # If an answer exceeds the following threshold value, then we will chop
+  # some bits off of it. The reason why we have defined this here in
+  # class Base is because at the least two other classes that are
+  # part of the Exam namespace, require this.
+  # ========================================================================= #
+  N_CHARACTERS_PER_LINE = 78
+
+  # ========================================================================= #
+  # === Base::LEFT_PADDING
+  #
+  # The default padding (for showing the answer to an exam question) is
+  # 4 spaces since as of July 2020. In November 2020 2 spaces are now
+  # tried.
+  # ========================================================================= #
+  LEFT_PADDING = ' ' * 2 # 2 spaces for now.
+
+  # ========================================================================= #
+  # === COMMON_YEAR_DAYS_IN_MONTH
+  #
+  # This constant has the days per month, for the whole year.
+  #
+  # It will not honour leap years properly, though.
+  # ========================================================================= #
+  COMMON_YEAR_DAYS_IN_MONTH = [
+    nil,
+    31,
+    28,
+    31,
+    30,
+    31,
+    30,
+    31,
+    31,
+    30,
+    31,
+    30,
+    31
+  ]
+
+  # ========================================================================= #
+  # === reset_the_internal_state
+  # ========================================================================= #
+  def reset_the_internal_state
+    # ======================================================================= #
+    # === @internal_hash[:no_connection_to_the_www]
+    #
+    # If true then we have no connection to the WWW.
+    # ======================================================================= #
+    @internal_hash[:no_connection_to_the_www] = false
+  end
+
+  # ========================================================================= #
+  # === www_connection_is_unavailable
+  # ========================================================================= #
+  def www_connection_is_unavailable
+    @internal_hash[:no_connection_to_the_www] = true
+  end; alias www_is_unavailable www_connection_is_unavailable # === www_is_unavailable
+
+  # ========================================================================= #
+  # === is_connected_to_the_www?
+  # ========================================================================= #
+  def is_connected_to_the_www?
+    !@internal_hash[:no_connection_to_the_www]
+  end
+
+  # ========================================================================= #
+  # === replace_bold_token_with_default_colour
+  #
+  # This method can be used to replace <b></b> with the corresponding
+  # colour code on the terminal.
+  # ========================================================================= #
+  def replace_bold_token_with_default_colour(
+      i, use_this_colour = :mediumseagreen
+    )
+    i.gsub(
+      /<b>(.+)<\/b>/,
+      ::Colours.bold('\1')
+    )
+  end
+
+  # ========================================================================= #
+  # === spacer
+  # ========================================================================= #
+  def spacer
+    Studium.spacer
+  end
+
+  # ========================================================================= #
+  # === is_a_registered_curriculum?
+  #
+  # This calls code stored in the file
+  # /studium/toplevel_methods/curriculum_related_code.rb.
+  # ========================================================================= #
+  def is_a_registered_curriculum?(i)
+    return Studium.is_a_registered_curriculum?(i)
+  end
+
+  # ========================================================================= #
+  # === html_log_dir?
+  # ========================================================================= #
+  def html_log_directory?
+    Studium.html_log_directory?
+  end; alias html_log_dir? html_log_directory? # === html_log_dir?
+
+  # ========================================================================= #
+  # === opne
+  # ========================================================================= #
+  def opne(i)
+    opnn; e i
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @internal_hash[:be_verbose]
+  end
+
+  # ========================================================================= #
+  # === do_not_be_verbose
+  # ========================================================================= #
+  def do_not_be_verbose
+    @internal_hash[:be_verbose] = false
+  end; alias set_be_quiet do_not_be_verbose # === set_be_quiet
+
+  # ========================================================================= #
+  # === set_be_verbose
+  # ========================================================================= #
+  def set_be_verbose
+    @internal_hash[:be_verbose] = true
+  end; alias be_verbose set_be_verbose # === be_verbose
+
+  # ========================================================================= #
+  # === move_file
+  # ========================================================================= #
+  def move_file(this_file, target)
+    FileUtils.mv(this_file, target)
+  end
+
+  # ========================================================================= #
+  # === has_this_exam_topic_been_solved?
+  # ========================================================================= #
+  def has_this_exam_topic_been_solved?(i)
+    (Studium.return_n_percent_solved_from_this_topic(i).to_i == 100)
+  end
+
+  # ========================================================================= #
+  # === cpruby
+  # ========================================================================= #
+  def cpruby
+    base_dir = ENV['USERS']
+    base_dir = '/home' if base_dir.nil?
+    path_to_setup_rb_file =
+      "#{RUBY_SRC_DIR}roebe/lib/roebe/setup/setup.rb"
+    copy(path_to_setup_rb_file, '.')
+  end
+
+  # ========================================================================= #
+  # === delete_file
+  # ========================================================================= #
+  def delete_file(i)
+    File.delete(i) if File.exist? i
+  end
+
+  # ========================================================================= #
+  # === filter_away_invalid_questions
+  #
+  # This method will remove entries that begin with '#' and empty entries.
+  # ========================================================================= #
+  def filter_away_invalid_questions(i)
+    Studium.filter_away_invalid_questions(i)
+  end
+
+  # ========================================================================= #
+  # === read_in_exam_dataset_from_this_file
+  #
+  # This is the method that will read from an existing file. If a symbol
+  # is given then we will expand this to the default exam-topic directory.
+  # ========================================================================= #
+  def read_in_exam_dataset_from_this_file(
+      this_file
+    )
+    if this_file.is_a? Symbol
+      this_file = "#{exam_topic_directory?}#{this_file}"
+    end
+    if File.exist? this_file
+      dataset = readlines_via_default_encoding(this_file)
+      dataset = filter_away_invalid_questions(dataset)
+      return dataset
+    end
+  end
+
+  # ========================================================================= #
+  # === remove_internal_comments
+  # ========================================================================= #
+  def remove_internal_comments(i)
+    if i.is_a? Array
+      i.map {|line|
+        if line.include? '#'
+          line = line[0 .. (line.index('#') - 1)]
+        end
+        line.strip
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === return_all_numbers_from
+  #
+  # This method will return all numbers from the given input.
+  # ========================================================================= #
+  def return_all_numbers_from(i)
+    return_this = nil
+    if i.is_a? Array
+      return_this = i.select {|line|
+        line =~ /\d+/ # Any entry with a number will be returned.
+      }
+    end
+    return_this
+  end
+
+  # ========================================================================= #
+  # === return_all_steop_lectures
+  # ========================================================================= #
+  def return_all_steop_lectures
+    return_sanitized_dataset_from_the_file_lecture_information.select {|a, b|
+      is_a_steop_lecture = obtain(:steop, b)
+      is_a_steop_lecture
+    }
+  end
+
+  # ========================================================================= #
+  # === extract_dd_mm_yyyy
+  #
+  # This method can be used to extract the dd.mm.yyyy format from the given
+  # input at hand. It will discard everything else.
+  #
+  # So, for instance, if the input is "15.10.2018, 09:00-18:00" then
+  # this method will return only "15.10.2018".
+  # ========================================================================= #
+  def extract_dd_mm_yyyy(i)
+    i =~ /(\d{1,2}\.\d{1,2}\.\d{4})/ # This will also generate a match.
+    return $1.to_s.dup
+  end; alias extract_ddmmyyyy extract_dd_mm_yyyy # === extract_ddmmyyyy
+
+  # ========================================================================= #
+  # === return_month_fitting_to_this_input
+  #
+  # This method will return a number.
+  # ========================================================================= #
+  def return_month_fitting_to_this_input(i)
+    i = i.capitalize
+    if MONTH_NAME_TO_MONTH_NUMBER.has_key? i
+      i = MONTH_NAME_TO_MONTH_NUMBER[i]
+    end
+    return i.to_i
+  end
+
+  # ========================================================================= #
+  # === remove_leading_weekday_names_from
+  #
+  # Chop away the leading weekday, e. g. "Monday", from the String at hand.
+  # ========================================================================= #
+  def remove_leading_weekday_names_from(i)
+    Studium.remove_leading_weekday_names_from(i)
+  end; alias remove_german_weekdays         remove_leading_weekday_names_from # === remove_german_weekdays
+       alias remove_german_weekdays_from    remove_leading_weekday_names_from # === remove_german_weekdays_from
+       alias remove_leading_weeknames       remove_leading_weekday_names_from # === remove_leading_weeknames
+       alias remove_leading_weekdays        remove_leading_weekday_names_from # === remove_leading_weekdays
+       alias remove_workday_from_this_input remove_leading_weekday_names_from # === remove_workday_from_this_input
+       alias remove_german_days             remove_leading_weekday_names_from # === remove_german_days
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    Studium.is_on_roebe?
+  end; alias is_roebe? is_on_roebe? # === is_roebe?
+       alias on_roebe? is_on_roebe? # === on_roebe?
+
+  # ========================================================================= #
+  # === weekdays?
+  #
+  # This method will return all weekdays, as Array, including german
+  # and english names for these weekdays.
+  # ========================================================================= #
+  def weekdays?
+    (
+      ARRAY_GERMAN_WEEKDAYS+
+      HASH_SHORT_TO_LONG_WEEKDAYS.values
+    ).flatten
+  end
+
+  # ========================================================================= #
+  # === german_weekdays?
+  # ========================================================================= #
+  def german_weekdays?
+    ARRAY_GERMAN_WEEKDAYS
+  end
+
+  # ========================================================================= #
+  # === try_to_require_the_rcfiles
+  # ========================================================================= #
+  def try_to_require_the_rcfiles
+    begin
+      require 'rcfiles'
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === copy                                                       (copy tag)
+  # ========================================================================= #
+  def copy(from, to)
+    if from.is_a? Array
+      from.each {|entry|
+        copy(entry, to)
+      }
+    else
+      FileUtils.copy(from, to)
+    end
+  end; alias copy_file copy # === copy_file
+
+  # ========================================================================= #
+  # === set_xorg_buffer
+  # ========================================================================= #
+  def set_xorg_buffer(i)
+    begin
+      require 'xorg_buffer' unless Object.const_defined?(:XorgBuffer)
+      XorgBuffer.set_buffer(i)
+    rescue LoadError
+      if is_on_roebe?
+        e 'XorgBuffer is not available - can not set the buffer.'
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === lectures_from_the_individual_vektor_curricula
+  #
+  # This method is a convenience method, returning all the lectures that
+  # belong to the individual bachelor+master vektor-curriculum
+  # ========================================================================= #
+  def lectures_from_the_individual_vektor_curricula
+    (
+      obtain_lectures_from_this_curriculum(:bachelor_vektor)+
+      obtain_lectures_from_this_curriculum(:master_vektor)
+    ).flatten
+  end
+
+  # ========================================================================= #
+  # === open_in_editor
+  # ========================================================================= #
+  def open_in_editor(i)
+    Studium.open_in_editor(i)
+  end
+
+  # ========================================================================= #
+  # === editor?
+  # ========================================================================= #
+  def editor?
+    Studium.editor?
+  end
+
+  # ========================================================================= #
+  # === encoding?
+  #
+  # This method will return the main encoding in use, by "pointing" towards
+  # the constant that keeps track of this.
+  # ========================================================================= #
+  def encoding?
+    ::Studium.main_encoding?
+  end; alias main_encoding?        encoding? # === main_encoding?
+       alias main_encoding_to_use? encoding? # === main_encoding_to_use?
+       alias use_this_encoding?    encoding? # === use_this_encoding?
+       alias encoding_to_use?      encoding? # === encoding_to_use?
+
+  # ========================================================================= #
+  # === exit_program                                               (exit tag)
+  #
+  # Use this method to exit from the program. It is a general "exit-operation"
+  # for classes in the Studium project. The reason as to why we don't just
+  # simply use exit() is so that we
+  # ========================================================================= #
+  def exit_program(
+      make_newline = :no_newline
+    )
+    case make_newline
+    # ======================================================================= #
+    # === :no_newline
+    # ======================================================================= #
+    when :no_newline
+      make_newline = false
+    end
+    e(N) if make_newline
+    exit # Exit here.
+  end
+
+  # ========================================================================= #
+  # === turn_this_array_into_the_full_dataset
+  #
+  # This method accepts an Array of lectures that will be replaced with
+  # a full dataset.
+  # ========================================================================= #
+  def turn_this_array_into_the_full_dataset(
+      i, use_this_dataset
+    )
+    hash = {}
+    i.flatten.each {|name_of_the_lecture|
+      pointer = use_this_dataset[name_of_the_lecture]
+      hash[name_of_the_lecture] = pointer
+    }
+    hash
+  end
+
+  # ========================================================================= #
+  # === no_ext_name
+  #
+  # This method will return the name of the file (or rather the
+  # input given to this method) without extension.
+  # ========================================================================= #
+  def no_ext_name(i)
+    i.sub(/#{File.extname(i)}$/,'')
+  end
+
+  # ========================================================================= #
+  # === load_yaml_dataset
+  #
+  # This method should ideally be used whenever a .yml file is to be
+  # loaded.
+  #
+  # The second argument can be used to rescue missing or erroneous
+  # yaml files.
+  #
+  # Invocation example for this is:
+  #
+  #   load_yaml_dataset(:rescue)
+  #
+  # ========================================================================= #
+  def load_yaml_dataset(
+      i,
+      do_rescue = false
+    )
+    case do_rescue
+    # ======================================================================= #
+    # === :rescue
+    # ======================================================================= #
+    when :rescue
+      do_rescue = true
+    end
+    if do_rescue
+      begin
+        YAML.load_file(i)
+      rescue LoadError, ArgumentError; end
+    else
+      YAML.load_file(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === enable_debug
+  # ========================================================================= #
+  def enable_debug
+    @internal_hash[:debug] = true
+  end; alias do_debug enable_debug # === do_debug
+
+  # ========================================================================= #
+  # === be_silent
+  # ========================================================================= #
+  def be_silent
+    @internal_hash[:be_verbose] = false
+  end; alias be_quiet be_silent # === be_quiet
+
+  # ========================================================================= #
+  # === is_a_weekday?
+  #
+  # This method will return true if the input is a String that represents
+  # a weekday, such as "Monday". Otherwise, false will be returned.
+  #
+  # Both german and english variants are allowed here.
+  # ========================================================================= #
+  def is_a_weekday?(i = 'Montag')
+    result = false
+    if ARRAY_GERMAN_WEEKDAYS.include? i
+      result = true
+    elsif ARRAY_ENGLISH_WEEKDAYS.include? i
+      result = true
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === lectures_from_indi1
+  # ========================================================================= #
+  def lectures_from_indi1
+    obtain_lectures_from_this_curriculum(:indi1)
+  end
+
+  # ========================================================================= #
+  # === lectures_from_indi2
+  # ========================================================================= #
+  def lectures_from_indi2
+    obtain_lectures_from_this_curriculum(:indi2)
+  end
+
+  # ========================================================================= #
+  # === lectures_from_indi3
+  # ========================================================================= #
+  def lectures_from_indi3
+    obtain_lectures_from_this_curriculum(:indi3)
+  end
+
+  # ========================================================================= #
+  # === lectures_from_indi4
+  # ========================================================================= #
+  def lectures_from_indi4
+    obtain_lectures_from_this_curriculum(:indi4)
+  end
+
+  # ========================================================================= #
+  # === return_random_curriculum
+  # ========================================================================= #
+  def return_random_curriculum
+    ::Studium.return_random_curriculum
+  end
+
+  # ========================================================================= #
+  # === lectures_from_the_bachelor_genetik_curriculum
+  # ========================================================================= #
+  def lectures_from_the_bachelor_genetik_curriculum
+    obtain_lectures_from_this_curriculum(:bachelor_genetik_curriculum)
+  end
+
+  # ========================================================================= #
+  # === return_lectures_from_bachelor_vektor_curriculum
+  # ========================================================================= #
+  def return_lectures_from_bachelor_vektor_curriculum
+    obtain_lectures_from_this_curriculum(:bachelor_vektor)
+  end
+
+  # ========================================================================= #
+  # === convert_this_array_of_lectures_into_the_full_dataset
+  #
+  # The purpose of this method is to turn an Array that holds Strings
+  # such as "941111 Genetische Ressourcen von Nutzpflanzen" into the
+  # corresponding dataset.
+  #
+  # This method will return a Hash if everything went fine.
+  # ========================================================================= #
+  def convert_this_array_of_lectures_into_the_full_dataset(i)
+    if i.is_a? Array
+      if Studium.main_dataset?.nil?
+        Studium.initialize_main_dataset
+      end
+      _ = Studium.main_dataset?
+      hash = {}
+      i.map {|course_id_and_course_name|
+        if _.has_key?(course_id_and_course_name)
+          hash[course_id_and_course_name] = _[course_id_and_course_name]
+        end
+      }
+      hash
+    else
+      raise 'This method only accepts an Array as input.'
+    end
+  end
+
+  # ========================================================================= #
+  # === return_this_line_has_n_characters_as_html_colour_tags
+  # ========================================================================= #
+  def return_this_line_has_n_characters_as_html_colour_tags(i)
+    i.scan(REGEX_FOR_OPENING_AND_CLOSING_COLOUR_TAGS).map {|entry|
+      entry.size
+    }.sum
+  end
+
+  # ========================================================================= #
+  # === file_read_with_proper_encoding
+  # ========================================================================= #
+  def file_read_with_proper_encoding(this_file)
+    Studium.file_read_with_proper_encoding(this_file)
+  end
+
+  # ========================================================================= #
+  # === create_file
+  # ========================================================================= #
+  def create_file(i)
+    FileUtils.touch(i)
+  end; alias touch create_file # === touch
+
+  # ========================================================================= #
+  # === return_n_questions_were_answered_for_this_topic
+  # ========================================================================= #
+  def return_n_questions_were_answered_for_this_topic(i)
+    Studium::Exams.return_n_questions_were_answered_for_this_topic(i)
+  end
+
+  # ========================================================================= #
+  # === create_directory
+  # ========================================================================= #
+  def create_directory(i)
+    FileUtils.mkdir_p(i)
+  end; alias mkdir create_directory # === mkdir
+
+  # ========================================================================= #
+  # === change_directory
+  # ========================================================================= #
+  def change_directory(
+      i = Dir.pwd
+    )
+    FileUtils.chdir(i)
+  end; alias cd change_directory # === cd
+
+  # ========================================================================= #
+  # === return_passed_courses
+  #
+  # This method will quickly return all passed courses.
+  # ========================================================================= #
+  def return_passed_courses
+    return_dataset_from_file_lecture_information.select {|key, hash|
+      hash.has_key?(:already_solved) and
+      (hash[:already_solved] == true)
+    }
+  end
+
+  # ========================================================================= #
+  # === return_ects_points_from_these_lectures
+  #
+  # Input to this method should be a Hash containing our lectures.
+  #
+  # An example for this is shown next:
+  #
+  #   {"051010"=>"Programmierung 1",
+  #    "051110"=>"Mathematische Grundlagen der Informatik 1"}
+  #
+  # ========================================================================= #
+  def return_ects_points_from_these_lectures(hash)
+    n_ects_points = 0 # Keep track of the amount of ECTS points here.
+    hash.each_pair {|lecture_id, name_of_the_lecture|
+      # lecture_id = ensure_main_encoding(lecture_id)
+      # name_of_the_lecture = ensure_main_encoding(name_of_the_lecture)
+      name_of_the_lecture.squeeze!(' ')
+      points = Studium.return_ects_from_this_lecture_stored_in_the_file_lecture_information(
+        name_of_the_lecture, lecture_id
+      )
+      n_ects_points += points
+    }
+    return n_ects_points
+  end
+
+  # ========================================================================= #
+  # === select_lectures_with_this_key
+  #
+  # This method allows us to select only entries with a particular
+  # key. The key has to be passed to the method and - for now - has
+  # to be exactly the same as the key (e. g. string for strings
+  # and symbols for symbols; no automatic conversions for now).
+  #
+  # The advantage of this method is that it will simplify a lot of
+  # code; all code that requires us to select only specific
+  # lectures.
+  #
+  # Usage examples:
+  #
+  #   .select_lectures_with_this_key(:exam_registration_at)
+  #   .select_lectures_with_this_key(:already_solved)
+  #
+  # ========================================================================= #
+  def select_lectures_with_this_key(
+      searching_for_this_key
+    )
+    dataset = return_sanitized_dataset_from_the_file_lecture_information
+    dataset.select! {|name_of_the_lecture, inner_hash|
+      inner_hash.has_key? searching_for_this_key
+    } if dataset # <- Must check here, since there may be a nil.
+    return dataset
+  end
+
+  # ========================================================================= #
+  # === konsole_support?
+  # ========================================================================= #
+  def konsole_support?
+    true
+  end
+
+  # ========================================================================= #
+  # === rename_kde_konsole_tab
+  # ========================================================================= #
+  def rename_kde_konsole_tab(
+      title = '.'
+    )
+    if Object.const_defined?(:Roebe) and
+       Roebe.respond_to?(:rename_konsole_title_to)
+      Roebe.rename_konsole_title_to(title, :be_quiet)
+    end
+  end
+
+  # ========================================================================= #
+  # === last_file?
+  # ========================================================================= #
+  def last_file?
+    _ = Studium.file_for_exam_questions
+    _ = load_yaml_dataset(_).chomp
+    # ======================================================================= #
+    # If we are on roebe then we will use another path.
+    # ======================================================================= #
+    if is_on_roebe?
+      _ = Studium::MY_EXAM_TOPICS+File.basename(_)
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === return_sanitized_dataset_from_the_file_lecture_information
+  #
+  # This method will return the dataset stored in the file
+  # 'lecture_information.yml'.
+  # ========================================================================= #
+  def return_sanitized_dataset_from_the_file_lecture_information
+    Studium.return_sanitized_dataset_from_the_file_lecture_information
+  end; alias return_dataset_from_the_file_lecture_information       return_sanitized_dataset_from_the_file_lecture_information # === return_dataset_from_the_file_lecture_information
+       alias return_dataset_from_file_lecture_information           return_sanitized_dataset_from_the_file_lecture_information # === return_dataset_from_file_lecture_information
+       alias lecture_information_dataset                            return_sanitized_dataset_from_the_file_lecture_information # === lecture_information_dataset
+       alias lecture_information                                    return_sanitized_dataset_from_the_file_lecture_information # === lecture_information_dataset
+       alias dataset_from_file_lecture_information                  return_sanitized_dataset_from_the_file_lecture_information # === dataset_from_file_lecture_information
+       alias dataset_from_lecture_information                       return_sanitized_dataset_from_the_file_lecture_information # === dataset_from_lecture_information
+       alias dataset_lecture_information                            return_sanitized_dataset_from_the_file_lecture_information # === dataset_lecture_information
+       alias return_lecture_information                             return_sanitized_dataset_from_the_file_lecture_information # === return_lecture_information
+       alias return_data_from_the_file_lecture_information          return_sanitized_dataset_from_the_file_lecture_information # === return_data_from_the_file_lecture_information
+       alias return_all_lectures                                    return_sanitized_dataset_from_the_file_lecture_information # === return_all_lectures
+       alias all_lectures?                                          return_sanitized_dataset_from_the_file_lecture_information # === all_lectures?
+       alias return_lectures_from_file_lecture_information          return_sanitized_dataset_from_the_file_lecture_information # === return_lectures_from_file_lecture_information
+       alias dataset_from_the_file_lecture_information              return_sanitized_dataset_from_the_file_lecture_information # === dataset_from_the_file_lecture_information
+       alias return_sanitized_dataset_from_file_lecture_information return_sanitized_dataset_from_the_file_lecture_information # === return_sanitized_dataset_from_file_lecture_information
+       alias return_dataset_from_the_lectures                       return_sanitized_dataset_from_the_file_lecture_information # === return_dataset_from_the_lectures
+       alias return_sanitized_dataset                               return_sanitized_dataset_from_the_file_lecture_information # === return_sanitized_dataset
+       alias return_all_lectures_from_the_file_lecture_information  return_sanitized_dataset_from_the_file_lecture_information # === return_all_lectures_from_the_file_lecture_information
+       alias return_dataset_from_lecture_information                return_sanitized_dataset_from_the_file_lecture_information # === return_dataset_from_lecture_information
+       alias from_file_lecture_information                          return_sanitized_dataset_from_the_file_lecture_information # === from_file_lecture_information
+       alias sanitized_dataset_from_file_lecture_information        return_sanitized_dataset_from_the_file_lecture_information # === sanitized_dataset_from_file_lecture_information
+       alias dataset_from_the_file_lecture_information              return_sanitized_dataset_from_the_file_lecture_information # === dataset_from_the_file_lecture_information
+
+  # ========================================================================= #
+  # === obtain                                                   (obtain tag)
+  #
+  # This method will attempt to return the entry point of our main hash.
+  #
+  # It is optimized towards the dataset stored in the file
+  # 'lecture_information.yml'.
+  #
+  # Typical usage example:
+  #
+  #   curricula = obtain(:curricula, pointer_to_the_lecture_dataset)
+  #
+  # ========================================================================= #
+  def obtain(
+      this_key, hash, be_verbose = true
+    )
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet
+        be_verbose = false
+      end
+    end
+    case be_verbose
+    when :be_quiet,
+         :be_silent
+      be_verbose = false
+    end
+    # ======================================================================= #
+    # The following case menu will make use of some common popular aliases
+    # or typos.
+    # ======================================================================= #
+    case this_key
+    # ======================================================================= #
+    # === :passed_when
+    # ======================================================================= #
+    when :passed_when,
+         :solved_at
+      this_key = :already_solved_at
+    # ======================================================================= #
+    # === :passed_successfully
+    # ======================================================================= #
+    when :passed_successfully
+      this_key = :already_solved
+    # ======================================================================= #
+    # === :steop
+    # ======================================================================= #
+    when :steop,
+         'steop'
+      this_key = :is_a_steop_lecture
+    # ======================================================================= #
+    # === :curricula_entries
+    # ======================================================================= #
+    when :curricula_entries,
+         :curricula,
+         'curricula'
+      this_key = 'curricula'
+    # ======================================================================= #
+    # === :english_description
+    # ======================================================================= #
+    when :english_description
+      this_key = :description_in_english
+    # ======================================================================= #
+    # === :german_description
+    # ======================================================================= #
+    when :german_description
+      this_key = :description_in_german
+    # ======================================================================= #
+    # === :this_university
+    # ======================================================================= #
+    when :this_university,
+         :university
+      this_key = :university
+    # ======================================================================= #
+    # === :n_ects
+    # ======================================================================= #
+    when :n_ects, :n_ects_points
+      this_key = :ects
+    # ======================================================================= #
+    # === :curricula_ids
+    # ======================================================================= #
+    when :curricula_ids,
+         :curriculum_id
+      this_key = 'curricula'
+    # ======================================================================= #
+    # === :lecturers
+    # ======================================================================= #
+    when :lecturers
+      this_key = 'lecturers'
+    # ======================================================================= #
+    # === :semester
+    # ======================================================================= #
+    when 'homepage',
+         :remote_url
+      this_key = :homepage
+    # ======================================================================= #
+    # === :semester
+    # ======================================================================= #
+    when :semester, 'semester'
+      this_key = :semester
+    end
+    # ======================================================================= #
+    # Work on any other symbols given to us next.
+    # ======================================================================= #
+    if this_key.is_a? Symbol
+      if hash.has_key? this_key
+        # All is fine.
+      elsif hash.has_key? this_key.to_s
+        # Else use that String as key instead.
+        this_key = this_key.to_s
+      end
+    end
+    if hash.is_a? Symbol
+      e "Symbol called :#{slateblue(hash.to_s)}"
+      e swarn('This is not allowed - please correct this. '\
+        '(Read the next line in how to do so.)')
+      e swarn('This method requires (1) first the key, (2) then the Hash.')
+      exit
+    elsif hash.is_a?(Hash) and hash.has_key?(this_key)
+      hash[this_key] # Return this.
+    else
+      if be_verbose
+        case this_key
+        when :is_a_steop_lecture
+          # Exceptions - these keys ^^^ will NOT be shown.
+        else
+          e "In file #{sfile('base.rb')}, method: obtain() → No key found, "\
+            "called `#{this_key.to_s}` (class '#{this_key.class.to_s})"
+          e 'The hash was:'
+          e
+          pp hash
+          e
+        end
+      end
+      nil
+    end
+  end; alias obtain_this_value_from_hash obtain # === obtain_this_value_from_hash
+       alias obtain_from                 obtain # === obtain_from
+
+  # ========================================================================= #
+  # === colour_for_ects_points
+  # ========================================================================= #
+  def colour_for_ects_points(i = '')
+    ::Studium.colour_for_ects_points(i)
+  end; alias colourize_ects colour_for_ects_points # === colourize_ects
+       alias colour_ects    colour_for_ects_points # === colour_ects
+
+  # ========================================================================= #
+  # === return_opnn
+  # ========================================================================= #
+  def return_opnn(
+      use_this_namespace = NAMESPACE
+    )
+    ::Colours::GREY+
+    use_this_namespace+
+    ': '+
+    ::Colours::REVERT
+  end; alias ropnn return_opnn # === ropnn
+
+  # ========================================================================= #
+  # === set_this_cd_alias_to
+  # ========================================================================= #
+  def set_this_cd_alias_to(
+      cd_alias,
+      new_content,
+      be_verbose = :default
+    )
+    Studium.set_this_cd_alias_to(cd_alias, new_content, be_verbose)
+  end
+
+  # ========================================================================= #
+  # === return_all_exams_on_this_day
+  # ========================================================================= #
+  def return_all_exams_on_this_day(i)
+    Studium.return_all_exams_on_this_day(i)
+  end
+
+  # ========================================================================= #
+  # === average_grade
+  # ========================================================================= #
+  def average_grade(
+      i        = :default,
+      round_to = 2 # ← Round to two numbers.
+    )
+    require 'studium/exams/average_grade/average_grade.rb'
+    Studium.average_grade(i, round_to)
+  end
+
+  # ========================================================================= #
+  # === remove_leading_comments
+  # ========================================================================= #
+  def remove_leading_comments(i)
+    if i.is_a? Array
+      i.reject {|line| line.start_with? '#' }
+    end
+  end
+
+  # ========================================================================= #
+  # === remove_empty_strings
+  #
+  # This method presently only works on Arrays. We will reject empty
+  # Strings from the Array at hand.
+  # ========================================================================= #
+  def remove_empty_strings(i)
+    if i.is_a? Array
+      i.reject {|line| line.empty? }
+    end
+  end
+
+  # ========================================================================= #
+  # === sanitize_this_topic                         (sanitize tag, alias tag)
+  #
+  # This entry keeps all possible aliases to commonly used topics, in
+  # particular abbreviations.
+  # ========================================================================= #
+  def sanitize_this_topic(this_topic)
+    Studium.sanitize_this_theme_topic(this_topic)
+  end
+
+  # ========================================================================= #
+  # === replace_regular_numbers_with_unicode_numbers
+  #
+  # This method will replace numbers such as 1 with ¹.
+  # ========================================================================= #
+  def replace_regular_numbers_with_unicode_numbers(i)
+    ::Studium.replace_regular_numbers_with_unicode_numbers(i)
+  end
+
+  # ========================================================================= #
+  # === return_dataset_for_this_topic
+  # ========================================================================= #
+  def return_dataset_for_this_topic(i)
+    Studium.return_dataset_for_this_topic(i)
+  end
+
+  # ========================================================================= #
+  # === cheering_person
+  # ========================================================================= #
+  def cheering_person
+    '\o/'
+  end; alias cheering_person? cheering_person # === cheering_person?
+       alias cheering_dude?   cheering_person # === cheering_dude?
+
+  # ========================================================================= #
+  # === return_solved_lectures
+  #
+  # This method will return only those entries that have the key
+  # :already_solved set to true.
+  # ========================================================================= #
+  def return_solved_lectures
+    already_solved = select_lectures_with_this_key(:already_solved).select {|a,b|
+      obtain(:already_solved, b) == true
+    }
+    already_solved
+  end
+
+  # ========================================================================= #
+  # === sanitize_url
+  #
+  # This is such a useful method that we will use it for all subclasses
+  # of Studium::Base.
+  # ========================================================================= #
+  def sanitize_url(
+      i,
+      optional_extra_modes = nil
+    )
+    Studium.sanitize_url(i, optional_extra_modes)
+  end; alias sanitized_url sanitize_url # === sanitized_url
+
+  # ========================================================================= #
+  # === web_liner
+  # ========================================================================= #
+  def web_liner(this_token = '*')
+    (this_token * 80)+N
+  end
+
+  # ========================================================================= #
+  # === return_directory_for
+  #
+  # This method will try to build up the most plausible, local path to
+  # an existing directory.
+  # ========================================================================= #
+  def return_directory_for(
+      name_of_the_lecture,
+      university
+    )
+    Studium.return_directory_for(name_of_the_lecture, university)
+  end
+
+  # ========================================================================= #
+  # === return_steop_lectures                                     (steop tag)
+  #
+  # This method will return all registered STEOP lectures.
+  #
+  # The optional argument will determine whether solved STEOP lectures
+  # will also be returned. By default this is not the case, meaning
+  # that we will ignore STEOP lectures that have already been solved.
+  # ========================================================================= #
+  def return_steop_lectures(
+      optional_ignore_already_completed_steop_lectures = true
+    )
+    if ::Studium.main_dataset?
+      dataset = ::Studium.main_dataset?
+    else
+      dataset = return_dataset_from_the_file_lecture_information
+    end
+    selection = dataset.select {|a, b|
+      b.has_key?(:is_a_steop_lecture) and (b[:is_a_steop_lecture] == true)
+    }
+    if optional_ignore_already_completed_steop_lectures
+      selection = selection.reject {|a, b|
+        b.has_key?(:already_solved) and (b[:already_solved] == true)
+      }
+    end
+    return selection
+  end
+
+  # ========================================================================= #
+  # === remove_newlines
+  # 
+  # This method will remove newlines, aka "\n", from Strings and Arrays.
+  # ========================================================================= #
+  def remove_newlines(i)
+    if i.is_a? Array
+      i.map {|entry| remove_newlines(entry) }
+    else
+      i.delete(N)
+    end
+  end
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    ::Studium.esystem(i)
+  end
+
+  # ========================================================================= #
+  # === append_what_into                                        (append tag)
+  #
+  # Use this method to save data into a specific file.
+  # ========================================================================= #
+  def append_what_into(what, into)
+    Studium.append_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === ruby_src_dir_at_home?
+  # ========================================================================= #
+  def ruby_src_dir_at_home?
+    Studium.ruby_src_dir_at_home?
+  end
+
+  # ========================================================================= #
+  # === replace_italic_token_with_this_colour
+  #
+  # This method can be used to replace <i></i> with the corresponding
+  # colour code on the terminal.
+  # ========================================================================= #
+  def replace_italic_token_with_this_colour(
+      i, use_this_colour = :mediumseagreen
+    )
+    use_this_regex = /<it?>([A-Za-zöäüÖÄÜ\s]+)<\/it?>/ # See: https://rubular.com/r/mZb1ZtGHCLhg2U
+    i.gsub(
+      use_this_regex,
+      ::Colours.string_italic('\1')+
+      ::Colours.remove_trailing_escape_code(
+        ::Colours.send(use_this_colour.to_sym, '')
+      )
+    )+
+    ::Colours.send(use_this_colour,'')
+  end
+
+  # ========================================================================= #
+  # === return_the_remote_homepage_url
+  #
+  # The first parameter denotes which particular lecture is to be
+  # investigated, in regards to its homepage-URL.
+  #
+  # The second parameter should contain the hash-dataset that is to be
+  # used.
+  # ========================================================================= #
+  def return_the_remote_homepage_url(
+      of_this_lecture, dataset_to_use
+    )
+    of_this_lecture.strip!
+    _ = dataset_to_use
+    if _.has_key? :homepage
+      _ = _[:homepage]
+    else
+      e "No :homepage entry for `#{sfancy(of_this_lecture.to_s)}`."
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === remove_tags_from_this_input
+  #
+  # This method will return all HTML-like tags from the given input String.
+  # ========================================================================= #
+  def remove_tags_from_this_input(i)
+    return Studium.remove_tags(i)
+  end; alias remove_tags remove_tags_from_this_input # === remove_tags
+
+  # ========================================================================= #
+  # === use_opn?
+  # ========================================================================= #
+  def use_opn?
+    @internal_hash[:use_opn]
+  end
+
+  # ========================================================================= #
+  # === do_not_use_opn
+  # ========================================================================= #
+  def do_not_use_opn
+    @internal_hash[:use_opn] = false
+  end
+
+  # ========================================================================= #
+  # === studium_directory_at_home?
+  # ========================================================================= #
+  def studium_directory_at_home?
+    Studium.studium_directory_at_home?
+  end; alias studium_directory_at_home? studium_directory_at_home? # === studium_directory_at_home?
+
+  # ========================================================================= #
+  # === has_a_master_curriculum?
+  #
+  # This method will return true if the given Array has any master
+  # curriculum; and it will return false otherwise.
+  #
+  # Note that there is an alias called
+  # "is_this_lecture_registered_in_a_master_curriculum?". The name is a
+  # of a misnomer, since the input to this method should be an Array
+  # containing the IDs of the Curricula for which that lecture is
+  # registered. This may be subject for change one day, but for
+  # now (Sep 2018) we will keep it that way.
+  # ========================================================================= #
+  def has_a_master_curriculum?(array)
+    Studium.has_a_master_curriculum?(array)
+  end; alias is_a_master_curriculum?                            has_a_master_curriculum? # === is_a_master_curriculum?
+       alias has_a_master_lecture?                              has_a_master_curriculum? # === has_a_master_lecture?
+       alias has_a_master_curriculum_entry?                     has_a_master_curriculum? # === has_a_master_curriculum_entry?
+       alias is_this_lecture_registered_in_a_master_curriculum? has_a_master_curriculum? # === is_this_lecture_registered_in_a_master_curriculum?
+       alias does_this_include_a_master_curriculum?             has_a_master_curriculum? # === does_this_include_a_master_curriculum?
+
+  # ========================================================================= #
+  # === return_file_for_this_curriculum
+  #
+  # This method is a wrapper over the toplevel-method called
+  # Studium.return_file_for_this_curriculum(). 
+  # ========================================================================= #
+  def return_file_for_this_curriculum(
+      i = :bachelor_basisblock_biologie
+    )
+    if i.is_a? Array
+      i.map {|line|
+        return_file_for_this_curriculum(line)
+      }
+    else
+      # ===================================================================== #
+      #
+      #   bl $RUBY_STUDIUM/constants/return_file_for_this_curriculum.rb
+      #
+      # ===================================================================== #
+      Studium.return_file_for_this_curriculum(i)
+    end
+  end; alias return_curriculum_file_based_on_this_input  return_file_for_this_curriculum # === return_curriculum_file_based_on_this_input
+       alias curriculum_location_of                      return_file_for_this_curriculum # === curriculum_location_of
+       alias return_path_of_this_curriculum              return_file_for_this_curriculum # === return_path_of_this_curriculum
+       alias return_path_to_the_curriculum_file          return_file_for_this_curriculum # === return_path_to_the_curriculum_file
+       alias return_file_associated_with_this_curriculum return_file_for_this_curriculum # === return_file_associated_with_this_curriculum
+       alias location_of_this_curriculum_file?           return_file_for_this_curriculum # === location_of_this_curriculum_file?
+
+  # ========================================================================= #
+  # === obtain_lectures_from_this_curriculum
+  #
+  # This method should be used whenever you wish to obtain all lectures
+  # that belong to a specific curriculum, without any comments.
+  #
+  # An Array will be returned by this method.
+  # ========================================================================= #
+  def obtain_lectures_from_this_curriculum(
+      i                     = :default,
+      do_flatten_the_result = true
+    )
+    Studium.read_dataset_from_a_curriculum_file(i, :remove_comments, do_flatten_the_result).map {|entry|
+      entry.squeeze(' ') # ← We don't want multiple ' ' in succession here.
+    }
+  end; alias return_lectures_from_this_curriculum      obtain_lectures_from_this_curriculum # === return_lectures_from_this_curriculum
+       alias return_lectures_of_this_curriculum        obtain_lectures_from_this_curriculum # === return_lectures_of_this_curriculum
+       alias return_lectures_from_this_curriculu       obtain_lectures_from_this_curriculum # === return_lectures_from_this_curriculu
+       alias return_lectures_from_this_curriculum_file obtain_lectures_from_this_curriculum # === return_lectures_from_this_curriculum_file
+
+  # ========================================================================= #
+  # === fetch_this_curriculum
+  #
+  # This method can be used to specifically read in a registered local
+  # curriculum.
+  # ========================================================================= #
+  def fetch_this_curriculum(i, &block)
+    path = map_input_to_this_curriculum_filename(i)
+    _ = readlines_with_proper_encoding(path, &block)
+    if _
+      return _.reject {|line|
+        line.strip.empty? or line.strip.start_with?('#')
+      }.map {|entry|
+        entry.strip!
+        entry.squeeze!(' ')
+        if entry.include?('#')
+          entry = entry.split('#').first.to_s
+        end
+        entry.strip
+      }
+    else
+      false
+    end
+  end
+
+  # ========================================================================= #
+  # === return_title_from_this_curriculum_file
+  #
+  # The first argument to this method should be the abbreviation of
+  # that particular curriculum.
+  #
+  # Note that an Array can also be given as input to this method; this
+  # may be done if a curriculum consists of more than one block.
+  #
+  # Usage example:
+  #
+  #   return_title_from_this_curriculum_file(:indi2)
+  #
+  # ========================================================================= #
+  def return_title_from_this_curriculum_file(
+      i,
+      use_a_shorter_name = false
+    )
+    Studium.return_title_from_this_curriculum_file(i, use_a_shorter_name)
+  end; alias return_title_of                        return_title_from_this_curriculum_file # === return_title_of
+       alias return_pretty_title_of_this_curriculum return_title_from_this_curriculum_file # === return_pretty_title_of_this_curriculum
+       alias return_title_of_this_curriculum        return_title_from_this_curriculum_file # === return_title_of_this_curriculum
+
+  # ========================================================================= #
+  # === total_ects_points_passed
+  # ========================================================================= #
+  def total_ects_points_passed(i)
+    Studium.total_ects_points_passed(i)
+  end
+
+  # ========================================================================= #
+  # === directory_to_my_exam_topics
+  # ========================================================================= #
+  def directory_to_my_exam_topics
+    Studium.directory_to_my_exam_topics
+  end
+
+  # ========================================================================= #
+  # === directory_to_the_exam_topics?
+  # ========================================================================= #
+  def directory_to_the_exam_topics?
+    Studium.directory_to_the_exam_topics?
+  end; alias path_to_exam_topic?           directory_to_the_exam_topics? # === path_to_exam_topic?
+       alias directory_of_the_exam_topics? directory_to_the_exam_topics? # === directory_of_the_exam_topics?
+
+  # ========================================================================= #
+  # === rename_konsole_tab?
+  # ========================================================================= #
+  def rename_konsole_tab?(
+      i = FILE_RENAME_KONSOLE_TAB
+    )
+    if File.exist? i
+      YAML.load_file(i)
+    else
+      false
+    end
+  end
+
+  # ========================================================================= #
+  # === replace_italic_token_with_default_colour
+  # ========================================================================= #
+  def replace_italic_token_with_default_colour(i, colour_to_use = :royalblue)
+    replace_italic_token_with_this_colour(i, colour_to_use)
+  end
+
+  # ========================================================================= #
+  # === replace_underline_token_with_default_colour
+  # ========================================================================= #
+  def replace_underline_token_with_default_colour(i, colour_to_use = :royalblue)
+    replace_underline_token_with_this_colour(i, colour_to_use)
+  end
+
+  # ========================================================================= #
+  # === replace_underline_token_with_this_colour
+  #
+  # We can use either <ud> or <u>, so we have to check for both variants.
+  # ========================================================================= #
+  def replace_underline_token_with_this_colour(
+      i, use_this_colour = :royalblue # This default colour is rarely in use.
+    )
+    if (i.include?('<ud>') and i.include?('</ud>')) or
+       (i.include?('<u>')  and i.include?('</u>'))
+      # ===================================================================== #
+      # Next, set up a non-greedy explicit regex:
+      #
+      #   https://rubular.com/r/uNnBwWc35LKjXX
+      #
+      # ===================================================================== #
+      use_this_regex = /<ud?>([-a-züöäA-ZÜÖÄ0-9\/%, \n\.]+?)<\/ud?>/
+      i = i.dup if i.frozen?
+      i.gsub!(
+        use_this_regex,
+        ::Colours.string_underline('\1')+
+        ::Colours.remove_trailing_escape_code(
+          ::Colours.send(use_this_colour.to_sym, '')
+        )
+      )
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === roebe_exam_directory?
+  # ========================================================================= #
+  def roebe_exam_directory?
+    "#{RUBY_STUDIUM_HOME_DIR}exam_topics/"
+  end
+
+  # ========================================================================= #
+  # === colourize_percentage
+  #
+  # This method should be used when we wish to display percentage
+  # values on the commandline.
+  # ========================================================================= #
+  def colourize_percentage(i)
+    return seagreen(i) if use_colours? # Used to be cadetblue.
+    return i
+  end
+
+  # ========================================================================= #
+  # === remove_escape_sequences
+  # ========================================================================= #
+  def remove_escape_sequences(i)
+    ::Colours.remove_escape_sequences(i)
+  end
+
+  require 'studium/toplevel_methods/word_wrap.rb'
+  # ========================================================================= #
+  # === word_wrap
+  #
+  # This method can re-arrange a given text (a String) to honour a certain
+  # size limit, such as 80 characters per line.
+  #
+  # Keep in mind that colours that may be used inside of a tag, such as
+  # <tomato>foobar</tomato>, will also count for that limit. This has
+  # to be remembered when doing the calculation for text-wrapping.
+  # ========================================================================= #
+  def word_wrap(
+      text,
+      line_width = N_CHARACTERS_PER_LINE
+    )
+    ::Studium.word_wrap(text, line_width)
+  end
+
+  # ========================================================================= #
+  # === eparse
+  #
+  # The colours for this method are defined within the method body.
+  #
+  # We could also delegate to ::Colours.eparse() instead.
+  # ========================================================================= #
+  def eparse(
+      i,
+      use_colours = use_colours?
+    )
+    if use_colours
+      token = '#'
+      if i.include? token
+        splitted = i.split(token)
+        splitted[-1] = olive(splitted[-1])
+        i = splitted.join(royalblue(token))
+      end
+    end
+    e i
+  end; alias ecolourize eparse # === ecolourize
+
+  # ========================================================================= #
+  # === vertical_bar?
+  # ========================================================================= #
+  def vertical_bar?
+    return '|'
+  end
+
+  # ========================================================================= #
+  # === horizontal_bar?
+  # ========================================================================= #
+  def horizontal_bar?
+    return '―'
+  end
+
+  # ========================================================================= #
+  # === shall_we_make_use_of_unicode_symbols?
+  #
+  # The most common idiom for using this method is actually via:
+  #
+  #   if use_unicode_symbols?
+  #
+  # ========================================================================= #
+  def shall_we_make_use_of_unicode_symbols?
+    ::Studium.shall_we_make_use_of_unicode_symbols?
+  end; alias use_unicode_symbols? shall_we_make_use_of_unicode_symbols? # === use_unicode_symbols?
+       alias use_unicode?         shall_we_make_use_of_unicode_symbols? # === use_unicode?
+
+  # ========================================================================= #
+  # === unicode_blocks_line
+  #
+  # This method will "draw" a (horizontal) unicode-blocks line, that is,
+  # a line that is "built" from unicode blocks.
+  #
+  # The optional first argument can be used to use a specific colour.
+  #
+  # Usage examples:
+  #
+  #   unicode_blocks_line :steelblue
+  #   unicode_blocks_line(:steelblue) {{ n_tokens: 84 }}
+  #
+  # ========================================================================= #
+  def unicode_blocks_line(
+      optional_use_this_colour = nil,
+      use_n_tokens             = :default, # <- This defaults to 78.
+      use_this_unicode_token   = :upper_half_block
+    )
+    case use_n_tokens
+    when :default # Must come before we check for a given block.
+      use_n_tokens = 78
+    end
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Hash
+        if yielded.has_key? :n_tokens
+          use_n_tokens = yielded.delete(:n_tokens)
+        end
+      end
+    end
+    begin
+      require 'roebe/toplevel_methods/unicode/unicode_block_elements.rb'
+    rescue LoadError; end
+    _ = (Roebe.send(use_this_unicode_token) * use_n_tokens)
+    if optional_use_this_colour
+      _ = ::Colours::AllColourMethods.send(optional_use_this_colour, _)
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === file_lecture_information?
+  # ========================================================================= #
+  def file_lecture_information?
+    ::Studium.file_lecture_information?
+  end
+
+  # ========================================================================= #
+  # === infer_the_namespace
+  #
+  # This will assume the true namespace from the inspectable name.
+  # ========================================================================= #
+  def infer_the_namespace
+    _ = inspect.to_s.delete('<')
+    if _.include? ' '
+      _ = _.split(' ').first.delete('#')
+      if _.include? ':'
+        _ = _.split(':')[0 .. -2].reject {|entry| entry.empty? }.join('::')
+      end
+    end
+    @internal_hash[:namespace] = _ # And assign it here.
+  end
+
+  # ========================================================================= #
+  # === left_arrow
+  # ========================================================================= #
+  def left_arrow?
+    '←'
+  end; alias left_arrow left_arrow? # === left_arrow
+
+  # ========================================================================= #
+  # === is_prüfungsimmanent?
+  #
+  # This method can determine whether a course is "prüfungsimmanent",
+  # aka whether this course requires continuous, mandatory presence
+  # (of the student).
+  #
+  # The argument to this method should be the type of the lecture at
+  # hand, such as "VO" or "VU" or "SE" or "PR", as a String.
+  #
+  # The method will always return a boolean value, aka true or
+  # false. If true is the return value then this means that "yes,
+  # this course requires mandatory presence".
+  # ========================================================================= #
+  def is_prüfungsimmanent?(
+      i, ignore_these_types = nil
+    )
+    Studium.is_prüfungsimmanent?(i, ignore_these_types)
+  end; alias is_a_prüfungsimmanent_course?      is_prüfungsimmanent? # === is_a_prüfungsimmanent_course?
+       alias is_this_a_prüfungsimment_course?   is_prüfungsimmanent? # === is_this_a_prüfungsimment_course?
+       alias is_this_a_prüfungsimmanent_course? is_prüfungsimmanent? # === is_this_a_prüfungsimmanent_course?
+
+  # ========================================================================= #
+  # === right_arrow?
+  # ========================================================================= #
+  def right_arrow?
+    UNICODE_RIGHT_ARROW
+  end; alias right_arrow right_arrow? # === right_arrow
+       alias rarrow      right_arrow? # === rarrow
+       alias rarrow?     right_arrow? # === rarrow?
+
+  # ========================================================================= #
+  # === has_lva_dates_registered?
+  # ========================================================================= #
+  def has_lva_dates_registered?(i)
+    return false if i.nil? or i.empty? # Reject impossible values quickly.
+    if i.is_a?(Array) and !i.empty?
+      true
+    else
+      false
+    end
+  end; alias has_any_lva_dates_registered? has_lva_dates_registered? # === has_any_lva_dates_registered?
+
+  # ========================================================================= #
+  # === select_for_prüfungsimmanente_LVs
+  #
+  # We assume the input to this method is a Hash containing all lectures.
+  # ========================================================================= #
+  def select_for_prüfungsimmanente_LVs(i)
+    i.select {|name_of_the_course, inner_hash|
+      type = inner_hash[:type]
+      is_prüfungsimmanent?(type)
+    }
+  end
+
+  require 'studium/toplevel_methods/is_this_lecture_a_practical_course.rb'
+  # ========================================================================= #
+  # === is_this_lecture_a_practical_course?
+  # ========================================================================= #
+  def is_this_lecture_a_practical_course?(
+      this_lecture,
+      optional_lecture_type = nil
+    )
+    ::Studium.is_this_lecture_a_practical_course?(this_lecture, optional_lecture_type)
+  end; alias is_this_lecture_a_practical_course is_this_lecture_a_practical_course? # === is_this_lecture_a_practical_course
+       alias is_it_a_practical_course?          is_this_lecture_a_practical_course? # === is_it_a_practical_course?
+
+  # ========================================================================= #
+  # === beautiful_url
+  #
+  # This method can be used to "beautify" a remote URL, based on shorter
+  # input.
+  #
+  # Until 10.12.2019 this method exclusively used BeautifulUrl.
+  #
+  # Since as of 10.12.2019, this method will actually tap into
+  # Studium.return_url_from() if it is registered.
+  # ========================================================================= #
+  def beautiful_url(i)
+    unless Studium.respond_to? :is_this_url_registered?
+      # ===================================================================== #
+      # Enable support for that .rb file next.
+      # ===================================================================== #
+      require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+    end
+    if Studium.is_this_url_registered?(i)
+      i = Studium.return_url_from(i)
+    else
+      i = BeautifulUrl[i]
+    end
+    if i.is_a? Array
+      i = i.first
+    end
+    return i
+  end; alias return_remote_URL beautiful_url # === return_remote_URL
+
+  # ========================================================================= #
+  # === filter_for_all_passed_exams
+  # ========================================================================= #
+  def filter_for_all_passed_exams(i)
+    return i.select {|a, b|
+      b[:already_solved] and
+     (b[:already_solved] == true)
+    }
+  end
+
+  # ========================================================================= #
+  # === etomato
+  # ========================================================================= #
+  def etomato(i)
+    e tomato(i)
+  end
+
+  # ========================================================================= #
+  # === is_a_master_lecture?
+  # ========================================================================= #
+  def is_a_master_lecture?(i)
+    Studium.is_a_master_lecture?(i)
+  end
+
+  # ========================================================================= #
+  # === try_to_require_the_open_gem
+  # ========================================================================= #
+  def try_to_require_the_open_gem
+    begin
+      require 'open'
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === roebe_path_to_file_lecture_information?
+  # ========================================================================= #
+  def roebe_path_to_file_lecture_information?
+    '/home/x/programming/ruby/src/studium/lib/studium/yaml/lecture_information/'\
+    'lecture_information.yml'
+  end
+
+  # ========================================================================= #
+  # === is_german_weekday?
+  # ========================================================================= #
+  def is_german_weekday?(i)
+    ARRAY_GERMAN_WEEKDAYS.include?(i)
+  end
+
+  # ========================================================================= #
+  # === add_proper_year_entry_to_this_line
+  #
+  # This method will add a proper year entry to a line. It will either
+  # append a year entry - or, which may be more useful, try to insert
+  # the year-entry into a position that fits. The latter will make
+  # use of a regex.
+  #
+  # A test string for the latter is the following:
+  #
+  #   "Dienstag   02.10. 11:30-13:00 UZA2 Hörsaal 5 Raum 2Z202 2.OG"
+  #
+  # ========================================================================= #
+  def add_proper_year_entry_to_this_line(line)
+    result = line.dup
+    current_year = Time.now.year
+    use_this_regex = # See: https://rubular.com/r/xV0yNSYhWW
+      /^(.+)(\d{2}\.\d{1,2}\.) (\d{1,2}:\d{1,2}(-| )?\d{1,2}:\d{1,2})(.+)$/
+    if result =~ use_this_regex
+      result.sub!(use_this_regex, '\1\2'+current_year.to_s+', \3\5')
+    else # this here is the simpler case
+      result << current_year # This is the variant that will simply append.
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === parse_this_line_for_date_entry
+  # ========================================================================= #
+  def parse_this_line_for_date_entry(i)
+    use_this_regex = /\d{2}\.\d{2}\.\d{4}/ # See: https://rubular.com/r/ePRbty9Cjo49xv
+    result = i.scan(use_this_regex).flatten
+    result = result.first if result.is_a? Array
+    return result
+  end
+
+  # ========================================================================= #
+  # === german_weekend_for?
+  # ========================================================================= #
+  def german_weekend_for?(
+      i = '22.11.2022'
+    )
+    if Object.const_defined?(:Roebe)
+      return Roebe.return_german_weekday(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === file_passed_exams_per_month
+  # ========================================================================= #
+  def file_passed_exams_per_month
+    Studium.file_passed_exams_per_month
+  end; alias passed_exams_per_month file_passed_exams_per_month # === passed_exams_per_month
+       alias local_csv_file?        file_passed_exams_per_month # === local_csv_file?
+
+  # ========================================================================= #
+  # === try_to_require_the_verbose_truth_gem
+  # ========================================================================= #
+  def try_to_require_the_verbose_truth_gem
+    begin
+      require 'verbose_truth'
+    rescue LoadError
+    end
+  end
+
+  # ========================================================================= #
+  # === try_to_require_html_templates
+  # ========================================================================= #
+  def try_to_require_html_templates
+    begin
+      require 'cyberweb/requires/require_the_html_template.rb'
+    rescue LoadError
+    end
+  end
+
+  # ========================================================================= #
+  # === cliner                                                   (cliner tag)
+  #
+  # This method can be used such as in the following example, if a specific
+  # colour is wanted:
+  #
+  #   cliner('*', :mediumaquamarine)
+  #   cliner { :unicode }
+  #
+  # ========================================================================= #
+  def cliner(
+      which_token_to_use = :default_token,
+      use_this_colour    = nil,
+      &block
+    )
+    if which_token_to_use.is_a? Hash # Treat Hashes specially.
+      # ===================================================================== #
+      # === :colours
+      # ===================================================================== #
+      if which_token_to_use.has_key? :colours
+        use_this_colour = which_token_to_use.delete(:colours)
+        which_token_to_use = :default_token
+      # ===================================================================== #
+      # === :colour
+      # ===================================================================== #
+      elsif which_token_to_use.has_key? :colour
+        use_this_colour = which_token_to_use.delete(:colour)
+        which_token_to_use = :default_token
+      end
+    end
+    case which_token_to_use
+    # ======================================================================= #
+    # === :default_token
+    # ======================================================================= #
+    when :default_token
+      which_token_to_use = '='
+    end
+    # ======================================================================= #
+    # === Handle blocks given to this method next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :unicode
+      # ===================================================================== #
+      when :unicode
+        begin
+          require 'roebe/toplevel_methods/unicode/unicode_block_elements.rb'
+          which_token_to_use = Roebe.horizontal_double_bar.dup
+        rescue LoadError; end
+      else
+        use_this_colour = :mediumaquamarine
+      end
+    end
+    result = (which_token_to_use * 80)
+    if use_this_colour.is_a? Symbol
+      if use_this_colour.to_s.include?('konsole_') or
+         is_this_colour_a_html_colour?(use_this_colour)
+        unless use_this_colour.to_s.include? '_colour_'
+          use_this_colour = use_this_colour.to_s
+          use_this_colour.sub!(/_/,'_colour_')
+        end
+        result = COLOURS.send(use_this_colour, result)
+      end
+    end
+    e result
+  end
+
+  # ========================================================================= #
+  # === german_yes_or_no
+  # ========================================================================= #
+  def german_yes_or_no(i)
+    case i
+    when true
+      'ja'
+    when false
+      'nein'
+    end
+  end
+
+  # ========================================================================= #
+  # === return_german_weekday_of?
+  # ========================================================================= #
+  def return_german_weekday_of?(i)
+    weekday?(i, :german)
+  end
+
+  # ========================================================================= #
+  # === return_german_name_for_this_english_month
+  # ========================================================================= #
+  def return_german_name_for_this_english_month(i)
+    array = MONTH_NAME_ALIASES_GERMAN_TO_ENGLISH.invert
+    return array[i]
+  end; alias to_german_month return_german_name_for_this_english_month # === to_german_month
+
+  # ========================================================================= #
+  # === rinstall2
+  #
+  # This method can be used to perform an install-process via oldschool
+  # setup.rb.
+  # ========================================================================= #
+  def rinstall2
+    cpruby
+    system 'ruby setup.rb --quiet config'
+    system 'ruby setup.rb --quiet setup'
+    system 'ruby setup.rb --quiet install'
+    delete_file 'setup.rb'
+    delete_file 'InstalledFiles'
+    delete_file '.config'
+  end; alias r2 rinstall2 # === r2
+
+  # ========================================================================= #
+  # === silently_open_in_browser
+  #
+  # This method can accept Strings such as
+  # '/home/x/Temp/studium/html/timetable.html#today'.
+  # ========================================================================= #
+  def silently_open_in_browser(into)
+    try_to_require_the_open_gem unless Object.const_defined?(:Open)
+    ::Open.in_browser(into) { :be_silent }
+  end
+
+  # ========================================================================= #
+  # === read_this_file_with_default_encoding
+  #
+  # This method will read in a file, that should ideally exist, in the
+  # default project-wide encoding.
+  #
+  # A few aliases exist to this method, such as "read_this_file()".
+  # ========================================================================= #
+  def read_this_file_with_default_encoding(
+      this_file
+    )
+    File.read(this_file, encoding: ::Studium.main_encoding?)
+  end; alias read_as_string_with_default_encoding read_this_file_with_default_encoding # === read_as_string_with_default_encoding
+       alias read_file                            read_this_file_with_default_encoding # === read_file
+       alias read_this_file                       read_this_file_with_default_encoding # === read_this_file
+       alias read_file_with_default_encoding      read_this_file_with_default_encoding # === read_file_with_default_encoding
+       alias read_in_with_default_encoding        read_this_file_with_default_encoding # === read_in_with_default_encoding
+
+  # ========================================================================= #
+  # === german_date_notation
+  #
+  # Give a Range as input, and it will give us back a String that
+  # shows german date notation, aka DD.MM.YYYY.
+  # ========================================================================= #
+  def german_date_notation(
+      i, use_this_token_as_separator = '-'
+    )
+    # ======================================================================= #
+    # === Handle Range objects next
+    # ======================================================================= #
+    if i.is_a? Range
+      start_date  = i.begin
+      end_date    = i.end
+      start_day   = start_date.day.to_s.rjust(2, '0')
+      start_month = start_date.month.to_s.rjust(2, '0')
+      start_year  = start_date.year.to_s
+      end_day     = end_date.day.to_s.rjust(2, '0')
+      end_month   = end_date.month.to_s.rjust(2, '0')
+      end_year    = end_date.year.to_s
+      i = start_day+'.'+start_month+'.'+start_year+' '+
+          use_this_token_as_separator+' '+
+          end_day+'.'+end_month+'.'+end_year
+    # ======================================================================= #
+    # === Handle Time objects next
+    #
+    # This requires no token.
+    # ======================================================================= #
+    elsif i.is_a? Time
+      i = "#{i.day.to_s.rjust(2, '0')}."\
+          "#{i.month.to_s.rjust(2, '0')}."\
+          "#{i.year.to_s}"
+    end
+    return i
+  end; alias german_notation                german_date_notation # === german_notation
+       alias to_german_date                 german_date_notation # === to_german_date
+       alias german_formatting_for_the_date german_date_notation # === german_formatting_for_the_date
+
+  # ========================================================================= #
+  # === show_todays_date
+  # ========================================================================= #
+  def show_todays_date
+    e "Today is the #{slateblue(today?)} (#{lightgreen(weekday?)})"
+    e
+  end
+
+  # ========================================================================= #
+  # === ensure_that_a_base_directory_exists_for_this_file
+  #
+  # This method expects a file path, such as "/tmp/foo/bar.html".
+  #
+  # If such a file path is passed to this method then this
+  # method will try to ensure that /tmp/foo/ exists (the directory).
+  # ========================================================================= #
+  def ensure_that_a_base_directory_exists_for_this_file(i)
+    _ = File.dirname(i)
+    unless File.directory?(_)
+      FileUtils.mkdir_p(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === does_this_line_include_a_german_weekday?
+  # ========================================================================= #
+  def does_this_line_include_a_german_weekday?(i)
+    ARRAY_GERMAN_WEEKDAYS.any? {|this_german_weekday|
+      i.include? this_german_weekday
+    }
+  end
+
+  # ========================================================================= #
+  # === does_this_line_include_an_english_weekday?
+  # ========================================================================= #
+  def does_this_line_include_an_english_weekday?(i)
+    ARRAY_ENGLISH_WEEKDAYS.any? {|this_english_weekday|
+      i.include? this_english_weekday
+    }
+  end
+
+  # ========================================================================= #
+  # === english_to_german_weekday
+  #
+  # This method will simply convert e. g. "Monday" into "Montag". In other
+  # words: it will convert from the english name for a day into the
+  # german name of that day.
+  # ========================================================================= #
+  def english_to_german_weekday(english_day)
+    ENGLISH_TO_GERMAN_WEEKDAYS[english_day]
+  end; alias english_to_german english_to_german_weekday # === english_to_german
+
+  # ========================================================================= #
+  # === n_days_difference_from_today_to_this_day
+  #
+  # This method will return a number, which is the amount of days between
+  # weekdays.
+  #
+  # The days are numbered like this:
+  #
+  #    Monday:    1
+  #    Tuesday:   2
+  #    Wednesday: 3
+  #    Thursday:  4
+  #    Friday:    5
+  #    Saturday:  6
+  #    Sunday:    0
+  #
+  # So, how to calculate the time difference to the next day?
+  #
+  # Well, say we have the current day be a Wednesday, and the day that is
+  # to be compared, a Friday. The difference is thus (5 - 3 = 2). If the
+  # current day is a Saturday, and the input-day is a Friday, then
+  # the difference must be 5.
+  #
+  # If we have, for example, "Friday" to "Tuesday", then this method
+  # should return the number 4, because the distance is that: Friday,
+  # Saturday, Sunday and Monday (the start day has to be included, as
+  # lectures can happen on that day still, e. g. if you check early
+  # in the morning, you could still have courses in the evening
+  # slots scheduled).
+  # ========================================================================= #
+  def n_days_difference_from_today_to_this_day(
+      time_now = Time.now,
+      name_of_the_future_day # ← This ought to be a String, such as "Monday".
+    )
+    n_days_difference = 0
+    weekday_as_number = time_now.wday
+    name_of_the_future_day = name_of_the_future_day.dup if name_of_the_future_day.frozen?
+    name_of_the_future_day.strip! # We better strip that input.
+    start_day = Date::DAYNAMES[weekday_as_number]
+    # ======================================================================= #
+    # The next is simply a hardcoded table. We will begin with the
+    # future day.
+    # ======================================================================= #
+    n_days_difference =
+    case start_day
+    when 'Monday'
+      case name_of_the_future_day
+      when 'Tuesday'   then 1
+      when 'Wednesday' then 2
+      when 'Thursday'  then 3
+      when 'Friday'    then 4
+      when 'Saturday'  then 5
+      when 'Sunday'    then 6
+      end
+    when 'Tuesday'
+      case name_of_the_future_day
+      when 'Wednesday' then 1
+      when 'Thursday'  then 2
+      when 'Friday'    then 3
+      when 'Saturday'  then 4
+      when 'Sunday'    then 5
+      when 'Monday'    then 6
+      end
+    when 'Wednesday'
+      case name_of_the_future_day
+      when 'Thursday'  then 1
+      when 'Friday'    then 2
+      when 'Saturday'  then 3
+      when 'Sunday'    then 4
+      when 'Monday'    then 5
+      when 'Tuesday'   then 6
+      end
+    when 'Thursday'
+      case name_of_the_future_day
+      when 'Friday'    then 1
+      when 'Saturday'  then 2
+      when 'Sunday'    then 3
+      when 'Monday'    then 4
+      when 'Tuesday'   then 5
+      when 'Wednesday' then 6
+      end
+    when 'Friday'
+      case name_of_the_future_day
+      when 'Saturday'  then 1
+      when 'Sunday'    then 2
+      when 'Monday'    then 3
+      when 'Tuesday'   then 4
+      when 'Wednesday' then 5
+      when 'Thursday'  then 6
+      end
+    when 'Saturday'
+      case name_of_the_future_day
+      when 'Sunday'    then 1
+      when 'Monday'    then 2
+      when 'Tuesday'   then 3
+      when 'Wednesday' then 4
+      when 'Thursday'  then 5
+      when 'Friday'    then 6
+      end
+    when 'Sunday'
+      case name_of_the_future_day
+      when 'Monday'    then 1
+      when 'Tuesday'   then 2
+      when 'Wednesday' then 3
+      when 'Thursday'  then 4
+      when 'Friday'    then 5
+      when 'Saturday'  then 6
+      end
+    end
+    return n_days_difference
+  end
+
+  # ========================================================================= #
+  # === return_lva_number_of_this_lecture
+  # ========================================================================= #
+  def return_lva_number_of_this_lecture(this_lecture)
+    ::Studium.return_lva_number_of_this_lecture(this_lecture)
+  end
+
+  # ========================================================================= #
+  # === csv_file?
+  #
+  # This method is only useful on my home setup.
+  # ========================================================================= #
+  def csv_file?
+    FILE_PASSED_EXAMS_PER_MONTH
+  end
+
+  # ========================================================================= #
+  # === does_this_line_include_a_html_colour?
+  # ========================================================================= #
+  def does_this_line_include_a_html_colour?(i)
+    ::Colours.does_this_line_include_a_html_colour?(i)
+  end
+
+  # ========================================================================= #
+  # === translate_dd_mm_yyyy_to_weekday
+  #
+  # This method will return the weekday of a given dd.mm.yyyy date.
+  #
+  # If the given input is, for example, the String '25.02.2019', then
+  # this method will return the String 'Monday'.
+  # ========================================================================= #
+  def translate_dd_mm_yyyy_to_weekday(
+      i = '25.02.2020'
+    )
+    weekday?(i)
+  end; alias translate_dd_mm_yyy_to_weekday translate_dd_mm_yyyy_to_weekday # === translate_dd_mm_yyy_to_weekday
+
+  # ========================================================================= #
+  # === hh_mm_ss_dd_mm_yyyy
+  # ========================================================================= #
+  def hh_mm_ss_dd_mm_yyyy(i)
+    "#{hh_mm_ss(i)}-#{dd_mm_yyyy(i)}"
+  end
+
+  # ========================================================================= #
+  # === replace_all_html_colours_in_this
+  #
+  # This method will replace all HTML colours, such as <slateblue>, with
+  # the corresponding RGB colour variant for the commandline. Typically
+  # this refers to a terminal such as the KDE konsole, and a shell such
+  # as bash (although other shells are fine too, and many other terminals,
+  # such as the gnome-terminal, most likely will work fine as well - but
+  # it is optimized for the KDE konsole).
+  #
+  # This method should only be called after a prior check was done, to
+  # determine whether the given input String at hand does indeed
+  # include a valid HTML colour. This can be done via a call to
+  # the method called line_contains_a_valid_html_colour?().
+  # ========================================================================= #
+  def replace_all_html_colours_in_this(
+      i,
+      use_this_colour_for_the_default_colour = colour_for_questions?
+    )
+    # ======================================================================= #
+    # bl $RUBY_COLOURS/toplevel_methods/replace_all_html_colours_in_this_line.rb
+    # ======================================================================= #
+    ::Colours.replace_all_html_colours_in_this_line(
+      i, use_this_colour_for_the_default_colour
+    )
+  end
+
+  # ========================================================================= #
+  # === return_local_path_of_this_pwdstud
+  # ========================================================================= #
+  def return_local_path_of_this_pwdstud(i = 1)
+    Studium.return_local_path_of_this_pwdstud(i)
+  end
+
+  # ========================================================================= #
+  # === already_solved_this_lva_number?
+  # ========================================================================= #
+  def already_solved_this_lva_number?(i)
+    Studium.already_solved_this_lva_number?(i)
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    @internal_hash[:debug]
+  end
+
+  # ========================================================================= #
+  # === german_weekday?
+  #
+  # This method will return a german weekday, for the given input. The
+  # input should be the specific wday at hand.
+  # ========================================================================= #
+  def german_weekday?(
+      i = Date.today.wday
+    )
+    weekday?(i, :german)
+  end; alias weekday_at     german_weekday? # === weekday_at
+       alias german_weekday german_weekday? # === german_weekday
+
+  # ========================================================================= #
+  # === directory_to_the_exam_topics?
+  #
+  # This method will point to the directory where all exam topics
+  # are normally kept; it is simply a "wrapper-method".
+  # ========================================================================= #
+  def directory_to_the_exam_topics?
+    Studium.directory_to_the_exam_topics?
+  end; alias exam_topics_directory? directory_to_the_exam_topics? # === exam_topics_directory?
+       alias exam_topic_directory?  directory_to_the_exam_topics? # === exam_topic_directory?
+
+  # ========================================================================= #
+  # === opnn
+  #
+  # The method also handles blocks.
+  # ========================================================================= #
+  def opnn(
+      i = namespace?,
+      &block
+    )
+    if use_opn?
+      if i.is_a? String # "Turn" it into a Hash here.
+        i = { namespace: i }
+      end
+      Opn.opn(i, &block)
+    end
+  end
+
+  # ========================================================================= #
+  # === is_this_a_valid_html_colour?
+  #
+  # This method will let us know whether the given input is a valid (aka
+  # registered) "html colour". An example for this would be the String
+  # 'slateblue'.
+  # ========================================================================= #
+  def is_this_a_valid_html_colour?(i)
+    ::Studium.is_this_a_valid_html_colour?(i)
+  end; alias is_this_colour_a_html_colour? is_this_a_valid_html_colour? # === is_this_colour_a_html_colour?
+
+  # ========================================================================= #
+  # === remove_weekday_names_from
+  #
+  # This method will remove Strings such as "Monday" or "Montag" from
+  # the given input argument.
+  # ========================================================================= #
+  def remove_weekday_names_from(i)
+    Studium.remove_weekday_names_from(i)
+  end; alias remove_weekname_from      remove_weekday_names_from # === remove_weekname_from
+       alias remove_weekdays           remove_weekday_names_from # === remove_weekdays
+       alias remove_weekday_names_from remove_weekday_names_from # === remove_weekday_names_from
+       alias remove_weeknames_from     remove_weekday_names_from # === remove_weeknames_from
+       alias remove_weeknames          remove_weekday_names_from # === remove_weeknames
+       alias remove_weekday_name       remove_weekday_names_from # === remove_weekday_name
+
+  # ========================================================================= #
+  # === return_name_of_the_weekday
+  #
+  # This method can be used to return an associated weekday to a specific
+  # date, such as '22.02.2018'. The format has to be in dd.mm.yyyy.
+  #
+  # As mnemonic-helper, Roebe.return_german_weekday "22.11.2022" would
+  # yield the String "Dienstag".
+  # ========================================================================= #
+  def return_name_of_the_weekday(
+      i = :today
+    )
+    begin
+      require 'roebe/constants/time.rb'
+    rescue LoadError; end
+    case i
+    # ======================================================================= #
+    # === :today
+    # ======================================================================= #
+    when :today
+      i = Roebe.return_german_weekday(i) if Object.const_defined? :Roebe
+    end
+    if i.include? ','
+      splitted = i.split(',')
+      first = splitted.first
+      if first.count('.') > 1
+        return Roebe.return_german_weekday(first) if Object.const_defined? :Roebe
+      end
+    else
+      return i
+    end
+  end; alias return_weekday return_name_of_the_weekday # === return_weekday
+
+  # ========================================================================= #
+  # === has_year_entry?
+  #
+  # This method will return a Boolean.
+  #
+  # It will return true if the line has a year entry such as '2018'; and
+  # it will return false, otherwise.
+  # ========================================================================= #
+  def has_year_entry?(this_line)
+    this_line =~ /\d{4}/ # If this line has at the least one entry with 4 numbers.
+  end; alias this_line_has_a_year_entry? has_year_entry? # === has_year_entry?
+
+  # ========================================================================= #
+  # === do_these_curricula_include_both_a_bachelor_and_a_master_curriculum?(i)
+  #
+  # The input to this method should be an Array.
+  # ========================================================================= #
+  def do_these_curricula_include_both_a_bachelor_and_a_master_curriculum?(i)
+    result = false
+    if i.any? {|entry| entry.start_with?('033')} and
+       i.any? {|entry| entry.start_with?('066')}
+      result = true
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === bachelor_master_or_diploma
+  #
+  # For a given solved lecture, we will determine whether it belongs
+  # to a Bachelor (B), Master (M) or Diploma (D) curriculum.
+  #
+  # For the line:
+  #
+  #   13.05.2020 | 1.0 |  1.0 | 1 |   BOKU  |   M  |   SE  |   940003   | 2020S | Emerging Topics in RNA Biology (in Eng.)
+  #         0       1      2    3      4        5
+  #
+  # It would be at 5.
+  # ========================================================================= #
+  def bachelor_master_or_diploma(
+      this_lecture, dataset = nil
+    )
+    if dataset.nil? and File.exist? FILE_PASSED_EXAMS_PER_MONTH
+      dataset = File.readlines(FILE_PASSED_EXAMS_PER_MONTH).reject {|line|
+        line.strip.empty? or
+        line.strip.start_with?('#')
+      }
+    end
+    selection = dataset.select {|line|
+      splitted = this_lecture.split(' ')
+      lecture_id = splitted.first
+      course_name = splitted[1..-1].join(' ').strip
+      line.include?(lecture_id) and
+      line.include?(course_name)
+    }
+    if selection.empty?
+      '(unknown)'
+    else
+      selection = selection.first
+      return selection.split('|')[5].strip 
+    end
+  end
+
+  # ========================================================================= #
+  # === return_name_of_this_curriculum
+  #
+  # This method will return the official name of a curriculum. In order
+  # to achieve this, the method will read the file, and grab the second
+  # line, which should contain the name of the curriculum at hand.
+  #
+  # This method will NOT remove strings such as "Bachelorcurriculum"
+  # or "Mastercurriculum", due to the individual vector-curriculum
+  # having the very same name (Bachelor + Master).
+  # ========================================================================= #
+  def return_name_of_this_curriculum(i)
+    file = return_file_for_this_curriculum(i)
+    if file.nil?
+      e "Something went wrong for the input #{steelblue(i)}."
+      e 'No match could be found for it. Are you sure that it must exist?'
+      exit
+    elsif File.exist? file
+      dataset = readlines_with_proper_encoding(file)
+      name = dataset[1].delete('#=').strip
+      return name
+    end
+  end; alias return_long_name_of_this_curriculum return_name_of_this_curriculum # === return_long_name_of_this_curriculum
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === return_all_registered_curricula
+  # ========================================================================= #
+  def return_all_registered_curricula
+    Studium.return_registered_standalone_curricula
+  end
+
+  # ========================================================================= #
+  # === return_dataset_from_this_curriculum_file
+  # ========================================================================= #
+  def return_dataset_from_this_curriculum_file(i)
+    return Studium.return_dataset_from_this_curriculum_file(i)
+  end; alias return_dataset_for_this_curriculum_file return_dataset_from_this_curriculum_file # === return_dataset_for_this_curriculum_file
+       alias return_dataset_from_this_curriculum     return_dataset_from_this_curriculum_file # === return_dataset_from_this_curriculum
+       alias return_this_curriculum                  return_dataset_from_this_curriculum_file # === return_this_curriculum
+
+  # ========================================================================= #
+  # === ensure_that_the_log_directory_exists
+  #
+  # This method will try to make sure that the log directory exists.
+  # ========================================================================= #
+  def ensure_that_the_log_directory_exists
+    _ = log_dir?
+    unless File.directory? _
+      mkdir(_)
+    end
+    unless File.directory? "#{_}html/"
+      mkdir("#{_}html/")
+    end
+  end
+
+  # ========================================================================= #
+  # === from_curriculum_id_to_university
+  #
+  # This method will translate from the curriculum-ID to the university.
+  # So it will return a String such as "BOKU".
+  # ========================================================================= #
+  def from_curriculum_id_to_university(id)
+    ::Studium.from_curriculum_id_to_university(id)
+  end; alias from_curriculum_number_to_university from_curriculum_id_to_university # === from_curriculum_number_to_university
+       alias which_university?                    from_curriculum_id_to_university # === which_university?
+
+  # ========================================================================= #
+  # === return_name_of_this_curriculum_based_on_its_id_number
+  #
+  # The input to this method should be the ID of a curriculum number,
+  # ideally as a String, such as '033290'.
+  # ========================================================================= #
+  def return_name_of_this_curriculum_based_on_its_id_number(i)
+    ::Studium.map_curriculum_number_to_curriculum_name(i)
+  end; alias from_curriculum_id_to_curriculum_name                     return_name_of_this_curriculum_based_on_its_id_number # === from_curriculum_id_to_curriculum_name
+       alias return_curriculum_name_of_this_curriculum_number          return_name_of_this_curriculum_based_on_its_id_number # === return_curriculum_name_of_this_curriculum_number
+       alias curriculum_number_to_curriculum_name                      return_name_of_this_curriculum_based_on_its_id_number # === curriculum_number_to_curriculum_name
+       alias name_of_this_curriculum?                                  return_name_of_this_curriculum_based_on_its_id_number # === name_of_this_curriculum?
+       alias return_name_of_the_curriculum_based_on_this_curriculum_id return_name_of_this_curriculum_based_on_its_id_number # === return_name_of_the_curriculum_based_on_this_curriculum_id
+       alias return_name_of_the_curriculum                             return_name_of_this_curriculum_based_on_its_id_number # === return_name_of_the_curriculum
+       alias turn_id_to_curriculum_name                                return_name_of_this_curriculum_based_on_its_id_number # === turn_id_to_curriculum_name
+
+  # ========================================================================= #
+  # === return_all_bachelor_lectures
+  #
+  # This method will simply return all bachelor-lectures.
+  # ========================================================================= #
+  def return_all_bachelor_lectures(
+      from_this_dataset = ::Studium.main_dataset?
+    )
+    if from_this_dataset.nil?
+      ::Studium.initialize_main_dataset
+      from_this_dataset = ::Studium.main_dataset?
+    end
+    from_this_dataset.select {|name_of_the_lecture, inner_hash|
+      array = inner_hash['curricula']
+      is_a_bachelor_lecture?(array)
+    }
+  end
+
+  # ========================================================================= #
+  # === has_a_bachelor_and_a_master_curriculum?
+  # ========================================================================= #
+  def has_a_bachelor_and_a_master_curriculum?(i)
+    has_a_bachelor_curriculum?(i) and has_a_master_curriculum?(i)
+  end
+
+  # ========================================================================= #
+  # === available_topics_as_short_name
+  # ========================================================================= #
+  def available_topics_as_short_name
+    ::Studium::Exams.all_topics_as_short_name.sort
+  end; alias available_topics?      available_topics_as_short_name # === available_topics?
+       alias exam_topics?           available_topics_as_short_name # === exam_topics?
+       alias return_all_exam_topics available_topics_as_short_name # === return_all_exam_topics
+       alias available_exam_topics? available_topics_as_short_name # === available_exam_topics?
+  
+  # ========================================================================= #
+  # === return_n_exam_questions_in
+  #
+  # This method will return how many exam questions are in the given topic
+  # xyz.
+  # ========================================================================= #
+  def return_n_exam_questions_in(this_topic)
+    Studium::Exams.return_n_questions_in_this_topic(this_topic)
+  end
+
+  # ========================================================================= #
+  # === return_lectures_with_at_the_least_one_upcoming_exam
+  #
+  # This method will return all lectures that have at the least
+  # one upcoming exam entry. In this context "upcoming" refers
+  # to an exam date that comes after today (or any day before
+  # today).
+  # ========================================================================= #
+  def return_lectures_with_at_the_least_one_upcoming_exam
+    today = Time.now
+    return_sanitized_dataset_from_the_file_lecture_information.select {|name_of_the_course, hash_dataset|
+      if hash_dataset.has_key? 'exams'
+        exams = hash_dataset['exams']
+        if exams.is_a? Array
+          exams = exams.first
+        end
+        exams = remove_german_weekdays(exams)
+        exams.delete!(',')
+        if exams.include? 'Ort:'
+          exams = exams.split('Ort:').first.to_s
+        end
+        # =================================================================== #
+        # The next line can be problematic, if the entry is incorrect.
+        # Hence the rescue-clause.
+        # =================================================================== #
+        begin
+          time_parsed = Time.parse(exams)
+        rescue Exception => error
+          pp error
+          e rev+'The original input was: '+
+             tomato(hash_dataset['exams'])
+          e 'The modified input was: '+
+             steelblue(exams)
+          exit
+        end
+        today < time_parsed # Check that the courses are not too old.
+      else
+        false
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === read_dataset_from_a_curriculum_file
+  # ========================================================================= #
+  def read_dataset_from_a_curriculum_file(
+      i,
+      optional_commands = :remove_comments
+    )
+    Studium.read_dataset_from_a_curriculum_file(i, optional_commands)
+  end
+
+  # ========================================================================= #
+  # === has_a_bachelor_curriculum?
+  #
+  # This method will return true if the given Array has any bachelor
+  # curriculum; and it will return false otherwise.
+  # ========================================================================= #
+  def has_a_bachelor_curriculum?(array)
+    Studium.has_a_bachelor_curriculum?(array)
+  end; alias has_a_bachelor_curriculum_entry?         has_a_bachelor_curriculum? # === has_a_bachelor_curriculum_entry?
+       alias is_a_bachelor_lecture?                   has_a_bachelor_curriculum? # === is_a_bachelor_curriculum?
+       alias is_a_bachelor_curriculum?                has_a_bachelor_curriculum? # === is_a_bachelor_curriculum?
+       alias does_this_include_a_bachelor_curriculum? has_a_bachelor_curriculum? # === does_this_include_a_bachelor_curriculum?
+
+  require 'studium/toplevel_methods/map_input_to_this_curriculum_filename.rb'
+  # ========================================================================= #
+  # === map_input_to_this_curriculum_filename
+  # ========================================================================= #
+  def map_input_to_this_curriculum_filename(i)
+    ::Studium.map_input_to_this_curriculum_filename(i)
+  end
+
+  # ========================================================================= #
+  # === chmod
+  #
+  # The second argument can also be an Array.
+  # ========================================================================= #
+  def chmod(
+      new_mode   = 0644,
+      which_file = 'LINKS.md'
+    )
+    FileUtils.chmod(new_mode, which_file)
+  end
+
+  # ========================================================================= #
+  # === does_this_line_start_with_a_german_weekday?
+  # ========================================================================= #
+  def does_this_line_start_with_a_german_weekday?(i)
+    result = false
+    if i.include?(' ')
+      i = i.dup
+      if i.start_with?(' - "')
+        i[0, 4] = ''
+      end
+      splitted = i.split(' ')
+      first    = splitted.first
+      if is_german_weekday?(first)
+        result = true
+      end
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === return_either_grey_or_the_custom_colour_for_answers
+  # ========================================================================= #
+  def return_either_grey_or_the_custom_colour_for_answers
+    _ = grey('').strip
+    if @internal_hash[:custom_colours] and
+       @internal_hash[:custom_colours].has_key?('colour_for_answers')
+      _ = COLOURS.send(@internal_hash[:custom_colours]['colour_for_answers']) { :omit_end }
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === studium_log_dir?
+  #
+  # This is the log dir - where we "operate on".
+  # ========================================================================= #
+  def studium_log_dir?
+    Studium.log_dir?
+  end; alias log_dir?  studium_log_dir? # === log_dir?
+       alias base_dir? studium_log_dir? # === base_dir?
+
+  # ========================================================================= #
+  # === return_hour_from_this
+  #
+  # This method will extract the time-format from a String,
+  # such as:
+  #
+  #   "18.02.2020, 17:00-18:00"
+  #   "Dienstag 13.10.2020, 14:30-17:45"
+  #
+  # A String will be returned in this event, holding the start and
+  # stop time - for instance, in the first example it would return
+  # the String "17:00-18:00".
+  #
+  # A String should be given as argument to this method.
+  # ========================================================================= #
+  def return_hour_from_this(i)
+    i.scan(
+      /\d{2}:\d{2}-\d{2}:\d{2}/
+    ).flatten.first.to_s.strip
+  end; alias extract_the_time_from return_hour_from_this # === extract_the_time
+
+  # ========================================================================= #
+  # === sort_these_lecture_names_by_time
+  # ========================================================================= #
+  def sort_these_lecture_names_by_time(
+      array, weekday
+    )
+    _ = main_dataset?
+    array.sort_by {|entry|
+      pointer = _[entry]
+      lva_date = pointer['lva_dates'].select {|inner_entry|
+        inner_entry.include? weekday
+      }
+      lva_date = lva_date.first if lva_date.is_a? Array
+      lva_date = return_hour_from_this(lva_date) # This will be like "08:00-09:45"
+      # ===================================================================== #
+      # However had, we only need the last part, so chop it down.
+      # ===================================================================== #
+      if lva_date.include? '-'
+        lva_date = lva_date.split('-').first
+      end
+      timestamp = Time.parse(lva_date)
+      timestamp # And "return" it here.
+    }
+  end
+
+  # ========================================================================= #
+  # === number_to_month
+  #
+  # This method will convert a number, such as 6, to the corresponding
+  # month entry.
+  # ========================================================================= #
+  def number_to_month(i)
+    array = Date::MONTHNAMES
+    i = i.to_i
+    return array[i]
+  end
+
+  # ========================================================================= #
+  # === return_hh_mm_ss_from
+  #
+  # Input to this method may be like this:
+  #
+  #   2020-03-04 00:00:00 +0000
+  #
+  # It will then return the ss:mm:hh notation.
+  # ========================================================================= #
+  def return_hh_mm_ss_from(i = Time.now)
+    if i.is_a? String
+      i = Time.parse(i)
+    end
+    if i.is_a? Time
+      "#{i.hour.to_s.rjust(2,'0')}:"\
+      "#{i.min.to_s.rjust(2,'0')}:"\
+      "#{i.sec.to_s.rjust(2,'0')}"
+    else
+      e 'Unknown time format.'
+    end
+  end; alias hh_mm_ss return_hh_mm_ss_from # === hh_mm_ss
+
+  # ========================================================================= #
+  # === datum?
+  # ========================================================================= #
+  def datum?
+    Studium.datum? # ← Available in "studium/toplevel_methods/time.rb".
+  end
+
+  # ========================================================================= #
+  # === this_month_has_n_days?
+  #
+  # This method will return the maximum amount of days in the given
+  # month.
+  # ========================================================================= #
+  def this_month_has_n_days?(
+      this_month,
+      this_year = Time.now.year
+    )
+    this_month = this_month.to_i
+    return 29 if this_month == 2 && Date.gregorian_leap?(this_year)
+    COMMON_YEAR_DAYS_IN_MONTH[this_month] 
+  end
+
+  # ========================================================================= #
+  # === return_n_days_until_sunday
+  # ========================================================================= #
+  def return_n_days_until_sunday(
+      time_now = Time.now
+    )
+    n_days_difference_from_today_to_this_day(time_now, 'Sunday')
+  end
+
+  # ========================================================================= #
+  # === return_current_year
+  #
+  # This method will simply return the current year, as String.
+  # ========================================================================= #
+  def return_current_year
+    Time.now.year.to_s
+  end; alias current_year? return_current_year # === current_year?
+
+  # ========================================================================= #
+  # === return_dd_mm_yy_and_time_from
+  #
+  # This method will return the day, in dd.mm.yyyy format, and the
+  # time on that date. You have to pass in a special object to this
+  # method, such as an instance of class Time - see methods used
+  # such as .day() or .month() and so forth.
+  # ========================================================================= #
+  def return_dd_mm_yy_and_time_from(i)
+    Studium.return_dd_mm_yy_and_time_from(i)
+  end
+
+  # ========================================================================= #
+  # === current_semester?
+  #
+  # This method will either return the Symbol :summer or it will return
+  # the Symbol :winter. This will be based on the current time (today).
+  # ========================================================================= #
+  def current_semester?
+    today = ::Time.now
+    # ======================================================================= #
+    # Next we must determine whether we have the Range in winter or the
+    # Range in summer.
+    # ======================================================================= #
+    current_year = current_year?.to_i
+    next_year    = current_year+1
+    winter_range = ( Date.parse('01.10.'+current_year.to_s) .. Date.parse('28.02.'+next_year.to_s) )
+    min_winter_day = winter_range.min
+    max_winter_day = winter_range.max
+    summer_range = ( Date.parse('01.03.'+current_year.to_s) .. Date.parse('30.09.'+current_year.to_s) )
+    min_summer_day = summer_range.min
+    max_summer_day = summer_range.max
+    # ======================================================================= #
+    # Ok, we have all the required dates. Now we have to check on the variable
+    # today to find out in which range we are in.
+    # ======================================================================= #
+    if min_winter_day <= today.to_datetime and max_winter_day >= today.to_datetime
+      # e 'Yes, the queried date is part of the date-range.'
+      :winter
+    else
+      # e 'No, the queried date is NOT part of the date-range.'
+      if min_summer_day <= today.to_datetime and max_summer_day >= today.to_datetime
+        :summer
+      else
+        :impossible_situation_check_for_flaw_in_the_code
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === day_month_year
+  #
+  # This method will return a dd.mm.yyyy notation.
+  #
+  # If you need to find out whether the given input-day is today, then
+  # use the method called .is_this_day_today?, defined in this file.
+  #
+  # An example for this will be:
+  #
+  #   03.04.2020
+  #
+  # ========================================================================= #
+  def day_month_year(
+      use_this_time = Time.now
+    )
+    if use_this_time.is_a? Time
+      use_this_time.strftime('%d.%m.%Y')
+    else
+      use_this_time
+    end
+  end; alias today?                day_month_year # === today?
+       alias return_day_month_year day_month_year # === return_day_month_year
+       alias dd_mm_yyyy            day_month_year # === dd_mm_yyyy
+       alias return_dd_mm_yyyy     day_month_year # === return_dd_mm_yyyy
+       alias time_today            day_month_year # === time_today
+
+  # ========================================================================= #
+  # === parse_dd_mm_yyyy
+  # ========================================================================= #
+  def parse_dd_mm_yyyy(
+      i = '03.05.2023'
+    )
+    if i.is_a? String
+      if i.include? ' '
+        i = i.split(' ').last.to_s.strip
+      end
+      return ::Time.parse(i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === is_this_day_today?
+  #
+  # This method will return true or false, depending on whether the given
+  # input is assumed to be the present day or not.
+  #
+  # The method assumes that the input will be a Time object normally.
+  # ========================================================================= #
+  def is_this_day_today?(
+      i = '18.02.2022'
+    )
+    dd_mm_yyyy(Time.now) == dd_mm_yyyy(i)
+  end
+
+  # ========================================================================= #
+  # === weekday?
+  #
+  # This method will return a String such as "Thursday". Note that the
+  # english name will be returned by default. This can be changed via
+  # the second parameter to this method, which can be either :english
+  # or :german.
+  #
+  # The input to this method should be a number, such as can be obtained
+  # via the method .wday().
+  #
+  # A String can also be passed into this method, in a form like
+  # "dd.mm.yyyy". So, an input String such as "10.03.2018" is
+  # perfectly valid.
+  # ========================================================================= #
+  def weekday?(
+      i                 = Date.today.wday,
+      use_this_language = :english
+    )
+    if i.is_a?(String) and i.include?('.')
+      # ===================================================================== #
+      # In this case here assume an input-String such as "12.03.2018".
+      # ===================================================================== #
+      begin
+        i = Time.parse(i).wday
+      rescue ArgumentError => error
+        pp error
+      end
+    end
+    result = Date::DAYNAMES[i]
+    case use_this_language
+    # ======================================================================= #
+    # === :german
+    # ======================================================================= #
+    when :german,
+         :use_german
+      # ===================================================================== #
+      # In this case we have to translate to the german name.
+      # ===================================================================== #
+      result = ENGLISH_TO_GERMAN_WEEKDAYS[result]
+    end
+    return result
+  end; alias return_name_for_this_day       weekday? # === return_name_for_this_day
+       alias return_weekday_for             weekday? # === return_weekday_for
+       alias return_weekday_of              weekday? # === return_weekday_of
+       alias return_weekday_from_this_input weekday? # === return_weekday_from_this_input
+       alias english_weekday                weekday? # === english_weekday
+       alias english_weekday?               weekday? # === english_weekday?
+
+  # ========================================================================= #
+  # === open_in_browser
+  # ========================================================================= #
+  def open_in_browser(i)
+    try_to_require_the_open_gem unless Object.const_defined?(:Open)
+    Open.in_browser(i)
+  end
+
+  # ========================================================================= #
+  # === require_open_uri
+  # ========================================================================= #
+  def require_open_uri
+    require 'open-uri'
+  end
+
+  # ========================================================================= #
+  # === write_what_into
+  #
+  # Use this method to save data into a specific file.
+  # ========================================================================= #
+  def write_what_into(
+      what,
+      into,
+      &block
+    )
+    Studium.write_what_into(what, into, &block)
+  end; alias store_what_into write_what_into # === store_what_into
+
+  # ========================================================================= #
+  # === return_either_grey_or_the_custom_colour_for_questions
+  # ========================================================================= #
+  def return_either_grey_or_the_custom_colour_for_questions(
+      custom_colours = @internal_hash[:custom_colours]
+    )
+    _ = grey('').strip
+    if custom_colours and
+       custom_colours.has_key?('colour_for_questions')
+      _ = COLOURS.send(custom_colours['colour_for_questions']) { :omit_end }
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  #
+  # This query-method won't be valid for all subclasses, but I consider it
+  # useful to have it enabled by default - that way we can avoid having
+  # to define it for those subclasses that make use of it.
+  # ========================================================================= #
+  def dataset?
+    @internal_hash[:dataset]
+  end
+
+  # ========================================================================= #
+  # === course_filter
+  #
+  # This method is a generic filter over the dataset made available in
+  # the file lecture_information.yml.
+  # ========================================================================= #
+  def course_filter(
+      dataset    = dataset?,
+      filter_how = :BOKU
+    )
+    act_on_this_entry = :university
+    case filter_how
+    # ======================================================================= #
+    # === :winter
+    # ======================================================================= #
+    when :winter
+      act_on_this_entry = :semester
+    # ======================================================================= #
+    # === :prüfungsimmanent
+    # ======================================================================= #
+    when :prüfungsimmanent
+      act_on_this_entry = :type
+    end
+    return dataset.select {|name_of_the_course, inner_hash|
+      case act_on_this_entry
+      # ===================================================================== #
+      # === :type
+      # ===================================================================== #
+      when :type
+        case filter_how
+        # =================================================================== #
+        # === :prüfungsimmanent
+        # =================================================================== #
+        when :prüfungsimmanent
+          _ = inner_hash[act_on_this_entry]
+          is_prüfungsimmanent?(_)
+        else
+          false
+        end
+      # ===================================================================== #
+      # === :semester
+      # ===================================================================== #
+      when :semester
+        _ = inner_hash[act_on_this_entry]
+        if _
+          _.to_sym == filter_how # e. g. == :winter
+        else
+          e 'nil-entry for '+name_of_the_course+' - please fix this.'
+        end
+      # ===================================================================== #
+      # === :university
+      # ===================================================================== #
+      when :university
+        inner_hash[act_on_this_entry].to_sym == filter_how
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === return_n_days_until_monday
+  # ========================================================================= #
+  def return_n_days_until_monday(
+      time_now = Time.now
+    )
+    n_days_difference_from_today_to_this_day(time_now, 'Monday')
+  end
+
+  # ========================================================================= #
+  # === n_seconds_to_n_days
+  #
+  # A day has 60 seconds * 60 minutes
+  # ========================================================================= #
+  def n_seconds_to_n_days(i)
+    hour = 60 * 60.0
+    one_day = hour * 24
+    return (i / one_day.to_f)
+  end
+
+  # ========================================================================= #
+  # === readlines_from_this_input_file
+  #
+  # This method is essentially File.readlines(), but we also use the
+  # :encoding symbol to denote which Encoding to use.
+  #
+  # As first argument pass in the file path to the target input file.
+  #
+  # You should ideally use this method in a unified way, that is, whenever
+  # you want to read the content of a file make use of this method here.
+  # This makes it easier to have the functionality all in one place.
+  #
+  # Keep in mind that the file in question has to exist locally; the
+  # file here will NOT check whether the given input file exists.
+  # ========================================================================= #
+  def readlines_from_this_input_file(
+      this_file,
+      use_this_encoding = :default_encoding,
+      &block
+    )
+    yielded = nil
+    if block_given?
+      yielded = yield
+    end
+    case use_this_encoding
+    # ======================================================================= #
+    # === :default
+    #
+    # This refers to the default encoding, which is usually UTF-8 (Unicode).
+    # ======================================================================= #
+    when :default,
+         :default_encoding
+      use_this_encoding = ::Studium.main_encoding?
+    end
+    if use_this_encoding.is_a? Hash
+      # ===================================================================== #
+      # === :encoding
+      # ===================================================================== #
+      if use_this_encoding.has_key? :encoding
+        use_this_encoding = use_this_encoding[:encoding]
+      end
+    end
+    if this_file
+      if this_file.is_a? Array
+        return this_file.map {|inner_entry|
+          if File.exist?(inner_entry)
+            inner_entry = File.readlines(inner_entry, encoding: use_this_encoding)
+          end
+          inner_entry
+        }.flatten
+      elsif File.exist?(this_file)
+        return File.readlines(
+          this_file,
+          encoding: use_this_encoding
+        )
+      end
+    else
+      unless yielded == :be_quiet
+        e "Can not read in the file at #{this_file} as it does not exist."
+      end
+      return false
+    end
+  end; alias readlines_via_default_encoding      readlines_from_this_input_file # === readlines_via_default_encoding
+       alias readlines_with_default_encoding     readlines_from_this_input_file # === readlines_with_default_encoding
+       alias readlines_with_the_default_encoding readlines_from_this_input_file # === readlines_with_the_default_encoding
+       alias file_readlines_of_this_file         readlines_from_this_input_file # === file_readlines_of_this_file
+       alias file_readlines                      readlines_from_this_input_file # === file_readlines
+       alias readlines_with_proper_encoding      readlines_from_this_input_file # === readlines_with_proper_encoding
+       alias proper_readlines                    readlines_from_this_input_file # === proper_readlines
+       alias default_readlines                   readlines_from_this_input_file # === default_readlines
+       alias readlines                           readlines_from_this_input_file # === readlines
+       # alias readlines_with_iso_encoding       readlines_from_this_input_file # === readlines_with_iso_encoding
+
+  # ========================================================================= #
+  # === find_corresponding_exam_topic
+  #
+  # This method will try to find the corresponding exam topic, based on a
+  # short given input.
+  #
+  # For instance, 'bem1' will become 'basic biochemistry' and 'amg1'
+  # will become 'allgemeine_genetik'. If no match is found then the
+  # original input will be returned.
+  # ========================================================================= #
+  def find_corresponding_exam_topic(
+      i,
+      be_verbose = be_verbose?
+    )
+    return Studium.find_corresponding_exam_topic(i, be_verbose)
+  end; alias return_file_associated_with_this_exam_topic find_corresponding_exam_topic # === return_file_associated_with_this_exam_topic
+       alias find_corresponding_exam_title               find_corresponding_exam_topic # === find_corresponding_exam_title
+       alias expand_topic                                find_corresponding_exam_topic # === expand_topic
+       alias try_to_find_a_registered_exam_topic         find_corresponding_exam_topic # === try_to_find_a_registered_exam_topic
+
+  # ========================================================================= #
+  # === is_this_a_registered_exam_topic?
+  #
+  # This method must return a boolean - true if the given input is a
+  # registere exam topic; and false otherwise.
+  # ========================================================================= #
+  def is_this_a_registered_exam_topic?(i)
+    original_input = i.dup
+    possibly_expanded_input = try_to_find_a_registered_exam_topic(original_input)
+    return original_input == possibly_expanded_input
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'verbose_truth'
+  alias e puts
+  x = Studium::Base.new
+  # x.current_semester? # This will be :winter or :summer.
+  e x.this_month_has_n_days?('10')
+  e x.this_month_has_n_days?('11')
+  e x.this_month_has_n_days?('12')
+  e 'Do we have konsole support? '+
+    VerboseTruth[
+      x.konsole_support?.to_s
+    ]
+  p x.web_liner
+  Studium::Base.new.directory_to_the_exam_topics?
+  p base.weekday?
+  p base.today?
+  p base.select_lectures_with_this_key(:exam_registration_at)
+end