From 5b228a8022b039680e28bfa0c99537aadd566074 Mon Sep 17 00:00:00 2001 From: Matthias Jung Date: Tue, 3 Feb 2026 16:44:08 +0100 Subject: [PATCH] refactor: split readme in several files --- CONTRIBUTING.md | 36 +++++ LICENSE.md | 395 +++++++++++++++++++++++++++++++++++++++++++++++ README-FORMAT.md | 125 +++++++++++++++ README.md | 147 +----------------- 4 files changed, 560 insertions(+), 143 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README-FORMAT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2de8686 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Mitmachen bei 50ohm.de + +## Lizenzierung deiner Arbeit an uns + +Wenn du einen Pull Request eröffnest, erklärst du dich damit einverstanden, dass deine Beiträge unter der [Projektlizenz](LICENSE) bereitgestellt werden. Außerdem stimmst du zu, uns die notwendigen Rechte an deiner Arbeit einzuräumen, damit diese auch in zukünftigen Druckausgaben verwendet werden kann, insbesondere für den DARC-Verlag. + +Sollten deine Änderungen in einer gedruckten Ausgabe erscheinen, wirst du in der [Mitwirkendenliste](README.md) in der README aufgeführt. + +## Ein Problem melden + +Suche zunächst nach ähnlichen Issues, bevor du ein neues erstellst. Vergewissere dich, dass das von dir gefundene Problem wirklich ein Fehler ist. + +## Kleine Korrekturen + +Errata und grundlegende Klarstellungen werden akzeptiert, sofern wir der Meinung sind, dass sie den Inhalt verbessern. +Du kannst auch ein Issue eröffnen, damit wir besprechen können, wie oder ob das Problem behoben werden sollte. + +Falls du so etwas noch nie gemacht hast, könnte der [Flow-Leitfaden](https://docs.github.com/de/get-started/quickstart/github-flow) hilfreich sein. + +## Größere Überarbeitungen + +Bitte eröffne vor umfangreicheren Änderungen zunächst ein Issue zur Diskussion. + +Größere Überarbeitungen sind häufig mit subjektiven Einschätzungen verbunden. Um zu vermeiden, dass Zeit in Beiträge investiert wird, die später nicht übernommen werden können, stimmen wir solche Änderungen gern vorab gemeinsam ab. + +Im Sinne der Qualitätssicherung sowie zur Einhaltung der Vorgaben des vom DARC e. V. entwickelten Lehrplans und der Philosophie von 50ohm.de behalten wir uns vor, eingereichte Pull Requests zu überprüfen, anzupassen oder ggf. abzulehnen. + +## DARCDown und Syntax + +Für die Inhalte nutzen wir einen Markdown-Dialekt namens DARCdown, dessen Syntax in diesem [Dokument](README-FORMAT.md) beschrieben wird. + +## Zeichnungen + +Die Zeichnungen werden durch LaTeX und TikZ umgesetzt. Hierbei kommt insbesondere die Bibliothek [CircuiTikZ](https://ctan.org/pkg/circuitikz?lang=de) zum Einsatz. Ein direktes Modifizieren der SVG-Dateien ist für die deutschen Inhalte nicht vorgesehen! + +Das Python-Skript `src/build_drawings.py` wird verwendet, um ein neues Bild zu erstellen. Beim Aufrufen des Skripts muss eine Bildnummer eingegeben werden. Die Bildnummern müssen aufsteigend vergeben werden: Bitte hierzu vorher ein Issue öffnen. Außerdem ist es notwendig, dass das Programm *pdftocairo* installiert ist, um ein SVG zu generieren. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..4ea99c2 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,395 @@ +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README-FORMAT.md b/README-FORMAT.md new file mode 100644 index 0000000..4308496 --- /dev/null +++ b/README-FORMAT.md @@ -0,0 +1,125 @@ +# DARCdown + +Im folgenden werden die entsprechenden Kommandos von DARCdown beschrieben: Grundsätzliche gilt wie bei Makdown: Den Text einfach so hinschreiben. Allerdings gibt es ein paar Spezialbefehle die wir im folgenden beschreiben wollen. + +## Fragen, Zeichnungen und Fotos + +Fragen, Bilder und Fotos werden mit [ ]-Befehlen eingebunden, wobei der Doppelpunkt als Trennzeichen verwendet wird. Als erstes kommt der Befehl, dann die ID, bei Bildern folgt noch ein interner Bezeichner (für Referenzen) und dann die Bildbeschreibung. Interne Bezeichner mit dem Kurznamen des Abschnitts beginnen lassen. + +Prüfungsfrage: +``` +[question:AB123] +``` + +Zeichung: +``` +[picture:484:n_funkhorizont:Ausbreitung] +``` + +Foto: +``` +[photo:123:n_wasserfalldiagramm_trx_collage:Ansichten verschiedener Transceiver] +``` + +## Referenzen + +Auf Bilder und Tabellen kann im Text mit dem ref-Kommando verwiesen werden. Dabei ist der interne Bezeichner anzugeben: + +``` +[ref:n_funkhorizont] +``` + +## Tabellen + +Tabellen werden mit senkrechten Strichen "gemalt". Der senkrechte Strich ist auf der Tastatur mit Alt-Gr und der kleiner-als-Taste links vom Y erreichbar. Die erste Zeile ist die Kopfzeile, dort wird die Ausrichtung der Spalte festgelegt (l: linksbündig, c: zentriert, r: rechtsbündig, X: mehrzeilig linksbündig). Am Ende muss ein Tabellen-Kommando folgen. Nach dem table-Befehl folgt hier wie bei den Bildern ein interner Bezeichner (für Referenzen) und die Tabellenbeschreibung. + +``` +| l: Vorname | l: Rufzeichen | +| Max | DO7MAX | +| Luisa | DL2LS | +| Noa | DG5NOA | +[table:n_rufzeichen_beispiele:Beispiele für Rufzeichen] +``` + +## Besondere Abschnitte + +* Randbemerkung: `...` +* Achtung: `...` +* Vertiefung: `...` +* Tipp: `...` +* Randbemerkung im Web, aber nicht in LaTeX, dort wird es Fließtext: `...` +* Tipp als Randbemerkung im Web, aber nicht in LaTeX, dort wird es Fließtext: `...` +* Vertiefung als Randbemerkung im Web, in LaTeX geht es über die komplette Seitenbreite: `...` +* Nur im Web, nicht im LaTeX: `...` +* Nur im LaTeX, nicht im Web: `...` + +## Aufzählungen + +Eine Aufzählung kann mit * eingeleitet werden. Nach dem letzten Punkt _muss_ eine Leerzeile folgen. + +``` +* Apfel und Apfelsinen +* Bananen und Birnen +* Clementinen und Zitronen +``` + +Eine nummerierte Aufzählung erfolgt einfach indem die Nummern vorangestellt werden. Nach dem letzten Punkt _muss_ wieder eine Leerzeile folgen. + +``` +1. Netzteil einschalten +2. Transceiver einschalten +3. PTT drücken +``` + +## Hervorhebungen + +Einzele Wörter und Wortgruppen lassen sich mit dem Stern hervorheben: + +Einige *wichtige Wörter* hervorheben + +## Formeln und Einheiten + +Für Formeln wird wie bisher der LaTeX-Mathemodus benutzt: + +``` +$R = \frac{U}{I}$ +``` + + +Für Einheiten das Paket [siunitx](https://ctan.org/pkg/siunitx?lang=de): + +``` +Die Endstufe hat eine Leistung von $\qty{750}{\watt}$. + +Die Einheit der Frequenz ist $\unit{\hertz}$ + +Die Länge des Drahts muss zwischen $\qtyrange{1}{10}{\meter}$ liegen. +``` + +## Morsecode + +Morsezeichen können mit dem Morse-Befehl geschrieben werden. + +``` +[morse:CQ CQ] +QSOs +``` + +QSOs können ebenfalls wiedergegeben werden. qso_own sind die Funksprüche der einen Station und qso_other für die Gegenstation: + +``` +[qso_own:CQ CQ DE DL1PZ K] +[qso_other:DL1PZ DO2MAX U R 59 K] +``` + +## Kommentare + +Kommentare gehen weiterhin per %-Zeichen, aber nur am Anfang der Zeile! TODO als Markierung für offene Aufgaben. + +``` +% TODO Der Absatz muss neu formuliert werden +``` + +## Links + +Hyperlinks sollten immer über den 50ohm.de-URL-Shortener abgebildet werden. \ No newline at end of file diff --git a/README.md b/README.md index 9b4a436..b9eff49 100644 --- a/README.md +++ b/README.md @@ -2,142 +2,9 @@ Dieses Repository enthält die Inhalte der Plattform 50ohm.de. Der Plattform-Code findet sich in einem gesonderten [Repository](https://github.com/DARC-e-V/50ohm). Die Lernplattform ist ein Angebot des AJW-Referats des DARC (Deutscher Amateur-Radio-Club e.V.). Viele ehrenamtlichen Mitarbeiterinnen und Mitarbeiter sind daran beteiligt. -# DARCdown +# Lizenz und Pull-Requests -Für die Inhalte nutzen wir einen Markdown dialekt namens DARCdown. Im folgenden werden die entsprechenden Kommandos beschrieben: Grundsätzliche gilt wie bei Makdown: Den Text einfach so hinschreiben. Allerdings gibt es ein paar Spezialbefehle die wir im folgenden beschreiben wollen. - - -## Fragen, Zeichnungen und Fotos - -Fragen, Bilder und Fotos werden mit [ ]-Befehlen eingebunden, wobei der Doppelpunkt als Trennzeichen verwendet wird. Als erstes kommt der Befehl, dann die ID, bei Bildern folgt noch ein interner Bezeichner (für Referenzen) und dann die Bildbeschreibung. Interne Bezeichner mit dem Kurznamen des Abschnitts beginnen lassen. - -Prüfungsfrage: -``` -[question:AB123] -``` - -Zeichung: -``` -[picture:484:n_funkhorizont:Ausbreitung] -``` - -Foto: -``` -[photo:123:n_wasserfalldiagramm_trx_collage:Ansichten verschiedener Transceiver] -``` - -## Referenzen - -Auf Bilder und Tabellen kann im Text mit dem ref-Kommando verwiesen werden. Dabei ist der interne Bezeichner anzugeben: - -``` -[ref:n_funkhorizont] -``` - -## Tabellen - -Tabellen werden mit senkrechten Strichen "gemalt". Der senkrechte Strich ist auf der Tastatur mit Alt-Gr und der kleiner-als-Taste links vom Y erreichbar. Die erste Zeile ist die Kopfzeile, dort wird die Ausrichtung der Spalte festgelegt (l: linksbündig, c: zentriert, r: rechtsbündig, X: mehrzeilig linksbündig). Am Ende muss ein Tabellen-Kommando folgen. Nach dem table-Befehl folgt hier wie bei den Bildern ein interner Bezeichner (für Referenzen) und die Tabellenbeschreibung. - -``` -| l: Vorname | l: Rufzeichen | -| Max | DO7MAX | -| Luisa | DL2LS | -| Noa | DG5NOA | -[table:n_rufzeichen_beispiele:Beispiele für Rufzeichen] -``` - -## Besondere Abschnitte - -* Randbemerkung: `...` -* Achtung: `...` -* Vertiefung: `...` -* Tipp: `...` -* Randbemerkung im Web, aber nicht in LaTeX, dort wird es Fließtext: `...` -* Tipp als Randbemerkung im Web, aber nicht in LaTeX, dort wird es Fließtext: `...` -* Vertiefung als Randbemerkung im Web, in LaTeX geht es über die komplette Seitenbreite: `...` -* Nur im Web, nicht im LaTeX: `...` -* Nur im LaTeX, nicht im Web: `...` - -## Aufzählungen - -Eine Aufzählung kann mit * eingeleitet werden. Nach dem letzten Punkt _muss_ eine Leerzeile folgen. - -``` -* Apfel und Apfelsinen -* Bananen und Birnen -* Clementinen und Zitronen -``` - -Eine nummerierte Aufzählung erfolgt einfach indem die Nummern vorangestellt werden. Nach dem letzten Punkt _muss_ wieder eine Leerzeile folgen. - -``` -1. Netzteil einschalten -2. Transceiver einschalten -3. PTT drücken -``` - -## Hervorhebungen - -Einzele Wörter und Wortgruppen lassen sich mit dem Stern hervorheben: - -Einige *wichtige Wörter* hervorheben - -## Formeln und Einheiten - -Für Formeln wird wie bisher der LaTeX-Mathemodus benutzt: - -``` -$R = \frac{U}{I}$ -``` - - -Für Einheiten das Paket [siunitx](https://ctan.org/pkg/siunitx?lang=de): - -``` -Die Endstufe hat eine Leistung von $\qty{750}{\watt}$. - -Die Einheit der Frequenz ist $\unit{\hertz}$ - -Die Länge des Drahts muss zwischen $\qtyrange{1}{10}{\meter}$ liegen. -``` - -## Morsecode - -Morsezeichen können mit dem Morse-Befehl geschrieben werden. - -``` -[morse:CQ CQ] -QSOs -``` - -QSOs können ebenfalls wiedergegeben werden. qso_own sind die Funksprüche der einen Station und qso_other für die Gegenstation: - -``` -[qso_own:CQ CQ DE DL1PZ K] -[qso_other:DL1PZ DO2MAX U R 59 K] -``` - -## Kommentare - -Kommentare gehen weiterhin per %-Zeichen, aber nur am Anfang der Zeile! TODO als Markierung für offene Aufgaben. - -``` -% TODO Der Absatz muss neu formuliert werden -``` - -## Zeichnungen - -Die Zeichnungen werden durch LaTeX und TikZ umgesetzt. Hierbei kommt insbesondere die Bibliothek [CircuiTikZ](https://ctan.org/pkg/circuitikz?lang=de) zum Einsatz. Ein direktes modifizieren der SVG-Dateien ist für die deutschen Inhalte nicht vorgesehen! - -Das Python-Skript `src/build_drawings.py` wird verwendet, um ein neues Bild zu erstellen. Beim Aufrufen des Skripts muss eine Bildnummer eingegeben werden. Die Bildnummern müssen aufsteigend vergeben werden. Außerdem ist es notwendig, dass das Programm *pdftocairo* installiert ist, um ein SVG zu generieren. - -## Links - -Hyperlinks sollten immer über den 50ohm.de-URL-Shortener abgebildet werden. - -# Lizenz und Pull-Request - -Die Inhalte stehen unter der [CC BY 4.0 Lizenz](https://creativecommons.org/licenses/by/4.0/deed.de) +Die Inhalte stehen unter der [CC BY 4.0 Lizenz](LICENSE.md). Wenn du zu dem Repository beitragen möchtest, dann beachte bitte folgende [Hinweise](CONTRIBUTING.md). ## Hinweis zur Namensnennung (CC BY) @@ -145,9 +12,9 @@ Bei der Verwendung der Materialien auf 50ohm.de müssen angemessene Urheber- und Diese Angaben dürfen in jeder angemessenen Art und Weise erfolgen, jedoch nicht so, dass der Eindruck entsteht, der Lizenzgeber unterstütze oder befürworte die jeweilige Nutzung in besonderer Weise. -Bitte nenne als Urheber: +Bitte nenne als Urheber (Mitwirkendenliste): -> 50ohm.de – Autorenteam Koordiniert durch das AJW-Referat des DARC e. V. +> 50ohm.de–Autorenteam Koordiniert durch das AJW-Referat des DARC e. V. > > Matthias Amberg (DG4MA), Henrik Bartels (DL6OCH), Jan Behrens (DL9JBE), Helmut Berka (DL2MAJ), Mathias Dahlke (DJ9MD), Michael Danowski (DK6QW), Christian Dasch (DO1CMD), Sabrina Deharde (DO7XK), Lucas Ebersberger (DA1EE), Klaus Finkenzeller (DL5MCC), Christoph Fischer (DC6GF), Michael Funke (DL4EAX), Tim Grelka (DA2TG), Michael Groni (DB7YI), Prof. Dr. Michael Hartje (DK5HH), Christian Hillmer (DM7EE), Ronny Jerke (DG2RON), Prof. Dr. Matthias Jung (DL9MJ), Thomas Kamp (DF5JL), Erich Kless (DD4UQ), Karlheinz Krause (DL4DBY), Stephan Kregel (DG1HXJ), Dr. Andreas Krüger (DJ3EI), Michael Lowack (DK1KC), Rüdiger Maaß (DF7LYN), Daniel Mittendorf (DK5WP), Michael Moller (DG9NDT), Christian Reiber (DL8MDW), Harald Rode (DL4HR), Florian Schmid (DL1FLO), Prof. Dr. Herrmann Schumacher (DF2DR), Alexander Schumacher (DL1ASN), Marco Schwan (DC8WAN), Prof. Dr. Klaus Solbach (DK3BA), Björn Swierczek (DL1PZ), Aaron Thielmann (DB9TT), Carmen Weber (DM4EAX), Lars Weiler (DC4LW), Daniel Wendt-Fröhlich (DL2AB), Severin Wiedemann (DL9SW) @@ -159,12 +26,6 @@ Am Fragenkatalog, welcher in Kooperation mit der Bundesnetzagentur entstand, war > Fabian Amann (DC1SAF), Matthias Amberg (DG4MA), Henrik Bartels (DL6OCH), Jan Behrens (DL9JBE), Michael Berger (DF7SA), Helmut Berka (DL2MAJ), Dr.-Ing. Hartmut Büttig (DL1VDL), Mathias Dahlke (DJ9MD), Michael Danowski (DK6QW), Sabrina Deharde (DO7XK), Hendrik Dietrich (DG3HDA), Marcus Engelmann (DL2DCX), Klaus Finkenzeller (DL5MCC), Christian Frieß (DL2MDU), Michael Funke (DL4EAX), Michael Gebhardt (DM1CHL), Lukas Greiner (KN6PSU), Michael Groni (DB7YI), Prof. Dr.-Ing. Michael Hartje (DK5HH), Gerrit Herzig (DH8GHH), Thomas Hillen (DF2TH), Christian Hillmer (DM7EE), Martin Jerabek (DK1MJ), Ronny Jerke (DG2RON), Prof. Dr.-Ing. Matthias Jung (DL9MJ), Klaus Jung (DL5KJ), Thomas Kamp (DF5JL), Erich Kless (DD4UQ), Peter Kornherr (DK4KP), Karlheinz Krause (DL4DBY), Stephan Kregel (DG1HXJ), Dr. Andreas Krüger (DJ3EI), Martin Kuhn (DL3SFB), Stefan Lampprecht (DL1SL), Manfred Lauterborn (DK2PZ), Markus Lör (DO2MLS), Michael Lowack (DK1KC), Jürgen Lutz (DK3OL), Hannes Matuschek (DM3MAT), Günther Mildenberger (DL4BX), Daniel Mittendorf (DK5WP), Michael Moller (DG9NDT), Roy Muselick (DM4ET), Andreas Nützel (DG4MIC), Ralph Oppelt (DL2NDO), Dr.-Ing. Henning Paul (DC4HP), Marei Peischl, Peter Pfann (DL2NBU), Christian Reiber (DL8MDW), LL.B. Lukas Reinhardt (DO7VLR), Harald Rode (DL4HR), Uwe Rüdiger (DG2DBF), Paul Schimanski (DF4ZL), Florian Schmid (DL1FLO), Werner Schmidt (DL4YBZ), Malte Schmitz (DE7LMS), Stefan Scholl (DC9ST), Alexander Schumacher (DL1ASN), Marco Schwan (DC8WAN), Björn Swierczek (DL1PZ), Aaron Thielmann (DB9TT), Jann Traschewski (DG8NGN), Alexander Vidoni (DK6AV), Werner Vollmer (DF8XO), Carmen Weber (DM4EAX), Michael Weber (DL1XMW), Lars Weiler (DC4LW), Wolfgang Welter (DL2KBJ), Daniel Wendt-Fröhlich (DL2AB), Severin Wiedemann (DL9SW), Udo Witte (DJ4FV), Dipl.-Ing. Claus-Dieter Wittek (DF8QJ), Bernhard Zimmermann (DG3BZ) -## Pull-Requests - -Durch einen Pull-Request akzeptiert man autoamtisch die CC BY Lizenzbedingungen. - -Wir behalten uns im Sinne der Qualitätssicherung sowie zur Einhaltung der Vorgaben des vom DARC e. V. entwickelten Lehrplans und der Philosophie von 50ohm.de vor, eingereichte Pull Requests abzulehnen oder zu modifizieren. - # Kontakt Verantwortlich für das Betreiben von 50ohm.de ist das AJW-Referat des DARC e. V. in Baunatal. Bei Anfragen bitte die Email-Adresse [50ohm@darc.de](mailto:50ohm@darc.de) nutzen. Weiterhin findet man viele der Beitragenden im Matrix-Kanal [Ausbilder-Netzwerk](https://matrix.to/#/#AusbilderNetzwerk:darc.de). \ No newline at end of file