Commit 578b0b7a authored by Jakob Schmidt's avatar Jakob Schmidt
Browse files

+Editionsrichtlinien.md, erste PDF-Fassung, alte Dokumentation gelöscht

parent 6ac69802
<!DOCTYPE html>
<head>
<meta charset="UTF-8">
<title>Diskussionspunkte</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,300,700' rel='stylesheet' type='text/css'/>
<script>
/*
* Dynamic Table of Contents script
* by Matt Whitlock
*/
function createLink(href, innerHTML) {
var a = document.createElement("a");
a.setAttribute("href", href);
a.innerHTML = innerHTML;
return a;
}
function generateTOC(toc) {
var i2 = 0, i3 = 0, i4 = 0;
toc = toc.appendChild(document.createElement("ul"));
for (var i = 0; i < document.body.childNodes.length; ++i) {
var node = document.body.childNodes[i];
var tagName = node.nodeName.toLowerCase();
if (tagName == "h3") {
++i4;
if (i4 == 1) toc.lastChild.lastChild.lastChild.appendChild(document.createElement("ul"));
var section = i2 + "." + i3 + "." + i4;
node.insertBefore(document.createTextNode(section + ". "), node.firstChild);
node.id = "section" + section;
toc.lastChild.lastChild.lastChild.lastChild.appendChild(document.createElement("li")).appendChild(createLink("#section" + section, node.innerHTML));
}
else if (tagName == "h2") {
++i3, i4 = 0;
if (i3 == 1) toc.lastChild.appendChild(document.createElement("ul"));
var section = i2 + "." + i3;
node.insertBefore(document.createTextNode(section + ". "), node.firstChild);
node.id = "section" + section;
toc.lastChild.lastChild.appendChild(document.createElement("li")).appendChild(createLink("#section" + section, node.innerHTML));
}
else if (tagName == "h1") {
++i2, i3 = 0, i4 = 0;
var section = i2;
node.id = "section" + section;
toc.appendChild(h2item = document.createElement("li")).appendChild(createLink("#section" + section, node.innerHTML));
}
}
}
</script></head>
<body onload="generateTOC(document.getElementById('toc'));">
<div id="toc">
</div>
<!--Manchmal werfen sich beim Codieren Fragen auf die mal grundsätzlich besprochen werden sollten. In Zukunft könnte man das hier festhalten.
Ursprünglich dachte ich, ich schreib einfach auf der Moodle-Seite weiter. Aber irgendwie bin ich da wieder (oder immer noch) nicht Kursverantwortlicher.
Und im repository ist natürlich sowieso schöner. HTML ist vielleicht nicht die beste Lösung für eine solche Diskussion, aber ich kenn mich nicht so gut aus im XML-Markup-Umfeld...
-->
<h1>Tiefe der Codierung</h1>
<schmidt>Hier gibt es erhebliche Unterschiede
<h2>Referenzierungen</h2>
Was soll alles referenziert werden?
<ul>
<li>Alle Namensnennungen von Busoni und Schönberg (selbst in Anrede, usw.)? Wenn ja, kann man das nicht automatisieren?</li>
</ul>
</schmidt>
<schaper>
Bei Briefen im Transkriptionsteil Absender und Empfänger grundsätzlich nicht auszeichnen (Ausnahme Zitate: einmal nennt Busoni Schönberg, während er einen eigenen Briefausschnitt an Breitkopf zitiert – da geht es ja tatsächlich registerrelevant um eine Nennung Schönbergs, auch wenn er selbst der Empfänger ist). Auch im Metadatenbereich wird die Personenkennzeichnung kaum irgendwo nötig sein, von Absender- und Empfängerangabe abgesehen.
</schaper>
<h2>Tag-/Attributgenauigkeit</h2>
<schmidt>schwankt sehr stark, etwa bei Stempeln, Korrekturen, Beifügungen usw.
<ul>
<li>Bsp.<pre><code>&lt;gap reason="overwritten" atMost="1" unit="char"&gt;&lt;/gap&gt;</code></pre></li>
</ul>
</schmidt>
<schaper>Hier bitte erstmal keine Zeit verlieren. Stempel immer nach Schablone, Korrekturen vorerst nur an auffälligen/ergiebigen Stellen, Kleinkram zuletzt (falls noch Zeit ist).</schaper>
<h1>Emendation</h1>
<schmidt>
Was wird eigentlich alles emendiert?
<ol>
<li>Abkürzungen? Und wenn ja, generell alle ungebräuchlichen?</li>
<li>Datumsangaben?</li>
<li>Unterschriften?</li>
</ol>
</schmidt>
<schaper>Emendation für die Lesefassung mit <pre><code>&lt;choice&gt;&lt;orig&gt;&lt;/orig&gt;&lt;reg>&lt;/reg&gt;&lt;/choice&gt;</code></pre>
<ol>
<li>Unübliche Abkürzungen auflösen (übliche nicht).</li>
<li>Datumsangaben regularisieren.</li>
<li>Unterschriften regularisieren.</li>
</ol>
Wenn wir noch eine Version "Kritisch" einfügen, wäre es dort aber anders ...
</schaper>
<h1>Typografische Leerzeichen</h1>
<schmidt>Wie gehen wir mit typografischen Leerzeichen um? In einigen Transkriptionen werden sie konsequent zwischen Ziffer und Einheit verwendet, bei den meisten jedoch gar nicht. <br/>
Bei in jedem Brief vorkommenden Stellen könnte man natürlich wieder automatisieren. Diese wären
<ul>
<li>Editionsseitenangaben</li>
<li></li>
</ul>
</schmidt>
<schaper>
Bitte an allen dafür üblichen Stellen das geschützte schmale Leerzeichen verwenden: <pre><code>&amp;#8239;</code></pre>
Das sind:
<ul>
<li>Buchstaben-Abkürzungen mit folgender Zahl: S.&#8239;1, Sp.&#8239;2, op.&#8239;3 Nr.&#8239;4</li>
<li>Buchstaben-Abkürzungen zur vorherigen Zahl: S.&#8239;5&#8239;ff., Bd.&#8239;6&#8239;f.; fol.&#8239;7&#8239;v</li>
<li>mehrgliedrige Buchstabenabkürzungen: u.&#8239;a., v.&#8239;a., z.&#8239;B., o.&#8239;Ä., d.&#8239;i.</li>
<li>und sicherlich noch mehr, bitte ergänzen ...</li>
</ul>
(wird natürlich nur angezeigt, wenn die verwendete Schriftart eines hat)
</schaper>
<h1>Äußere Form</h1>
<schmidt>Schön wäre es eigentlich, wenn die .xml-Dateien auch äußerlich eine einigermaßen vergleichbare Form fänden (Einrückungen, Position von Tags, Leerzeichen, Kommentare...).
Das ist allerdings eine ganz schöne Aufgabe und wohl eher schwer zu automatisieren.</schmidt>
<schaper>Ja, keine hohe Priorität.</schaper>
<h1>Projektmanagement</h1>
<schmidt>Es lohnt sich wahrscheinlich nicht, dafür jetzt noch groß Aufwand zu betreiben, auch wenn es da schöne Softwarelösungen für gibt...
Einfach zu handhaben wäre beispielsweise ein TiddlyWiki (http://tiddlywiki.com/): Das wäre eine einzige HTML-Datei mit der Möglichkeit Text-Einträge hinzuzufügen (mit Tagging-System). Allerdings nicht mit Texteditor zu bearbeiten...
Oder soll die TODO-Liste auch wieder so eine HTML-Datei werden? Features wie Datumsangaben, Sortierung, Tagging usw. sind dann eben nicht automatisch mit dabei...
</schmidt>
<schaper>Nehmen Sie gerne, was Ihnen tauglich scheint -- solange Sie glauben, es mir zur Not schnell erklären zu können. Ich will nicht noch mehr Sprachen lernen müssen ...</schaper>
<h1>Dokumentation</h1>
<schmidt>Da recherchiere ich jetzt schon eine Weile... Für eine "Druckfassung" ist LaTeX natürlich prädestiniert, aber es gibt auch Alternativen wie AsciiDoc/Asciidoctor (http://asciidoctor.org/), die erlauben einfaches Markup und können am Ende in verschiedene Formate exportieren.
Bin mir gerade noch nicht ganz sicher, ob das am Ende mehr oder weniger Aufwand bedeutet (wenn man am Ende an den Konvertierungsoptionen drehen muss...) Aber einen gewissen Reiz hat das schon (und ich bin ohnehin Fan von den letzten Software-"Hits"...)</schmidt>
<schaper>Dito. Wir können gerne etwas ausprobieren, was Sie vorschlagen und vorstrukturieren; wie praktikabel es ist, werden wir schnell sehen ... nur müssten wir bald damit anfangen.</schaper>
<h1>Webseite</h1>
<schmidt>Um kurz zu dokumentieren, woran ich zuletzt sitze: Unabhängig davon, dass ich die Verantwortlichen vom A.W.Schlegel-Projekt (http://august-wilhelm-schlegel.de/briefedigital/info) angeschrieben habe und mich nach deren System erkundigt habe,
würde ich gerne probieren, möglichst viele Bestandteile der Webseite mit einem Framework zu modernisieren. Dabei habe ich mal mit dem Branchenkönig "Bootstrap" angefangen und bisher auf das Ergebnis gekommen:
</schmidt>
<schaper>
Meinen Sie: <a href="../www/prototype/test.html">diesen Prototypen</a>?
</schaper>
</body>
<style>
/**WIP**/
h1{
color:#34495e;
border-top:1px solid #dedede;
padding-top:10px;
font-size:1.3em;
}
h2{
font-size:1em;
margin-bottom:0.1em;
padding-top:2px;
}
body{
color:#34495e;
line-height:1em;
display:block;
width:900px;
margin:2em;
font-size:1em;
font-family:'Lato';
}
schmidt,
schaper{
margin:1em;
display:block;
width:90%;
}
schmidt::before{color:#e74c3c;content:"Schmidt: ";}
schaper::before{color:#2980b9; content:"Schaper: ";}
schmidt{
text-align:left;
}
schaper{
text-align:right;
}
pre {
font-family:"Courier New" Courier monospace;
}
code{
display:block;
background-color:#dedede;
}
li a{
color:blue;
text-decoration:none;
}
</style>
</html>
\ No newline at end of file
/*
* Dynamic Table of Contents script
* by Matt Whitlock
*/
function createLink(href, innerHTML) {
var a = document.createElement("a");
a.setAttribute("href", href);
a.innerHTML = innerHTML;
return a;
}
function generateTOC(toc) {
var i2 = 0, i3 = 0, i4 = 0;
toc = toc.appendChild(document.createElement("ul"));
for (var i = 0; i < document.body.childNodes.length; ++i) {
var node = document.body.childNodes[i];
var tagName = node.nodeName.toLowerCase();
if (tagName == "h3") {
++i4;
if (i4 == 1) toc.lastChild.lastChild.lastChild.appendChild(document.createElement("ul"));
var section = i2 + "." + i3 + "." + i4;
node.insertBefore(document.createTextNode(section + ". "), node.firstChild);
node.id = "section" + section;
toc.lastChild.lastChild.lastChild.lastChild.appendChild(document.createElement("li")).appendChild(createLink("#section" + section, node.innerHTML));
}
else if (tagName == "h2") {
++i3, i4 = 0;
if (i3 == 1) toc.lastChild.appendChild(document.createElement("ul"));
var section = i2 + "." + i3;
node.insertBefore(document.createTextNode(section + ". "), node.firstChild);
node.id = "section" + section;
toc.lastChild.lastChild.appendChild(document.createElement("li")).appendChild(createLink("#section" + section, node.innerHTML));
}
else if (tagName == "h1") {
++i2, i3 = 0, i4 = 0;
var section = i2;
node.id = "section" + section;
toc.appendChild(h2item = document.createElement("li")).appendChild(createLink("#section" + section, node.innerHTML));
}
}
}
This diff is collapsed.
:doctype: book
:source-highlighter: coderay
:pdf-page-size: A4
= Über AsciiDoctor
:homepage: http://asciidoctor.org
:toc:
=== AsciiDoctor Syntax
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
=== AsciiDoctor-PDF
Siehe: http://asciidoctor.org/docs/convert-asciidoc-to-pdf/
==== Theming
Siehe: https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc
=== Befehl zum Konvertieren nach PDF
[source,bash]
----
#asciidoctor-pdf -a pdf-style=pdf-theme.yml -a pdf-fontsdir=fonts/ README.adoc
----
=== Befehl zum Konvertieren nach HTML
[source,bash]
----
#asciidoctor -a stylesheet="./css/bootstrap_sandstone.css" -o output/test_$i.html README.adoc
----
This diff is collapsed.
#!/bin/bash
files=( ../../wiki/*.asciidoc )
output=../../www/docs
css=../www/css
case $1 in
pdf)
for file in "${files[@]}"
do
fullfilename=$(basename $file)
filename=${fullfilename%.*}
asciidoctor-pdf -a pdf-style=./pdf-theme.yml -a pdf-fontsdir=fonts/ -D $output -o $filename.pdf $file;
done
;;
html)
for file in "${files[@]}"
do
fullfilename=$(basename $file)
filename=${fullfilename%.*}
asciidoctor -a stylesheet="$css/bootstrap.sandstone.min.css" -D $output -o $filename.html $file;
done
;;
*)
echo "Programmoptionen sind "pdf" und "html". Dabei werden jeweils die .asciidoc-Dateien aus dem wiki-Verzeichnis genommen und nach $output konvertiert."
exit 1
;;
esac
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment