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

+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.
font:
catalog:
NotoSerif:
normal: NotoSerif-Regular.ttf
italic: NotoSerif-Italic.ttf
bold: NotoSerif-Bold.ttf
bold_italic: NotoSerif-BoldItalic.ttf
NotoSans:
normal: NotoSans-Regular.ttf
italic: NotoSans-Italic.ttf
bold: NotoSans-Bold.ttf
bold_italic: NotoSans-BoldItalic.ttf
page:
layout: portrait
margin: [2cm,2cm,2cm,2cm]
size: a4
base:
font_color: #333333
font_family: NotoSerif
font_size: 10
line_height_length: 12
line_height: $base_line_height_length / $base_font_size
vertical_spacing: $base_line_height_length
heading:
font_color: #93c54b
font_size: 12
font_family: NotoSans
font_style: normal
line_height: 1.2
margin_bottom: $vertical_spacing
h1_font_size: $base_font_size * 1.7
h2_font_size: $base_font_size * 1.5
h3_font_size: $base_font_size * 1.2
h4_font_size: $base_font_size * 1.1
h5_font_size: $base_font_size * 1.0
h3_font_style: bold
h4_font_style: bold
h5_font_style: bold
link:
font_color: #002FA7
outline_list:
indent: $base_font_size * 1.5
code:
font_size:10
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Fork from https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml
# PDF styling guide: https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc
font:
catalog:
# Noto Serif supports Latin, Latin-1 Supplement, Latin Extended-A, Greek, Cyrillic, Vietnamese & an assortment of symbols
Noto Serif:
normal: notoserif-regular-subset.ttf
bold: notoserif-bold-subset.ttf
italic: notoserif-italic-subset.ttf
bold_italic: notoserif-bold_italic-subset.ttf
# M+ 1mn supports ASCII and the circled numbers used for conums
M+ 1mn:
normal: mplus1mn-regular-ascii-conums.ttf
bold: mplus1mn-bold-ascii.ttf
italic: mplus1mn-italic-ascii.ttf
bold_italic: mplus1mn-bold_italic-ascii.ttf
# M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols
# It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font
M+ 1p Fallback:
normal: mplus1p-regular-fallback.ttf
bold: mplus1p-regular-fallback.ttf
italic: mplus1p-regular-fallback.ttf
bold_italic: mplus1p-regular-fallback.ttf
fallbacks:
- M+ 1p Fallback
page:
background_color: ffffff
layout: portrait
margin: [0.5in, 0.67in, 0.67in, 0.67in]
size: A4
base:
align: justify
# color as hex string (leading # is optional)
font_color: 333333
# color as RGB array
#font_color: [51, 51, 51]
# color as CMYK array (approximated)
#font_color: [0, 0, 0, 0.92]
#font_color: [0, 0, 0, 92%]
font_family: Noto Serif
# choose one of these font_size/line_height_length combinations
#font_size: 14
#line_height_length: 20
#font_size: 11.25
#line_height_length: 18
#font_size: 11.2
#line_height_length: 16
font_size: 10.5
#line_height_length: 15
# correct line height for Noto Serif metrics
line_height_length: 12
#font_size: 11.25
#line_height_length: 18
line_height: $base_line_height_length / $base_font_size
font_size_large: round($base_font_size * 1.25)
font_size_small: round($base_font_size * 0.85)
font_size_min: $base_font_size * 0.75
font_style: normal
border_color: eeeeee
border_radius: 4
border_width: 0.5
# FIXME vertical_rhythm is weird; we should think in terms of ems
#vertical_rhythm: $base_line_height_length * 2 / 3
# correct line height for Noto Serif metrics (comes with built-in line height)
vertical_rhythm: $base_line_height_length
horizontal_rhythm: $base_line_height_length
# QUESTION should vertical_spacing be block_spacing instead?
vertical_spacing: $vertical_rhythm
link:
font_color: 428bca
# literal is currently used for inline monospaced in prose and table cells
literal:
font_color: b12146
font_family: M+ 1mn
heading:
#font_color: 181818
font_color: $base_font_color
font_family: $base_font_family
font_style: bold
# h1 is used for part titles
h1_font_size: floor($base_font_size * 2.6)
# h2 is used for chapter titles
h2_font_size: floor($base_font_size * 2.15)
h3_font_size: round($base_font_size * 1.7)
h4_font_size: $base_font_size_large
h5_font_size: $base_font_size
h6_font_size: $base_font_size_small
#line_height: 1.4
# correct line height for Noto Serif metrics (comes with built-in line height)
line_height: 1.2
margin_top: $vertical_rhythm * 0.2
margin_bottom: $vertical_rhythm * 0.8
title_page:
align: right
logo:
top: 10%
image: http://syncope.apache.org/images/apache-syncope-logo-small.jpg
title:
top: 55%
font_size: $heading_h1_font_size
font_color: 999999
line_height: 0.9
subtitle:
font_size: $heading_h3_font_size
font_style: bold_italic
line_height: 1
authors:
margin_top: $base_font_size * 1.25
font_size: $base_font_size_large
font_color: 181818
revision:
margin_top: $base_font_size * 1.25
block:
margin_top: 0
margin_bottom: $vertical_rhythm
caption:
align: left
font_style: italic
# FIXME perhaps set line_height instead of / in addition to margins?
margin_inside: $vertical_rhythm / 3
#margin_inside: $vertical_rhythm / 4
margin_outside: 0
lead:
font_size: $base_font_size_large
line_height: 1.4
abstract:
font_color: 5c6266
font_size: $lead_font_size
line_height: $lead_line_height
font_style: italic
admonition:
border_color: $base_border_color
border_width: $base_border_width
padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm]
blockquote:
font_color: $base_font_color
font_size: $base_font_size_large
border_color: $base_border_color
border_width: 5
padding: [$vertical_rhythm / 2, $horizontal_rhythm, $vertical_rhythm / -2, $horizontal_rhythm + $blockquote_border_width / 2]
cite_font_size: $base_font_size_small
cite_font_color: 999999
# code is used for source blocks (perhaps change to source or listing?)
code:
font_color: $base_font_color
font_family: $literal_font_family
font_size: ceil($base_font_size)
padding: $code_font_size
line_height: 1.25
background_color: f5f5f5
border_color: cccccc
border_radius: $base_border_radius
border_width: 0.75
conum:
font_family: M+ 1mn
font_color: $literal_font_color
font_size: $base_font_size
line_height: 4 / 3
example:
border_color: $base_border_color
border_radius: $base_border_radius
border_width: 0.75
background_color: transparent
# FIXME reenable margin bottom once margin collapsing is implemented
padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm]
image:
align: left
prose:
margin_top: 0
margin_bottom: $vertical_rhythm
sidebar:
border_color: $page_background_color
border_radius: $base_border_radius