Ctrl+K

Überschrift Ebene 2

Dieses Kapitel enthält in dichter Form alle Typographie-Elemente, die in den folgenden Kapiteln möglicherweise verwendet werden. Grundlage für die technische Zusammenarbeit mit dem Verlag.

Quelle: https://mystmd.org/guide/typography und anchließende Seiten

Überschrift Ebene 2#

Überschriften Ebene 2 sind das am meisten vorkommende Gliederungselement. Jede Überschrift hat eine eindeutige id, entweder per Hand zugeteilt, sonst automatisch generiert

Überschrift Ebene 3 Wenn Überschriften Ebene 3 verwendet werden sollten, dann idealerweise wie hier als Spitzmarke. Klären: Solche Gliederungselemente tatsächlich als Überschrift 3 auszeichnen, wie in was-identifiziert-ein-URI ausprobiert wird, oder lieber wie hier fett mit harter Formatierung?

Querverweise#

Querverweise: Alle Kapitel und Unterkapitel haben eine eindeutige ID, die man trivialerweise für Querverweise verwenden kann.

Warning

TBD In den folgenden Beispielen ist zwar in der html-Fassung, NICHT aber im docx-Dokument der dokumenten-interne Link enthalten: ein Bug von mystmd?

  • Markdown: Im Kapitel [](#einfuehrung) wird in das Werk eingeführt.

  • docx: Im Kapitel Einführung wird in das Werk eingeführt.

oder so:

  • Jupyterbook kompatibles Markdown: Im Kapitel {doc}`einfuehrung` wird in das Werk eingeführt.

  • docx: Im Kapitel einfuehrung wird in das Werk eingeführt.

In docx

Natürlich verweisen wir auf Abbildungen wie z.B. Typographische Darstellung von Python-Code incl. Ausgabe aus , aber auch auf Code-Kästen wie z.B. #typographie-jupyter-book-bsp42-code.

Begriffe: Dieser Text hat nicht nur Linked Data, sondern insbesondere auch die Unterscheidung von Wörtern und Begriffen zum Thema. „Text“ in diesem Zusammenhang („deutsche“ Anführungszeichen) ist nicht nur “content” (“englische” Anführungszeichen), sondern ebenso auch ein knowledge graph (kursiv, selten verwendet, besser als Link ins Glossar, s.u.). Eine lediglich typographische Hervorhebung wäre zu unbestimmt, wir wollen Begriffe vernetzen:

  • der Tag {term} `RDF(S)` wird dargestellt als RDF(S) und führt uns ins glossar

  • auch (insbesondere die deutsche) https://de.wikipedia.org/wiki/Wikipedia (URI lang und explizit) spielt in unserer (URI nur mit Titel) eine gewisse Rolle: zwar nicht als Garant von Wahrheit-, aber wenigstens als Dokumentation von Konsens.

Kästen#

Wikipedia-Kästen. Bei der Begriffsklärung gehen wir methodisch von einem Begriffsverständnis aus, wie es bei Wikipedia als (oft, aber nicht immer „wahrer“) Konsens dokumentiert ist. Für Begriffe aus Wikipedia gibt es daher einen eigenen Kasten:

Hint

https://de.wikipedia.org/wiki/Kasten_(Schriftsatz) Kasten: ein durch Umrandung begrenzter, besonderer Bereich.

TBD-Kästen müssen im Druck natürlich alle ‘draußen sein:

Warning

TBD KOMMUNIKATION mit mir selbst und dem Verlag: Fragen an den Verlag oder mich selbst, die der Absprache bedürfen, sind hier als WARNING und/oder mit dem Text TBD (to be done) eingefügt.

Daten-Kasten. In der Informatik sind natürlich Dateien, die Daten oder Code enthalten, schon immer ein First Class Objekt. Hier z.B. eine .ttl-Datei:

:Kuhmilch
   rdfs:subClassOf :Milch .
:Kuh
   rdfs:subClassOf :Tier .

Warning

TBD In 2019 noch so üblich, aber 2024 auch nicht mehr Stand der Technik die Code-Blöcke aus

Für ein Buch aus 2022 unschön die Auszeichnung von Python Code in , siehe z.B. Kap. 3.3.1

Es ist üblich und gut, für Code eine nichtproportionale Schriftart (z.B. Courier) vorzusehen. Fehlerhaft wäre es nicht zu berücksichtigen, dass (wie z.B. in Courier) die Versalhöhe von Courier und natürlich der Grauwert von Monospace Schriften ganz anders ist als die der Werkschrift.

Abhilfe: Die Schriftgröße von Code auf z.B. 80% der Werkschrift reduzieren, sowie den Zeilenabstand ähnlich wiedergeben wie in der Entwicklungsumgebung, also insbesondere auf „einzeilig” zu reduzieren.

Warning

TBD TBD: Überlegen, ob man auch umfangreichere Datenblöcke abbilden will? Ggf. auch nur die ersten Zeilen zeigen, dann eine Verlinkung zur Online-Seite zum Buch.

Code-Kästen (optional)#

Ausführliche Doku siehe https://mystmd.org/guide/code

Mit https://jupyter.org/ (inzwischen Stand der Technik in der Data Science) kann man in Markdown-Text Python-Code einbetten – der dann ausgeführt wird (!) und auch das Ergebnis der Ausführung in den Text einbettet (!!). So sieht das aus:

print(f"Die Antwort lautet {6*7}")

Warning

TBD Derzeit ist zwar die Ausgabe, nicht aber der Code selbst im docx enthalten: Bug? Konfiguration?

So sieht es im Web aus: http://jbusse.de/gendifs/r_semantics_isa.html

Ideal für den Satz wäre es, solche Paare von Code und Ausgabe durch ein geeignetes Layout sichtbar zu machen. Online sieht das typischerweise aus wie in Typographische Darstellung von Python-Code incl. Ausgabe aus . (web: natürlich ein Link. DOCX: leider kein Link hier)

ABER es ist derzeit noch unklar, ob im Buch überhaupt ausführbarer Code enthalten sein und abgedruckt werden soll.

Abbildungen#

Quelle: https://mystmd.org/guide/figures

BEGINN DER ABBILDUNG typographie-jupyter-book-bsp42

Random image of the beach or ocean!

Fig. 5 Typographische Darstellung von Python-Code incl. Ausgabe aus Code-Kästen (optional)#

ENDE DER ABBILDUNG

Zusammenarbeit mit dem Verlag, klären:

  • Von Text, Websites etc. kann ich png-Screenshots machen: Aber reicht die Auflösung für den Druck?

  • definiere den Zoom-Faktor vor dem Screenshot

  • haben Abbildungen im Druck einen Rand?

Herausforderung größere / detailliertere Mindmaps: auch hier Auflösung und Zoom-Faktor festlegen. Beispiel:

_images/rdf11-concepts.png

Fig. 6 Abbildung aus http://jbusse.de/gendifs/x_rdf11-concepts.html#

Zitate#

Quelle: https://mystmd.org/guide/citations

MyST also provides a number of roles for compatibility with Sphinx and JupyterBook. To create a citation role in Markdown, use either a parenthetical or textual citation:

  • parenthetical citation {cite:p}`gruberPrinciplesDesignOntologies1995`: [Gru95].

  • narrative citation with {cite:t}`gruberPrinciplesDesignOntologies1995` : Gruber [Gru95].

  • add prefix and suffix {cite:p}`{see}gruberPrinciplesDesignOntologies1995{fig 1}`: [see Gru95, fig 1].

This is the difference between: [Gru95] and Gruber [Gru95]. You can have many citation keys in a single role, by separating them with a semicolon, ;, for example: [Gru95]. Including a prefix or suffix is displayed as [see Gru95, fig 1].

You can also include DOIs in citations (cite, cite:t, and cite:p) which will be linked in the same way as a simple markdown link, but will match the reference style of the project.

This will be a citation: {cite}`10.1093/nar/22.22.4673`.

This will show as: [].

Quotations, Quelle: https://mystmd.org/guide/typography#quotations : siehe was-ist-ein-URI

Contents