studium 0.13.1

data/lib/studium/utility_scripts/show_lectures_on_the_commandline/help.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lectures_on_the_commandline/help.rb'
+# =========================================================================== #
+module Studium
+
+class ShowLecturesOnTheCommandline < Base
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # The help options for class Studium::ShowLecturesOnTheCommandline
+  # are stored in this method here.
+  #
+  # To invoke this method, do:
+  #
+  #   show_lectures_on_the_commandline --help
+  #
+  # ========================================================================= #
+  def show_help
+    e
+    opnn { :no_trailing_colon }
+    help_string = <<-EOF
+
+
+The following help-options are available and documented:
+
+EOF
+    e help_string
+    ecomment "  #{slateblue('--available-curricula?')}         # show "\
+             "which curricula are available"
+    ecomment "  #{slateblue('--do-not-show-upcoming-exams')}   # Do not show upcoming exams"
+    ecomment "  #{slateblue('--show-all-URLs')}                # Also "\
+             "show remote URLs of already solved lectures"
+    ecomment "  #{slateblue('--priority-points')}              # Display "\
+             "a curriculum based on priority points"
+    ecomment "  #{slateblue('--use-this-curriculum=foo.md')}   # use "\
+             "this curriculum as specified in the file"
+    e
+  end
+
+end; end

data/lib/studium/utility_scripts/show_lectures_on_the_commandline/html.rb

