<commit_before># Κατασημεῖον
### Markdown-like markup for formatting Biblical texts

The name is a nerd joke: **κατα-** can be translated *down*; **σημεῖον** can be
translated *mark*. This is not to say that this is the actual Greek word for
Markdown.

While in college, I create a mashup of scripts that I used to convert an
easy-to-write XML format into HTML or LaTeX so I could pretty-print my
translations of Biblical books without having to use a WYSIWYG editor. I prefer
to live in my native habitat, Vim than to use even LibreOffice Writer.

Then I started using StackOverflow, and learned Markdown. Markdown grew and grew
on me. Finally, I've decided it's time to take the ideas that I used in my XML
hacks from before and convert them into something Markdown-like.

There are some common characteristics that Biblical texts have that most other
texts don't have, such as verse numbers. I also wanted to support a certain
level of text-critical markup, such as marking textual variants. Also, there are
things that Biblical texts just don't have, like @-style mentions, hyperlinks,
code blocks, math, and other such modern internet-y stuff that Markdown is
geared towards. This meant that I could repurpose some of Markdown, and also
could claim more symbols for specialized verse-number and footnote markup, etc.

If you find this project useful, please let me know so that I can put more
effort into it. Also, please feel free to submit issues about bugs or feature
requests.

### Example
The `example` directory of the project contains the following example. Here is a
rough draft of 1 John 1 with Katasemeion markup, in Vim (the Greek words are in
red because I have not added them to my spell file and spelling is turned on):

![example in Vim](/example/1John1-katasemeion-in-Vim.png)

And rendered in the browser, you can see that the footnotes pop up and regions
marked as needing further attention with `<...>` are red. The light
half-brackets on the bottom, such as around  the words *about him*, are an
indicator that the translator wants you to know that he inserted these words.
The light half-brackets on the top are an indicator of what region the footnote
pertains to. The rest is fairly self-explanatory; if there were a textual
variant shown, it would use a light full-bracket.

![example as HTML](/example/1John1-katasemeion-rendered-as-HTML.png)

The example will be shown rendered in PDF via XeLaTeX once that feature is
implemented.

### How to Run It
Currently it must be run through Node, though I have written it in JavaScript in
order to allow for in-browser translation. Also, currently it doesn't support<commit_msg>Added note about style configurability with CSS<commit_after># Κατασημεῖον
### Markdown-like markup for formatting Biblical texts

The name is a nerd joke: **κατα-** can be translated *down*; **σημεῖον** can be
translated *mark*. This is not to say that this is the actual Greek word for
Markdown.

While in college, I create a mashup of scripts that I used to convert an
easy-to-write XML format into HTML or LaTeX so I could pretty-print my
translations of Biblical books without having to use a WYSIWYG editor. I prefer
to live in my native habitat, Vim than to use even LibreOffice Writer.

Then I started using StackOverflow, and learned Markdown. Markdown grew and grew
on me. Finally, I've decided it's time to take the ideas that I used in my XML
hacks from before and convert them into something Markdown-like.

There are some common characteristics that Biblical texts have that most other
texts don't have, such as verse numbers. I also wanted to support a certain
level of text-critical markup, such as marking textual variants. Also, there are
things that Biblical texts just don't have, like @-style mentions, hyperlinks,
code blocks, math, and other such modern internet-y stuff that Markdown is
geared towards. This meant that I could repurpose some of Markdown, and also
could claim more symbols for specialized verse-number and footnote markup, etc.

If you find this project useful, please let me know so that I can put more
effort into it. Also, please feel free to submit issues about bugs or feature
requests.

### Example
The `example` directory of the project contains the following example. Here is a
rough draft of 1 John 1 with Katasemeion markup, in Vim (the Greek words are in
red because I have not added them to my spell file and spelling is turned on):

![example in Vim](/example/1John1-katasemeion-in-Vim.png)

And rendered in the browser, you can see that the footnotes pop up and regions
marked as needing further attention with `<...>` are red. The light
half-brackets on the bottom, such as around  the words *about him*, are an
indicator that the translator wants you to know that he inserted these words.
The light half-brackets on the top are an indicator of what region the footnote
pertains to. The rest is fairly self-explanatory; if there were a textual
variant shown, it would use a light full-bracket.

![example as HTML](/example/1John1-katasemeion-rendered-as-HTML.png)

If you don't like the way this HTML renders, you can configure it with CSS.

The example will be shown rendered in PDF via XeLaTeX once that feature is
implemented.

### How to Run It
Currently it must be run through Node, though I have written it in JavaScript in
order to allow for in-browser translation. Also, currently it doesn't support
{'fraction_non_alphanumeric': 0.04821725475706632, 'fraction_numerical': 0.0022168852761869575, 'mean_word_length': 4.360396039603961, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3122529', 'n_tokens_mistral': 1491, 'n_tokens_neox': 1396, 'n_words': 874}