search

scrollmapper / bible_databases

Bible versions and cross-reference databases.
1.01k stars 348 forks source link

Fix: Fix markdown formatting to escape backticks #56

Open leojonathanoh opened 3 years ago

leojonathanoh commented 3 years ago

Fixes #55

Simply replaced all occurances of the ` with \`. I assume all occurrences of ` are isolated and used only with its corresponding ' for square bracketed phrases e.g. https://www.bible.com/bible/821/GEN.1.YLT98.

cd ./md
find . -name '*.md' | sed 's/\(.*\)/"\1"/g' | xargs sed -i 's/`/\\`/g'

Let me know if there might be issues, i'm not extremely familiar with text formatting of bible text.

Jmainguy commented 3 years ago

Not a bible expert. (nice sed by the way), but - the very first verse appears wrong to my humble eyes.

**[1:11]** And God said, Let the earth put forth grass, herbs yielding seed, \`and' fruit-trees bearing fruit after their kind, wherein is the seed thereof, upon the earth: and it was so.

the markdown is showing the escape, and if this was code wrapping and between a backtick and a single quote doesnt make a ton of sense.

leojonathanoh commented 3 years ago

the markdown is showing the escape, and if this was code wrapping and between a backtick and a single quote doesnt make a ton of sense.

As I said in OP, I assume that .txt versions are the point of reference in that they contain the "raw" and unformatted data, and that the backticks in .txt versions are to be preserved in the original text as read by the user. E.g. It is a `very' sunny day:

In order to preserve the original text (i.e. .txt) in markdown .md format, backticks need to be escaped with a backslash, so that backticks are not proceesed as part of markdown "code" formatting. . It is a `very' sunny day -> It is a \`very' sunny day:

Correct me if i'm missing something.

adivated commented 3 years ago

I’m not sure why but it looks like the back tik is being used as the start tik and the regular tik as the closing tik. I’m not sure I see a need or reason for that.

leojonathanoh commented 3 years ago

I’m not sure why but it looks like the back tik is being used as the start tik and the regular tik as the closing tik. I’m not sure I see a need or reason for that.

Yes, I'm not sure why in the original .txt, a backtick ` and single quote ' is used as the equivalent of what we normally do in writing with square brackets e.g. It is a [very] sunny day. I've never some across this kind of formatting in text (maybe a lack of exposure). Is there some sort of reason for using this formatting in the original text?

leojonathanoh commented 3 years ago

i see the same used in all the other formats e.g. json, xml, sql, mssql, csv, so there must be some reason for it.

leojonathanoh commented 3 years ago

i see the same used in all the other formats e.g. json, xml, sql, mssql, csv, so there must be some reason for it.

Opened https://github.com/scrollmapper/bible_databases/issues/58#issue-855425406, we should resume the discussion there.