@@ -0,0 +1,605 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lectures_on_the_commandline/html.rb'
+# =========================================================================== #
+module Studium
+
+class ShowLecturesOnTheCommandline < Base # === Studium::ShowLecturesOnTheCommandline
+
+  require 'studium/constants/web_constants.rb'
+  include Studium::WebConstants
+
+  require 'studium/toplevel_methods/has_this_module_been_completed.rb'
+  require 'studium/toplevel_methods/install_the_project_on_the_given_hostsystem.rb'
+  require 'studium/toplevel_methods/return_div_timetable_of_upcoming_exams.rb'
+  require 'studium/toplevel_methods/rinstall2.rb'
+  require 'studium/utility_scripts/show_lectures_on_the_commandline/sorted_individual_curricula.rb'
+  require 'studium/curricula/modules/return_n_ects_in_this_module.rb'
+
+  begin
+    require 'html_tags'
+  rescue LoadError; end
+
+  begin
+    require 'open'
+  rescue LoadError; end
+
+  begin
+    require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === Studium::ShowLecturesOnTheCommandline::IMAGE_FOR_THE_COMPLETED_MODULE
+  #
+  # This constant resides here because it is only used by this .rb file.
+  # ========================================================================= #
+  IMAGE_FOR_THE_COMPLETED_MODULE =
+    '<img src="/home/x/data/images/studium/COMPLETED_MODULE.png" '\
+    'style="margin-left: 1em; border: 3px solid black">'.dup
+
+  # ========================================================================= #
+  # === return_arrow_pointing_to_the_right_side
+  # ========================================================================= #
+  def return_arrow_pointing_to_the_right_side(
+      optional_margin_left = nil
+    )
+    if optional_margin_left
+      '<img src="/home/x/DATA/images/STD/PFEIL6_red.png" style="margin-left:'+
+      optional_margin_left.to_s+
+      '">'.dup
+    else
+      '<img src="/home/x/DATA/images/STD/PFEIL6_red.png">'.dup
+    end
+  end
+
+  # ========================================================================= #
+  # === do_generate_a_html_file
+  #
+  # This method can be used to generate a .html file no matter what.
+  #
+  # The other method, consider_generating_a_html_file, will instead
+  # honour a certain instance variable.
+  # ========================================================================= #
+  def do_generate_a_html_file
+    consider_generating_a_html_file(true)
+  end
+
+  # ========================================================================= #
+  # === return_timetable_of_upcoming_exams
+  #
+  # This method is for the display of a HTML timetable <div> element.
+  #
+  # It will be near the bottom part of the auto-generated .html file,
+  # if we actually wish to generate a .html file.
+  # ========================================================================= #
+  def return_timetable_of_upcoming_exams
+    # ======================================================================= #
+    # The dataset consists of the lectures that are part of this curriculum.
+    # ======================================================================= #
+    new_hash = {}
+    dataset = @hash_containing_the_lectures_for_this_curriculum
+    # ======================================================================= #
+    # We have to time-sort this.
+    # ======================================================================= #
+    dataset = dataset.sort_by {|name_of_the_lecture, inner_hash|
+      if inner_hash.has_key? 'exams'
+        exams = inner_hash['exams']
+        if exams.is_a? Array
+          exams = exams.first
+          if exams.include? ', '
+            exams = exams.split(', ').first.strip
+          end
+        end
+      else
+        exams = '01.01.2500' # <- Fake time stamp.
+      end
+      if exams.empty?
+        exams = '01.01.2500' # <- Fake time stamp.
+      end
+      Time.parse(exams)
+    }
+    dataset.each {|inner_array|
+      key   = inner_array.first
+      value = inner_array.last
+      new_hash[key] = value
+    }
+    Studium.return_div_timetable_of_upcoming_exams(dataset)
+  end
+
+  # ========================================================================= #
+  # === set_html_string
+  # ========================================================================= #
+  def set_html_string(i)
+    @html_string = i.to_s.dup
+  end
+
+  # ========================================================================= #
+  # === html_string?
+  # ========================================================================= #
+  def html_string?
+    @html_string
+  end
+
+  # ========================================================================= #
+  # === consider_generating_a_html_file                            (html tag)
+  #
+  # This method can generate a .html file. As a consequence it is fairly
+  # long and messy.
+  # ========================================================================= #
+  def consider_generating_a_html_file(
+      i = @generate_html_file
+    )
+
+    if i
+      if is_on_roebe?
+        # =================================================================== #
+        # Install the project first in this case, so that the regexes
+        # are up-to-date. This may take quite some time, so it is better
+        # to move this to the end of the method, after the browser
+        # has loaded the page. Actually - we can not do this if we
+        # want to have up-to-date URLs.
+        # =================================================================== #
+        Studium.install_the_project_on_the_given_hostsystem
+      end
+      html_file = "#{log_dir?}html/"\
+                  "#{title?.to_s.tr(' ','_').delete('(),')}.html"
+      _ = ''.dup
+      if www_mode?
+        # In this case, do not use the <meta> tag and similar entities.
+      else
+        _ << '<meta charset="UTF-8">'  
+        _ << "#{N}<html>#{N}"
+        _ << "<head>#{N}"
+        _ << "<title>#{title?.to_s}</title>#{N}"
+      end
+      # ===================================================================== #
+      # Add tooltip.css next.
+      # ===================================================================== #
+      _ << '<link rel="stylesheet" type="text/css" href="../../../home/x/DATA/CSS/balloon.css">'
+      if www_mode?
+        # And do nothing as well here.
+      else
+        _ << "</head>#{N}"
+        _ << "<body style=\"font-size: 1.5em; "\
+             "font-family: monospace; "\
+             "padding: 1px; "\
+             "margin: 0px\">#{N}" # <- Open the <body> tax here.
+      end
+      _ << '<div style="border: 1px solid black; padding:2px;">'
+      # ===================================================================== #
+      # Add the title of the curriculum next, as a darkblue and bold
+      # <h1> tag. An example for such a title may be a String like
+      # "Bachelorcurriculum Informatik".
+      # ===================================================================== #
+      _ << HtmlTags.h1(
+        title?.to_s, css_style: 'font-weight: bold; color: darkblue'
+      )+N
+      remote_url = ::Studium.return_homepage_of_this_lecture(title?.to_s)
+      _ << '<b style="margin-left:1em">
+      Link to the remote page:
+      </b>
+      <a style="font-weight: bold; color: darkblue" href="'+remote_url+'">'+title?.to_s+'</a>'
+      if show_loaded_from_which_file? and loaded_from_which_file?
+        loaded_from_which_file?.each {|this_file|
+          _ << '<h2 style="color:slateblue; margin-bottom:4px; margin-left: 0.75em;">
+                Loaded from the file:
+                </h2>'+N
+          _ << '<b style="margin-left:2.0em; font-size:larger; color:blue">'+
+                File.basename(this_file)+'</b>
+                ( <span style="font-weight: bold; color:steelblue">'+this_file+'</span> )
+                <br><br><br>'+N
+        }
+      end
+      hash = {}
+      # ===================================================================== #
+      # === Iterate over the lectures here
+      #
+      # Next iterate over all lectures that are part of the curriculum
+      # and build up a temporary Hash, with which we will work.
+      # ===================================================================== #
+      all_lectures?.each {|this_lecture|
+        # =================================================================== #
+        # raw_name_of_the_lecture will also include the lva-id.
+        # =================================================================== #
+        if this_lecture.include? '#' # Handle possible comments next.
+          raw_name_of_the_lecture = this_lecture[0 .. (this_lecture.index('#')-1)].strip
+        else
+          raw_name_of_the_lecture = this_lecture.dup
+        end
+        raw_name_of_the_lecture.squeeze!(' ') # <- Trying this as of March 2018.
+        # =================================================================== #
+        # === Pointer to the lecture-dataset
+        #
+        # Obtain a pointer to the lecture dataset next.
+        # =================================================================== #
+        pointer_to_the_lecture_dataset = @lecture_dataset[raw_name_of_the_lecture]
+        if pointer_to_the_lecture_dataset.nil?
+          next
+        end
+        hash[raw_name_of_the_lecture] = pointer_to_the_lecture_dataset
+      }
+      if @this_curriculum_has_n_ects_points_in_total >= 270.0
+        @individual_curriculum = false
+        # ^^^ ad-hoc hack.
+      end
+      # ===================================================================== #
+      # === Handle modules of an individual curriculum
+      #
+      # Next, if we have an individual curriculum, we will use a slightly
+      # different way to order the modules. How is it determined whether
+      # the given curriculum at hand is an individual one? We will
+      # simply use @individual_curriculum.
+      # ===================================================================== #
+      if @individual_curriculum
+        new_hash = ::Studium::SortedIndividualCurricula.new(hash, name_of_the_curriculum?)
+        # =================================================================== #
+        # Rewrite the variable called `hash` next.
+        # =================================================================== #
+        hash.clear
+        max_value = new_hash.max?
+        max_value = 100000 if max_value.nil?
+        max_value = 100000 if max_value > 100000 # Some bug was found on June 2022. Slight hack...
+        (1 .. max_value).each {|module_number|
+          pointer = new_hash[module_number]
+          if pointer.nil?
+            opnn; e 'A nil-value was found for module number '+
+                    steelblue(module_number)+'.'
+            # e
+            # e 'The hash was:'
+            # e
+            # pp new_hash
+            # e
+          end
+          pointer.each {|name_of_the_lecture, inner_hash|
+            hash[name_of_the_lecture] = inner_hash
+          } if pointer
+        }
+      end
+      @name_of_the_individual_curriculum_module = ''.dup
+      index = 0
+      # ===================================================================== #
+      # === Iterate over all lectures
+      #
+      # Next, iterate over all lectures. An individual entry may look
+      # like this:
+      #
+      #   185.A47 Physiologie und Grundlagen der Pathologie # 4.5 ECTS, VO, TU WIEN
+      #
+      # Because we may want to sort the dataset according to individual
+      # modules, we will first sort that dataset completely, before
+      # proceeding.
+      # ===================================================================== #
+      hash.each_pair {|this_lecture, pointer_to_the_lecture_dataset| index += 1
+        splitted = this_lecture.split(' ')
+        lva_id = splitted.first # Obtain the ID of the lva.
+        # =================================================================== #
+        # The variable `name_of_the_lecture` contains just the name of
+        # the lecture alone, without leading LVA ID number.
+        # =================================================================== #
+        name_of_the_lecture = splitted[1..-1].join(' ').strip
+        # =================================================================== #
+        # Next, determine some helper-variables. Since as of July 2018
+        # we will try another approach to obtain the specific entries of
+        # our main Hash, via a more generic method called obtain().
+        # =================================================================== #
+        n_ects_points      = obtain(:ects,               pointer_to_the_lecture_dataset)
+        university         = obtain(:university,         pointer_to_the_lecture_dataset)
+        lecture_type       = obtain(:type,               pointer_to_the_lecture_dataset)
+        bereits_absolviert = obtain(:already_solved,     pointer_to_the_lecture_dataset)
+        curricula          = obtain(:curricula,          pointer_to_the_lecture_dataset)
+        is_a_steop_lecture = obtain(:is_a_steop_lecture, pointer_to_the_lecture_dataset)
+        semester           = obtain(:semester,           pointer_to_the_lecture_dataset).to_s # Must have .to_s due to nil-values.
+        if pointer_to_the_lecture_dataset.has_key? :homepage
+          # ================================================================= #
+          # In this case everything is fine. We will continue.
+          # ================================================================= #
+        else
+          e crimson('The lecture `')+
+            sfancy(this_lecture)+
+            crimson('` does not have a registered')
+          e crimson('remote homepage entry.')
+          open_this_in_the_browser = false
+          if open_this_in_the_browser and
+             is_on_roebe? and
+             commandline_mode?
+            # =============================================================== #
+            # On my home system we will batch-open these in the browser.
+            # This will only work if they are registered in BeautifulUrl
+            # though. It will thus not work for every lecture, but it may
+            # work for many lectures, which can thus be updated.
+            # =============================================================== #
+            e crimson('Opening the URL to this lecture in the editor now, so that')
+            e crimson('this erroneous entry can be corrected.')
+            this_url = Studium.return_remote_homepage_of_this_lecture(this_lecture)
+            if this_url != this_lecture # Means we found something.
+              Studium.open_this_remote_url(this_url)
+              sleep(0.75)
+            end
+          end
+        end
+        # =================================================================== #
+        # Since as of 15.04.2019, we will tap into the method
+        # Studium.return_homepage_of_this_lecture() to determine the
+        # remote URL.
+        #
+        # In the past we used the BeautifulUrl for this, but it is better
+        # to make use of the automatically generated regexp-case-when menu,
+        # residing in the file called
+        # 'regexes_for_the_registered_lectures.rb'.
+        # =================================================================== #
+        use_this_as_remote_url = ::Studium.return_homepage_of_this_lecture(this_lecture)
+        case semester
+        when 'both'
+          semester = 'Sommer / Winter'
+        when 'winter'
+          semester = 'Winter'
+        when 'summer'
+          semester = 'Sommer'
+        end
+        # =================================================================== #
+        # Also add this to the hash that contains the lectures. We could
+        # use `this_lecture` as key, but I prefer the name alone, without
+        # leading lva id. Note that this would, in theory, conflict if we
+        # have lectures that have the same name but a different LVA ID.
+        # =================================================================== #
+        @hash_containing_the_lectures_for_this_curriculum[name_of_the_lecture] =
+          pointer_to_the_lecture_dataset
+        @hash_containing_the_lectures_for_this_curriculum[name_of_the_lecture].update(
+          remote_url: use_this_as_remote_url
+        )
+        bereits_absolviert = ja_oder_nein(bereits_absolviert)
+        case bereits_absolviert
+        when 'Ja'
+          colourized_bereits_absolviert = '<b style="color:green">'+bereits_absolviert
+          # ================================================================= #
+          # Also append the date when this exam has been completed
+          # successfully.
+          # ================================================================= #
+          on_which_date = @hash_containing_the_lectures_for_this_curriculum[name_of_the_lecture][:already_solved_at].to_s
+          colourized_bereits_absolviert <<
+            ", absolviert am</b> <b style=\"color:darkgreen\">#{on_which_date}</b>"
+        else
+          colourized_bereits_absolviert = '<b style="color:red">'+bereits_absolviert+'</b>'
+        end
+        # =================================================================== #
+        # === Check special-content for the individual curriculum
+        # =================================================================== #
+        if individual_curriculum? and
+           pointer_to_the_lecture_dataset.has_key?(:individual_curricula) and
+           pointer_to_the_lecture_dataset[:individual_curricula].has_key?(:individual_curriculum_module)
+          individual_curriculum_module  = pointer_to_the_lecture_dataset[:individual_curricula][:individual_curriculum_module]
+          name_of_the_curriculum_module = pointer_to_the_lecture_dataset[:individual_curricula][:name_of_the_curriculum_module]
+          if individual_curriculum_module.is_a? Array
+            individual_curriculum_module = individual_curriculum_module.first
+          end
+          if @name_of_the_individual_curriculum_module != individual_curriculum_module 
+            @name_of_the_individual_curriculum_module = individual_curriculum_module
+            # =============================================================== #
+            # Next we will show the name of the Module at hand. This will
+            # be done only for lectures that are part of an individual
+            # curriculum. We also need to determine the name of the
+            # curriculum.
+            # =============================================================== #
+            # n_ects_in_this_module = Studium.return_n_ects_in_this_module(
+            #   @name_of_the_individual_curriculum_module,
+            #   individual_curriculum_module,
+            #   :use_what_is_best # <- Not ideal for speed-reasons, but for now this must suffice.
+            # )
+            # n_ects_in_this_module = '<span style="color: darkgreen">('+
+            #                          n_ects_in_this_module.to_s+
+            #                          ' ECTS)</span>'
+            # ^^^ we tried this on 31.12.2019, but it does not work very well.
+            _ << '<h1><b style="color:midnightblue">Module</b> '\
+                 '<span style="color:#510042">'+
+                 @name_of_the_individual_curriculum_module+
+                 '</span> '+
+                 '<b style="color:midnightblue">'+
+                 name_of_the_curriculum_module.strip+
+                 '</b>'
+            n_ects_in_that_module = ::Studium.return_n_ects_in_that_module(
+              title?,
+              @name_of_the_individual_curriculum_module,
+              @lecture_dataset
+            )
+            # =============================================================== #
+            # Show how many ECTS points are in that module.
+            # =============================================================== #
+            _ << " <span style=\"font-size:0.8em\">[#{n_ects_in_that_module} ECTS in this module]</span>"
+            # =============================================================== #
+            # Since as of 29.02.2020 we will also notify whether we have
+            # completed this module or whether we have not.
+            # =============================================================== #
+            if ::Studium.query_based_on_curriculum_title_whether_this_module_been_completed(
+                title?,
+                @name_of_the_individual_curriculum_module,
+                @lecture_dataset
+              )
+              _ << IMAGE_FOR_THE_COMPLETED_MODULE.dup
+            end
+            # =============================================================== #
+            # And close the header-tag as well.
+            # =============================================================== #
+            _ << '</h1>' # + n_ects_in_this_module
+          end
+        end
+        # =================================================================== #
+        # Add the university-logo as well. This image can also be clicked
+        # on via a <a href=""> tag.
+        # =================================================================== #
+        clickable_logo = return_proper_logo_for_this_university(university)
+        # clickable_logo = '<a href="'+return_remote_url(this_lecture)+'">'+clickable_logo+'</a>'
+        # ^^^ disabled the above as of 16.04.2019
+        clickable_logo = '<a href="'+use_this_as_remote_url+'">'+clickable_logo+'</a>'
+        _ << '<span style="margin-left:2.0em">'+
+             clickable_logo
+        # =================================================================== #
+        # If it is a STEOP lecture then a special "STEOP image" will be
+        # shown.
+        # =================================================================== #
+        if is_a_steop_lecture
+          _ << return_proper_logo_for_this_university(:steop_picture)
+        end
+        # =================================================================== #
+        # Next, we add the name of the lecture. This can either be
+        # `this_lecture`, which will include the lecture-id,
+        # or `name_of_the_lecture`, which will NOT include the lecture-id.
+        # =================================================================== #
+        if bereits_absolviert == 'Nein'
+          # ================================================================= #
+          # In this case we will use slightly different colours.
+          # ================================================================= #
+          bold_name_of_the_lecture = '<b style="font-size:larger; color: navy">'+
+            this_lecture+
+          '</b>'
+        else # this is the default
+          bold_name_of_the_lecture = '<b style="font-size:larger">'+
+            this_lecture+
+          '</b>'
+        end
+        _ << " Lehrveranstaltung <b>##{index}</b>:</span> "+
+             bold_name_of_the_lecture+
+             ', Bereits <b>absolviert</b>? <span style="font-size:larger">'+
+              colourized_bereits_absolviert+'</span>'\
+             ' (LVA Nummer: <b>'+lva_id.to_s+'</b>; '\
+             'ECTS: <b>'+n_ects_points.to_s+'</b>; '\
+             'Lecture Type: <b>'+lecture_type+'</b>; '\
+             'Semester: <b>'+semester+'</b>; '
+        _ << "University: <b>#{university}</b>) "
+        # =================================================================== #
+        # Add bachelor-or-master lecture next but only for unsolved
+        # lectures.
+        # =================================================================== #
+        if bereits_absolviert == 'Nein'
+          _ << return_bachelor_or_master_logo(curricula)
+        end
+        # =================================================================== #
+        # Next check whether the lecture is a practical course. If it is we
+        # will add a certain image, but only if it is NOT yet solved.
+        # =================================================================== #
+        if is_this_lecture_a_practical_course?(lecture_type) and
+           (bereits_absolviert == 'Nein')
+          _ << PRACTICAL_COURSE_IMAGE
+        end
+        _ << "#{HtmlTags::BR}#{N}"
+        # =================================================================== #
+        # If the lecture has not been solved yet, we will show the remote
+        # URL. However had, via the commandline flag --show-all-URLs this
+        # can be overruled.
+        # =================================================================== #
+        shall_we_show_the_url = false
+        if @show_all_URLs or (bereits_absolviert == 'Nein')
+          shall_we_show_the_url = true
+        end
+        # =================================================================== #
+        # === Show the associated URL to the given lecture.
+        # =================================================================== #
+        if shall_we_show_the_url
+          this_url = ::Studium.return_homepage_of_this_lecture(this_lecture)
+          _ << return_arrow_pointing_to_the_right_side('3em')
+          _ << '<a style="margin-left: 5em; font-size: larger; font-weight:bold" href="'+this_url+'">'+
+               this_url+
+               '</a>'+BR+N
+          # ================================================================= #
+          # === Show Moodle entries
+          #
+          # Since as of 28.10.2019 we will also display the Moodle link
+          # to this course.
+          # ================================================================= #
+          url_to_moodle = ::Studium.return_remote_moodle_link_of_this_lecture(this_lecture)
+          _ << return_arrow_pointing_to_the_right_side('3em')
+          if (url_to_moodle == this_lecture) and !url_to_moodle.include?('http')
+            url_to_moodle = '[No remote URL for Moodle is known for this course.]'
+            _ << '<span style="margin-left: 5em; font-size: larger; font-weight:bold; color: darkblue" href="'+url_to_moodle+'">'+
+                 url_to_moodle+
+                 '</span>'+BR+N
+          else
+            _ << '<a style="margin-left: 5em; font-size: larger; font-weight:bold" href="'+url_to_moodle+'">'+
+                 url_to_moodle+
+                 '</a>'+BR+N
+          end
+          # ================================================================= #
+          # Next, determine when the next exam may happen but only do so
+          # when the instance variable @show_next_exams is true. We will
+          # also NOT do any checking here and simply use the first found
+          # entry, if we are instructed to show the next upcoming exams.
+          # The user has to update the file lecture_information on his/her
+          # own.
+          # ================================================================= #
+          if @show_next_exams
+            if pointer_to_the_lecture_dataset.has_key? 'exams'
+              array_upcoming_exams = pointer_to_the_lecture_dataset['exams']
+              first_entry = array_upcoming_exams.first
+              first_entry = remove_weekdays(first_entry)
+              weekday = first_entry
+              if weekday.include? ','
+                weekday = weekday.split(',').first
+              end
+              weekday = english_to_german_weekday(
+                translate_dd_mm_yyyy_to_weekday(weekday)
+              )
+              _ << '<span style="font-weight:bold; font-size: larger;margin-left:9em"> ^^^ '+
+                   '<b style="color: teal">Next exam:</b> '+
+                   weekday+' '+
+                   first_entry+'</span>'+BR+N
+            end
+          end
+        end
+      }
+      # =================================================================== #
+      # Next add how many lectures are in this Curriculum.
+      # =================================================================== #
+      _ << BR+
+           return_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved(:use_for_html).join(' ')+N
+      _ << BR+BR+
+           return_how_many_ects_points_this_curriculum_has_in_total(:no_colours)+'<br>'+N
+      _ << BR+
+           return_how_many_ects_points_have_been_passed_already(:use_for_html).join(' ')+N
+      # =================================================================== #
+      # Determine how many lectures are missing still.
+      # =================================================================== #
+      n_missing_lectures = n_total_lectures?.to_i - n_lectures_completed?
+      _ << "#{BR}#{BR}There are still <b>#{n_missing_lectures.to_s}</b> lectures missing "\
+           "before this curriculum has been completed successfully."
+      # =================================================================== #
+      # Next, add average grade, if we are using it at all altogether.
+      # =================================================================== #
+      if @do_report
+        average_grade = return_the_average_grade
+        _ << "\n<br><br>The <span style=\"font-weight:800;padding-left:2px; padding-right:2px;background-color: black; color:gold\">average grade</span> "\
+             "is: <b style=\"color:darkgreen\">#{average_grade}</b>\n\n<br><br>"
+      end
+      # =================================================================== #
+      # Also add the timetable of upcoming exams next, a html <div>.
+      # =================================================================== #
+      if @show_next_exams
+        _ << "#{return_timetable_of_upcoming_exams}#{N}"
+      end
+      _ << "#{N}</div>"
+      _ << @append_this_string_onto_the_html_string
+      # =================================================================== #
+      # Store into e. g.:
+      #   "#{log_dir?}html/#{title?.to_s.tr(' ','_').delete('()')}.html"
+      # =================================================================== #
+      set_html_string(_)
+      _ << "</html>#{N}"
+      # =================================================================== #
+      # We will only generate a .html file if we are using the commandline
+      # variant.
+      # =================================================================== #
+      if cmdline?
+        result = "Next storing into\n".dup
+        result << "  `#{sfile(html_file)}`\n"
+        also_open_in_the_browser = true
+        if also_open_in_the_browser
+          result << "\nThat page will be opened via the browser as well."
+          opnn; e result
+          write_what_into(_, html_file)
+          Open.in_browser(html_file) { :be_silent } # Don't show the exact command.
+        end
+      end
+    end
+  end
+
+end; end