Skip to content

Commit

Permalink
update the documentation (multiple sub sets)
Browse files Browse the repository at this point in the history
The update of the documentation now reflects the presence of
multiple sub sets; their tags allow a focused selfstudy by topics
of interest (Kuerzel, false friends; terms from geography, etc.).

Signed-off-by: Norwid Behrnd <[email protected]>
  • Loading branch information
nbehrnd committed Jun 30, 2023
1 parent 56a7fa4 commit a6986c8
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 24 deletions.
70 changes: 60 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,64 @@
<img src="./landing_700px.png" width="700" />

## background

Wikimedia currently contains 39349 symbolizations about the first degree
of simplification (Verkehrsschrift) of Deutsche Einheitskurzschrift
(DEK) created by user
of simplification of Deutsche Einheitskurzschrift (DEK) which is known
as Verkehrsschrift. The symbolizations are originally created by user
[Thirunavukkarasye-Raveendran](https://commons.wikimedia.org/wiki/User:Thirunavukkarasye-Raveendran)
(who is not author of this repository). To facilitate self-study
(training to read the short hand, and compare your symbolization with a
reference), 34176 double sided flash cards are assembled in this ongoing
project's Anki deck.

To access the Anki deck, do not download the project, but visit the
release page for the corresponding .zip. Deflated, the Anki deck's
volume only is about 27 MB.
(who is not author of this repository) as "ineligible for copyright and
therefore in the public domain because it consists entirely of
information that is common property and contains no original authorship"
([example
page](https://commons.wikimedia.org/wiki/File:DEK_Deutsche_Einheitskurzschrift_-_Verkehrsschrift_-_Urheber.svg),
so far last consultation on \<2023-06-30 Fri\>). This project aims to
compile a large sub set as bidirectional flash cards to facilitate
selfstudy, i.e. to provide a handy reference of how to symbolize long
hand in short hand, as well as the reading of short hand in one spot.

Within an Anki deck, flash cards can carry varying tags. Running a
`customary study` in an Anki session, this then allows the interested to
draw only cards of one sub topic from one deck for a focused revision.
The programmatic assignment of tags is inspired by a presentation by
Moritz Gnisia ([first
part](https://gnisitricks.de/de/2018/09/Automatisch-Karteikarten-erstellen-Teil-1/),
[second
part](https://gnisitricks.de/de/2020/05/Automatisch-Karteikarten-Teil-2/)).

So far, only a small fraction of about 10% are indexed with a different
tag than `DEK`, which is the default. The sets available are:

| set | entries | Symbolisierungen thematisieren / symbolizations are about |
|------:|--------:|-------------------------------------------------------------------------|
| A_DEK | 182 | Abkürzungen / abbreviations |
| B_DEK | 531 | Symbolisierung mit zwei Worten / two word symbolizations |
| C_DEK | 171 | Symbolisierung mit drei Worten / three word symbolizations |
| DEK | 34377 | (noch) nicht indizierter Grundeintrag / not (yet) indexed symbolization |
| E_DEK | 139 | Englisch / symbolization of English words |
| F_DEK | 120 | falsche Symbolisierung / erroneous symbolizations |
| G_DEK | 837 | geographische Beispiele / terms of geography |
| K_DEK | 280 | Beispiele zu Kürzeln / examples how to use Kuerzel |
| L_DEK | 55 | lateinische Begriffe / terms related to Latin |
| N_DEK | 48 | nicht empfohlene Symbolisierungen / not recommended symbolizations |
| O_DEK | 31 | Organizationen, Marken / organizations, trade marks (e.g., UNO) |
| P_DEK | 563 | Namen und Personen / names and historic personalities |
| U_DEK | 195 | Unterscheidungszeichen / use of special signs in symbolizations |
| V_DEK | 381 | vergleichende Gegenüberstellungen / contrasting comparisons |
| Z_DEK | 208 | kurze Sätze und Sprichworte / short phrases and proverbs |
| total | 38118 | |

About 5% of the symbolizations available on Wikimedia's servers are
perceived to be not (yet) suitable for an inclusion in this Anki deck.
For many of them, their dimension / scaling of representation differs
(too) much in comparison to the examples compiled here; this however
contradicts the aim to provide a consistent visual appeal within this
Anki deck.

To obtain a deck still (reasonably) portable, the files about individual
symbolizations were simplified with
[svgcleaner](https://github.com/RazrFalcon/svgcleaner). This reduced the
initial global file size (approx. 340 MB) of the raw data to about 30 MB
(the `.apkg` Anki package you should download directly from the [release
page](https://github.com/nbehrnd/DEK_VS_svg/releases) as an asset), or
about 50 MB within Anki's folder `collection.media` after the import
into the program.
79 changes: 65 additions & 14 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,24 +1,75 @@
# name: README.org
# author: [email protected]
# license: GPLv2
# date:
# edit: <2023-06-05 Mon>
# date: <2020-06-05 Fri>
# edit: <2023-06-30 Fri>

#+OPTIONS: ^:nil
#+OPTIONS: TOC:nil

#+ATTR_HTML: :width 700px
[[./landing_700px.png]]

** background

Wikimedia currently contains 39349 symbolizations about the first
degree of simplification (Verkehrsschrift) of Deutsche
Einheitskurzschrift (DEK) created by user
[[https://commons.wikimedia.org/wiki/User:Thirunavukkarasye-Raveendran][Thirunavukkarasye-Raveendran]] (who is not author of this
repository). To facilitate self-study (training to read the short
hand, and compare your symbolization with a reference),
34176 double sided flash cards are assembled in this ongoing
project's Anki deck.

To access the Anki deck, do not download the project, but visit the
release page for the corresponding .zip. Deflated, the Anki deck's
volume only is about 27 MB.

degree of simplification of Deutsche Einheitskurzschrift (DEK)
which is known as Verkehrsschrift. The symbolizations are
originally created by user [[https://commons.wikimedia.org/wiki/User:Thirunavukkarasye-Raveendran][Thirunavukkarasye-Raveendran]] (who is not
author of this repository) as "ineligible for copyright and
therefore in the public domain because it consists entirely of
information that is common property and contains no original
authorship" ([[https://commons.wikimedia.org/wiki/File:DEK_Deutsche_Einheitskurzschrift_-_Verkehrsschrift_-_Urheber.svg][example page]], so far last consultation on
<2023-06-30 Fri>). This project aims to compile a large sub set as
bidirectional flash cards to facilitate selfstudy, i.e. to provide
a handy reference of how to symbolize long hand in short hand, as
well as the reading of short hand in one spot.

Within an Anki deck, flash cards can carry varying tags. Running a
~customary study~ in an Anki session, this then allows the
interested to draw only cards of one sub topic from one deck for a
focused revision. The programmatic assignment of tags is inspired
by a presentation by Moritz Gnisia ([[https://gnisitricks.de/de/2018/09/Automatisch-Karteikarten-erstellen-Teil-1/][first part]], [[https://gnisitricks.de/de/2020/05/Automatisch-Karteikarten-Teil-2/][second part]]).

So far, only a small fraction of about 10% are indexed with a
different tag than ~DEK~, which is the default. The sets available
are:

| <r> | <r> | |
| set | entries | Symbolisierungen thematisieren / symbolizations are about |
|-------+---------+-------------------------------------------------------------------------|
| A_DEK | 182 | Abkürzungen / abbreviations |
| B_DEK | 531 | Symbolisierung mit zwei Worten / two word symbolizations |
| C_DEK | 171 | Symbolisierung mit drei Worten / three word symbolizations |
| DEK | 34377 | (noch) nicht indizierter Grundeintrag / not (yet) indexed symbolization |
| E_DEK | 139 | Englisch / symbolization of English words |
| F_DEK | 120 | falsche Symbolisierung / erroneous symbolizations |
| G_DEK | 837 | geographische Beispiele / terms of geography |
| K_DEK | 280 | Beispiele zu Kürzeln / examples how to use Kuerzel |
| L_DEK | 55 | lateinische Begriffe / terms related to Latin |
| N_DEK | 48 | nicht empfohlene Symbolisierungen / not recommended symbolizations |
| O_DEK | 31 | Organizationen, Marken / organizations, trade marks (e.g., UNO) |
| P_DEK | 563 | Namen und Personen / names and historic personalities |
| U_DEK | 195 | Unterscheidungszeichen / use of special signs in symbolizations |
| V_DEK | 381 | vergleichende Gegenüberstellungen / contrasting comparisons |
| Z_DEK | 208 | kurze Sätze und Sprichworte / short phrases and proverbs |
|-------+---------+-------------------------------------------------------------------------|
| total | 38118 | |
#+TBLFM: @18$2=vsum(@I..@II)

About 5% of the symbolizations available on Wikimedia's servers are
perceived to be not (yet) suitable for an inclusion in this Anki
deck. For many of them, their dimension / scaling of
representation differs (too) much in comparison to the examples
compiled here; this however contradicts the aim to provide a
consistent visual appeal within this Anki deck.

To obtain a deck still (reasonably) portable, the files about
individual symbolizations were simplified with [[https://github.com/RazrFalcon/svgcleaner][svgcleaner]]. This
reduced the initial global file size (approx. 340 MB) of the raw
data to about 30 MB (the ~.apkg~ Anki package you should download
directly from the [[https://github.com/nbehrnd/DEK_VS_svg/releases][release page]] as an asset), or about 50 MB within
Anki's folder ~collection.media~ after the import into the program.

#+begin_comment
* Hintergrund
Expand Down

0 comments on commit a6986c8

Please sign in to comment.