From 7c004e53e454e0e935e191f77076c14aceeac999 Mon Sep 17 00:00:00 2001 From: "Andreas M. Antonopoulos" Date: Tue, 7 Feb 2023 11:20:41 -0600 Subject: [PATCH] Translation instructions --- README.md | 4 +- TRANSLATING.md | 61 +++++++++++++++++++++++++++++++ translation_contributors.asciidoc | 5 +++ 3 files changed, 68 insertions(+), 2 deletions(-) create mode 100644 TRANSLATING.md create mode 100644 translation_contributors.asciidoc diff --git a/README.md b/README.md index b871d6e..245b97d 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Mastering the Lightning Network is released under the Creative Commons CC-BY-SA Creative Commons License
Mastering the Lightning Network by Andreas M. Antonopoulos, Olaoluwa Osuntokun, Rene Pickhardt is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Based on a work at https://github.com/lnbook/lnbook. -This "Free Culture" compliant license was approved by my publisher O'Reilly Media (http://oreilly.com), who understands the value of open source. O'Reilly Media is not just the world's best publisher of technical books, but is also a strong supporter of this open culture and the sharing of knowledge. +This "Free Culture" compliant license was approved by our publisher O'Reilly Media (http://oreilly.com), who understands the value of open source. O'Reilly Media is not just the world's best publisher of technical books, but is also a strong supporter of this open culture and the sharing of knowledge. Thank you O'Reilly Media! @@ -79,7 +79,7 @@ Thank you O'Reilly Media! The current license permits derivative work, such as independent translations and the production and circulation of PDF, HTML or other derivative renderings of the source ASCIIDOC. *The license does not extend to O'Reilly Media intellectual property, such as the cover page.* -If you are interested in translating this book, please join our team of volunteers at: https://www.transifex.com/aantonop/mastering-the-lightning-network +If you are interested in translating this book please see [TRANSLATING.md](TRANSLATING.md) [cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/ [cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png diff --git a/TRANSLATING.md b/TRANSLATING.md new file mode 100644 index 0000000..d697ef4 --- /dev/null +++ b/TRANSLATING.md @@ -0,0 +1,61 @@ +# Translating "Mastering the Lightning Network" + +This book is now available under an open license, and therefore it is now possible to produce open licensed derivatives such as translations. + +## Translating on Transifex + +The translation effort is coordinated through the ["Mastering the Lightning Network" project](https://www.transifex.com/aantonop/mastering-the-lightning-network) on the [Transifex](https://www.transifex.com) platform. + +Volunteers can contribute to different translations on an ad-hoc basis. Contributions to the translation fall under the same CC-BY-SA license and the English version of the book. + +## Translating ASCIIDOC markup + +The book's source files use the ASCIIDOC markup language with a few specialized extensions and stylesheet for the print edition by O'Reilly. + +If you are translating the book, you must translate all content _without_ translating markup symbols, variable names, file names, anchors, references, command-line commands, and other markup related entries. + +For example, in the following ASCIIDOC source: + +``` +[[set_up_a_lightning_node]] +== Lightning Node Software + +((("Lightning node software", id="ix_04_node_client-asciidoc0", range="startofrange")))As we have seen in previous chapters, a Lightning node is a computer system that participates in the Lightning Network. + +[role="pagebreak-before"] + +On macOS, a common package manager used for open source development is https://brew.sh[Homebrew], which is accessed by the command +brew+. + +[TIP] +==== +In many of the examples in this chapter we will be using the operating system's command-line interface +==== + +Enter the following command shown in <>: + +[[cd-lnbook]] +---- +$ cd lnbook +---- + +What result does this command produce? + +``` + +In this text above there are many markup symbols, anchors, references and formatting directives. These must not be translated. This includes: + +* Anchors between double square brackets eg. ```[[set_up_a_lightning_node]]``` +* References to anchors between less-than, greater-than symbols eg. ```<>``` +* Code blocks between lines with four dashes eg. ```----``` +* Template directives in square brackets eg. ```[TIP]``` +* Formatting directives eg. ```[role="pagebreak-before"]``` +* Indexing directives in three-parenthesis eg. ```((("Lightning node software", id="ix_04_node_client-asciidoc0", range="startofrange")))``` +* Links eg. ```https://brew.sh``` (but translate the text ```[Homebrew]``` that is the anchor text) + +## Attribution + +If you contribute translations you are responsible for adding your own attribution, which you can do by adding your name to the [translation_contributors.asciidoc](translation_contributors.asciidoc) file on Github, under the corresponding language. + +## Derivatives + +If you produce a derivative of a translation (eg. a PDF, ebook or print book), you MUST include attribution to the original authors, the original githb contributors and the translation contributors for that language. You must also license your derivative under a CC-BY-SA license and make the source files available for free under a CC-BY-SA license. diff --git a/translation_contributors.asciidoc b/translation_contributors.asciidoc new file mode 100644 index 0000000..155f371 --- /dev/null +++ b/translation_contributors.asciidoc @@ -0,0 +1,5 @@ +=== Spanish Language Translation Contributors + +* Sample Name + +=== Other Language Translation Contributors