diff --git a/Makefile b/Makefile index 54d53fb1..446e86d2 100644 --- a/Makefile +++ b/Makefile @@ -10,12 +10,17 @@ all: $(NAME).pdf clean: rm -f $(NAME).pdf -$(NAME).pdf: $(NAME).adoc $(wildcard *.adoc) resources/themes/risc-v_spec-pdf.yml +docs-resources/README.md: + git submodule update --init + +docs-resources/themes/riscv-pdf.yml: docs-resources/README.md + +$(NAME).pdf: $(NAME).adoc $(wildcard *.adoc) docs-resources/themes/riscv-pdf.yml asciidoctor-pdf \ -a compress \ -a date="$(DATE)" \ -a monthyear="$(MONTHYEAR)" \ - -a pdf-style=resources/themes/risc-v_spec-pdf.yml \ - -a pdf-fontsdir=resources/fonts \ + -a pdf-style=docs-resources/themes/riscv-pdf.yml \ + -a pdf-fontsdir=docs-resources/fonts \ -v \ $< -o $@ diff --git a/docs-resources/LICENSE b/docs-resources/LICENSE new file mode 100644 index 00000000..53883b1c --- /dev/null +++ b/docs-resources/LICENSE @@ -0,0 +1,396 @@ +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/docs-resources/README.md b/docs-resources/README.md new file mode 100644 index 00000000..4aa33006 --- /dev/null +++ b/docs-resources/README.md @@ -0,0 +1,195 @@ +# RISC-V Documentation Resources +This repository (repo) contains the resources needed to build docs with the RISC-V themes, fonts, and logos. + +Specification repos created after January 2022 are generally created from the +[docs-spec-template](https://github.com/riscv/docs-spec-template) repository and will +have all the requisites parts included in a basic document. + +Older repos can be updated with 3 basic steps: + +1. Update the directory structure to reference the docs-resources, (this) repository. +2. Update the main AsciiDoc source file to include new variables needed for build. +3. Update the `Makefile` to build using the new resources. + +## Updating the directory structure +The three main directories in this repo contain various components of the RISC-V documentation +template. The `docs-resources/images/` directory has artwork like the RISC-V logo. The `docs-resources/fonts/` +directory contains the necessary fonts. And, the `docs-resources/themes/` directory contains the YAML file +for configuring the document. + +In order to be able to link a repo with this project, you must use +[Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). While there are many ways to do this, +we will take the simplest approach and use the submodule defaults, +placing a `docs-resources/` directory in the repo head. This can be accomplished by executing +the following command in the top project directory (assuming http access): + +``` +git submodule add https://github.com/riscv/docs-resources.git +``` + +This command will create a `docs-resources/` directory when completed. Additionally, the `git status` +command should show new files of `docs-resources` and either a new or modified file of `.gitmodules` +depending upon whether Git Submodules are already in use in the project. + +**Note:** The use of Submodules creates a “link” in Git between projects that are tied to +specific commit id. This provides “safety” for the including projects by making sure that +they don’t inadvertently get broken. However, it creates an additional maintenance responsibility +to intermittently rebase the link and verify that nothing has been broken. Project maintainers need to +understand this and plan accordingly. + +## Updating the main AsciiDoc source file +From the `Makefile`, find the main AsciiDoc file that is used to build the project. +It usually has the same base name as the .pdf which is generated. + +Open this file and ensure that the following variables are added to top the document: + +``` +// These variables need customization for the specification +:description: Short, text description of spec… +:revdate: Month day, Year +:revnumber: X.Y.Z +:revremark: This document is in Development state. Change should be expected. + +// These variables should not require customization +:company: RISC-V +:url-riscv: http://riscv.org +:doctype: book +:preface-title: Preamble +:colophon: +:appendix-caption: Appendix +:title-logo-image: image:docs-resources/images/risc-v_logo.svg[pdfwidth=3.25in,align=center] +// Settings: +:experimental: +:reproducible: +:WaveDromEditorApp: wavedrom-cli +:icons: font +:lang: en +:listing-caption: Listing +:sectnums: +:sectnumlevels: 5 +:toclevels: 5 +:toc: left +:source-highlighter: pygments +ifdef::backend-pdf[] +:source-highlighter: coderay +endif::[] +:data-uri: +:hide-uri-scheme: +:stem: latexmath +:footnote: +:xrefstyle: short +``` + +The variables in the first section above should be visited and updated as appropriate. +Additionally, any variables which already exist in the document should be evaluated +for the better value, which most likely is the template value specified above for anything +in the document. + +## Updating the `Makefile` +Typical build invocations for basic AsciiDoc builds look like this: + +``` +%.pdf: %.adoc + asciidoctor-pdf $< +``` + +To build using the RISC-V template, this statement needs to look like this: +``` +%.pdf: %.adoc +asciidoctor-pdf \ + -a toc \ + -a compress \ + -a pdf-style=docs-resources/themes/riscv-pdf.yml \ + -a pdf-fontsdir=docs-resources/fonts \ + -o $@ $< +``` + +**Note:** if you want to include a bibliography, you can include a +“-r asciidoctor-bibtex” statement. Likewise, to use various diagramming +capabilities, you can include “-r asciidoctor-diagram”. + +## Additional items to consider for the document + +### License and copyright statements +While making updates to documents, ensure that a License statement is included near the front +of the document, preferably in the Preamble. The Asciidoc text for this should look something like this: + +``` +[NOTE] +.Copyright and licensure: +==== +This work is licensed under a +link:http://creativecommons.org/licenses/by/4.0/[Creative Commons Attribution 4.0 International License]. + +This work is Copyright 2022 by RISC-V International. +==== +``` + +### Document state markings +Document state should be reflected in the `:revmark:` variable and be contained in +an in-document admonition statement near the front of the document (Preface or Preamble). + +The recommended values for `:revmark:` and the front matter admonition based on the document +state are as follows: + +* For **Discussion Document** state, use: + * `:revmark: This document is in Discussion state. Change should be expected.` + * Formal admonition text: + ``` + [WARNING] + .This document is in the link:http://riscv.org/spec-state[Discussion state] + ==== + Assume everything can change. This document is not complete yet and was created only + for the purpose of conversation outside of the document. + ==== + ``` +* For **Development** state, use: + * `:revmark: This document is in Development state. Change should be expected.` + * Formal admonition text: + ``` + [WARNING] + .This document is in the link:http://riscv.org/spec-state[Development state] + ==== + Assume everything can change. This draft specification will change before being accepted + as standard, so implementations made to this draft specification will likely not conform + to the future standard. + ==== + ``` +* For **Stable** state, use: + * `:revmark: This document is in Stable state. Assume it may change.` + * Formal admonition text: + ``` + [WARNING] + .This document is in the link:http://riscv.org/spec-state[Stable state] + ==== + Assume anything could still change, but limited change should be expected. + ==== + ``` +* For **Frozen** state, use: + * `:revmark: This document is in Frozen state. Change is extremely unlikely.` + * Formal admonition text: + ``` + [WARNING] + .This document is in the link:http://riscv.org/spec-state[Frozen state] + ==== + Change is extremely unlikely. A high threshold will be used, and a change + will only occur because of some truly critical issue being identified during + the public review cycle. Any other desired or needed changes can be the subject + of a follow-on new extension. + ==== + ``` +* For **Ratified** state, use: + * `:revmark: This document is in Ratified state. No changes are allowed.` + * Formal admonition text: + ``` + [WARNING] + .This document is in the link:http://riscv.org/spec-state[Ratified state] + ==== + No changes are allowed. Any desired or needed changes can be the subject + of a follow-on new extension. Ratified extensions are never revised. + ==== + ``` + + # Additional information + For additional information, see the [docs-dev-guide/example.pdf](https://github.com/riscv/docs-dev-guide/blob/main/example.pdf) or reach out to + help@riscv.org. diff --git a/docs-resources/fonts/Montserrat-ExtraLight.ttf b/docs-resources/fonts/Montserrat-ExtraLight.ttf new file mode 100755 index 00000000..ca0bbb65 Binary files /dev/null and b/docs-resources/fonts/Montserrat-ExtraLight.ttf differ diff --git a/docs-resources/fonts/Montserrat-ExtraLightItalic.ttf b/docs-resources/fonts/Montserrat-ExtraLightItalic.ttf new file mode 100755 index 00000000..f3c1559e Binary files /dev/null and b/docs-resources/fonts/Montserrat-ExtraLightItalic.ttf differ diff --git a/docs-resources/fonts/Montserrat-Italic.ttf b/docs-resources/fonts/Montserrat-Italic.ttf new file mode 100755 index 00000000..eb4232a0 Binary files /dev/null and b/docs-resources/fonts/Montserrat-Italic.ttf differ diff --git a/docs-resources/fonts/Montserrat-Light.ttf b/docs-resources/fonts/Montserrat-Light.ttf new file mode 100755 index 00000000..990857de Binary files /dev/null and b/docs-resources/fonts/Montserrat-Light.ttf differ diff --git a/docs-resources/fonts/Montserrat-Medium.ttf b/docs-resources/fonts/Montserrat-Medium.ttf new file mode 100755 index 00000000..6e079f69 Binary files /dev/null and b/docs-resources/fonts/Montserrat-Medium.ttf differ diff --git a/docs-resources/fonts/Montserrat-MediumItalic.ttf b/docs-resources/fonts/Montserrat-MediumItalic.ttf new file mode 100755 index 00000000..0dc3ac9c Binary files /dev/null and b/docs-resources/fonts/Montserrat-MediumItalic.ttf differ diff --git a/docs-resources/fonts/Montserrat-Regular.ttf b/docs-resources/fonts/Montserrat-Regular.ttf new file mode 100755 index 00000000..8d443d5d Binary files /dev/null and b/docs-resources/fonts/Montserrat-Regular.ttf differ diff --git a/docs-resources/fonts/OFL-M.txt b/docs-resources/fonts/OFL-M.txt new file mode 100755 index 00000000..7881887b --- /dev/null +++ b/docs-resources/fonts/OFL-M.txt @@ -0,0 +1,93 @@ +Copyright 2011 The Montserrat Project Authors (https://github.com/JulietaUla/Montserrat) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/docs-resources/fonts/OFL-P.txt b/docs-resources/fonts/OFL-P.txt new file mode 100755 index 00000000..79320bd8 --- /dev/null +++ b/docs-resources/fonts/OFL-P.txt @@ -0,0 +1,93 @@ +Copyright 2019 The Petrona Project Authors (https://github.com/RingoSeeber/Petrona) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/docs-resources/fonts/OFL1.txt b/docs-resources/fonts/OFL1.txt new file mode 100644 index 00000000..06c608dc --- /dev/null +++ b/docs-resources/fonts/OFL1.txt @@ -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/docs-resources/fonts/Petrona-Light.ttf b/docs-resources/fonts/Petrona-Light.ttf new file mode 100755 index 00000000..687a25fa Binary files /dev/null and b/docs-resources/fonts/Petrona-Light.ttf differ diff --git a/docs-resources/fonts/Petrona-LightItalic.ttf b/docs-resources/fonts/Petrona-LightItalic.ttf new file mode 100755 index 00000000..0fd2e159 Binary files /dev/null and b/docs-resources/fonts/Petrona-LightItalic.ttf differ diff --git a/docs-resources/fonts/Petrona-Medium.ttf b/docs-resources/fonts/Petrona-Medium.ttf new file mode 100755 index 00000000..eecc1b63 Binary files /dev/null and b/docs-resources/fonts/Petrona-Medium.ttf differ diff --git a/docs-resources/fonts/Petrona-MediumItalic.ttf b/docs-resources/fonts/Petrona-MediumItalic.ttf new file mode 100755 index 00000000..d316f854 Binary files /dev/null and b/docs-resources/fonts/Petrona-MediumItalic.ttf differ diff --git a/docs-resources/fonts/Petrona-Thin.ttf b/docs-resources/fonts/Petrona-Thin.ttf new file mode 100755 index 00000000..6c61a3c0 Binary files /dev/null and b/docs-resources/fonts/Petrona-Thin.ttf differ diff --git a/docs-resources/fonts/Petrona-ThinItalic.ttf b/docs-resources/fonts/Petrona-ThinItalic.ttf new file mode 100755 index 00000000..85a0624a Binary files /dev/null and b/docs-resources/fonts/Petrona-ThinItalic.ttf differ diff --git a/resources/fonts/cmunbmr.ttf b/docs-resources/fonts/cmunbmr.ttf similarity index 100% rename from resources/fonts/cmunbmr.ttf rename to docs-resources/fonts/cmunbmr.ttf diff --git a/resources/fonts/cmunbtl.ttf b/docs-resources/fonts/cmunbtl.ttf similarity index 100% rename from resources/fonts/cmunbtl.ttf rename to docs-resources/fonts/cmunbtl.ttf diff --git a/resources/fonts/cmunbto.ttf b/docs-resources/fonts/cmunbto.ttf similarity index 100% rename from resources/fonts/cmunbto.ttf rename to docs-resources/fonts/cmunbto.ttf diff --git a/resources/fonts/droid-sans-fallback.ttf b/docs-resources/fonts/droid-sans-fallback.ttf similarity index 100% rename from resources/fonts/droid-sans-fallback.ttf rename to docs-resources/fonts/droid-sans-fallback.ttf diff --git a/resources/fonts/mplus-1mn-bold.ttf b/docs-resources/fonts/mplus-1mn-bold.ttf similarity index 100% rename from resources/fonts/mplus-1mn-bold.ttf rename to docs-resources/fonts/mplus-1mn-bold.ttf diff --git a/resources/fonts/mplus-1mn-light.ttf b/docs-resources/fonts/mplus-1mn-light.ttf similarity index 100% rename from resources/fonts/mplus-1mn-light.ttf rename to docs-resources/fonts/mplus-1mn-light.ttf diff --git a/resources/fonts/mplus-1mn-medium.ttf b/docs-resources/fonts/mplus-1mn-medium.ttf similarity index 100% rename from resources/fonts/mplus-1mn-medium.ttf rename to docs-resources/fonts/mplus-1mn-medium.ttf diff --git a/resources/fonts/mplus-1mn-regular.ttf b/docs-resources/fonts/mplus-1mn-regular.ttf similarity index 100% rename from resources/fonts/mplus-1mn-regular.ttf rename to docs-resources/fonts/mplus-1mn-regular.ttf diff --git a/resources/fonts/mplus-1mn-thin.ttf b/docs-resources/fonts/mplus-1mn-thin.ttf similarity index 100% rename from resources/fonts/mplus-1mn-thin.ttf rename to docs-resources/fonts/mplus-1mn-thin.ttf diff --git a/resources/fonts/mplus-1p-regular-fallback.ttf b/docs-resources/fonts/mplus-1p-regular-fallback.ttf similarity index 100% rename from resources/fonts/mplus-1p-regular-fallback.ttf rename to docs-resources/fonts/mplus-1p-regular-fallback.ttf diff --git a/docs-resources/images/risc-v_logo.png b/docs-resources/images/risc-v_logo.png new file mode 100644 index 00000000..19c41209 Binary files /dev/null and b/docs-resources/images/risc-v_logo.png differ diff --git a/docs-resources/images/risc-v_logo.svg b/docs-resources/images/risc-v_logo.svg new file mode 100755 index 00000000..75cb2320 --- /dev/null +++ b/docs-resources/images/risc-v_logo.svg @@ -0,0 +1,82 @@ + +image/svg+xml diff --git a/resources/themes/risc-v_spec-pdf.yml b/docs-resources/themes/riscv-pdf.yml similarity index 70% rename from resources/themes/risc-v_spec-pdf.yml rename to docs-resources/themes/riscv-pdf.yml index c296b754..26764722 100644 --- a/resources/themes/risc-v_spec-pdf.yml +++ b/docs-resources/themes/riscv-pdf.yml @@ -1,13 +1,20 @@ font: catalog: - # Computer Modern - Computer Modern: - normal: cmunss.ttf - bold: cmunsx.ttf - italic: cmunsi.ttf - bold_italic: cmunso.ttf - header_thin: cmunbmr.ttf - Code: + merge: false + #Petrona + body: + normal: Petrona-Light.ttf + bold: Petrona-Medium.ttf + italic: Petrona-LightItalic.ttf + bold_italic: Petrona-MediumItalic.ttf + header_thin: Petrona-Thin.ttf + #Montserrat + headings: + normal: Montserrat-Regular.ttf + italic: Montserrat-Italic.ttf + bold: Montserrat-Medium.ttf + light: Montserrat-Light.ttf + code: normal: cmunbtl.ttf bold: cmunbtl.ttf italic: cmunbto.ttf @@ -16,23 +23,20 @@ font: M+ 1mn: normal: mplus-1mn-regular.ttf bold: mplus-1mn-bold.ttf - italic: mplus-1mn-regular.ttf - bold_italic: mplus-1mn-bold.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 + italic: mplus-1mn-light.ttf + bold_italic: mplus-1mn-medium.ttf M+ 1p Fallback: normal: mplus-1p-regular-fallback.ttf bold: mplus-1p-regular-fallback.ttf italic: mplus-1p-regular-fallback.ttf bold_italic: mplus-1p-regular-fallback.ttf -# Droid Fallback: -# normal: droid-regular-fallback.ttf -# bold: droid-regular-fallback.ttf -# italic: droid-regular-fallback.ttf -# bold_italic: droid-regular-fallback.ttf + Droid Fallback: + normal: droid-sans-fallback.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 fallbacks: - M+ 1p Fallback -# - Droid Fallback + - Droid Fallback page: background_color: ffffff layout: portrait @@ -42,88 +46,59 @@ page: margin_outer: 0.59in size: A4 base: - align: justify - # color as hex string (leading # is optional) - font_color: 383838 - # 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: Computer Modern - # 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 Computer Modern metrics + font-family: body + font_size: 11.5 line_height_length: 12 - #font_size: 11.25 - #line_height_length: 18 - line_height: $base_line_height_length / $base_font_size + font_style: normal 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: 3 - border_width: 0.2 -# FIXME vertical_rhythm is weird; we should think in terms of ems -#vertical_rhythm: $base_line_height_length * 2 / 3 -# correct line height for Computer Modern metrics (comes with built-in line height) + border_width: 0.25 vertical_rhythm: $base_line_height_length horizontal_rhythm: $base_line_height_length -# QUESTION should vertical_spacing be block_spacing instead? -vertical_spacing: $vertical_rhythm + # 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 + font_color: 428bca + # literal is currently used for inline monospaced in prose and table cells literal: - font_color: b12146 - font_family: Code + font_color: b12146 + font_family: code menu_caret_content: " \u203a " heading: - align: left - font_color: 3e058e - #font_color: $base_font_color - font_family: $base_font_family - font_style: normal - # h1 is used for part titles (book doctype only) - h1_font_size: floor($base_font_size * 2.6) - # h2 is used for chapter titles (book doctype only) - 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 Computer Modern metrics (comes with built-in line height) - line_height: 1 - margin_top: $vertical_rhythm * 0.4 - margin_bottom: $vertical_rhythm * 0.9 -title_page: - align: right - logo: - top: 10% - title: - top: 55% - font_size: $heading_h1_font_size + align: left font_color: 3e058e - 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: 3e058e - revision: - margin_top: $base_font_size * 1.25 + font_family: headings + font_style: light + h1_font_size: floor($base_font_size * 2.8) + # h2 is used for chapter titles (book doctype only) + 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 +title_page: + align: right + logo: + top: 10% + title: + font_family: headings + font_style: light + font_size: floor($base_font_size * 2.8) + top: 55% + font_color: 3e058e + subtitle: + font_family: headings + font_style: light + font_size: floor($base_font_size * 1.2) + authors: + font_family: headings + font_color: 3e058e + font_style: light + font_size: floor($base_font_size * .8) + revision: + margin_top: $base_font_size * 1.25 block: margin_top: 0 margin_bottom: $vertical_rhythm @@ -145,7 +120,7 @@ abstract: font_style: italic first_line_font_style: bold title: - align: center + align: left font_color: $heading_font_color font_family: $heading_font_family font_size: $heading_h4_font_size @@ -157,11 +132,13 @@ sidebar: border-radius: 3 border-width: 0.2 sidebar-title: - font-style: italic + font_family: $heading_font_family + font-style: light font-color: $heading-font-color font-size: 11 align: left admonition: + font-style: italic column_rule_color: $base_border_color column_rule_width: $base_border_width padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm] @@ -174,8 +151,8 @@ admonition: stroke_color: 646b74 size: 24 important: - name: hand-pointer-o - stroke_color: b58f5b + name: info + stroke_color: 5f8c8b warning: stroke_color: 9c4d4b caution: @@ -196,9 +173,10 @@ admonition: code: font_color: $base_font_color font_family: $literal_font_family - font_size: ceil($base_font_size) + #font_size: ceil($base_font_size) + font-size: 11 padding: $code_font_size - line_height: 1.25 + line_height: 1.15 # line_gap is an experimental property to control how a background color is applied to an inline block element line_gap: 3.8 background_color: f4f4fb @@ -248,7 +226,6 @@ table: border_color: dddddd border_width: $base_border_width cell_padding: 3 - caption_side: bottom toc: indent: $horizontal_rhythm line_height: 1.4 @@ -316,12 +293,4 @@ footer: content: $footer_recto_right_content #center: '{page-number}' #content: '{page-number}' -role: - Changed: - border: - width: .25 - changebar: 1 - color: $base_font_color - offset: 2 - diff --git a/images/draft.png b/images/draft.png deleted file mode 100644 index d8569231..00000000 Binary files a/images/draft.png and /dev/null differ diff --git a/images/risc-v_logo.png b/images/risc-v_logo.png deleted file mode 100644 index d754746e..00000000 Binary files a/images/risc-v_logo.png and /dev/null differ diff --git a/preamble.adoc b/preamble.adoc index d8eb995a..9710cc94 100644 --- a/preamble.adoc +++ b/preamble.adoc @@ -25,13 +25,18 @@ Hsiangkai Wang, Andrew Waterman, Jim Wilson -It is licensed under the Creative Commons Attribution 4.0 International -License (CC-BY 4.0). The full license text is available at -https://creativecommons.org/licenses/by/4.0/. - Please cite as: `RISC-V ABIs Specification, Document Version {refrev}', Editors Kito Cheng and Jessica Clarke, RISC-V International, {monthyear}. The latest version of this document can be found here: https://github.com/riscv-non-isa/riscv-elf-psabi-doc. + +[NOTE] +.Copyright and licensure: +==== +This work is licensed under a +link:http://creativecommons.org/licenses/by/4.0/[Creative Commons Attribution 4.0 International License]. + +This work is Copyright 2022 by RISC-V International. +==== diff --git a/prelude.adoc b/prelude.adoc index 467e3271..d1c23432 100644 --- a/prelude.adoc +++ b/prelude.adoc @@ -1,4 +1,32 @@ -:company: RISC-V.org +// These variables should not require customization +:company: RISC-V +:url-riscv: http://riscv.org +:doctype: book +:preface-title: Preamble +:colophon: +:appendix-caption: Appendix +:title-logo-image: image:docs-resources/images/risc-v_logo.svg[pdfwidth=3.25in,align=center] +// Settings: +:experimental: +:reproducible: +:WaveDromEditorApp: wavedrom-cli +:icons: font +:lang: en +:listing-caption: Listing +:sectnums: +:sectnumlevels: 5 +:toclevels: 5 +:toc: left +:source-highlighter: pygments +ifdef::backend-pdf[] +:source-highlighter: coderay +endif::[] +:data-uri: +:hide-uri-scheme: +:stem: latexmath +:footnote: +:xrefstyle: short + // These are the definitions from docs-template: // // development: Assume everything can change @@ -16,6 +44,7 @@ // as frozen can still change in incompatible ways) as we cannot break ABI once // features are implemented in toolchains. Similarly stable is still frozen // just by another name for policy reasons. +:description: Processor-specific application binary interface document for RISC-V. :revlifecycle: frozen :revnumber: 1.0-rc2-draft ifeval::["{revlifecycle}" == "dev"] @@ -35,30 +64,6 @@ ifeval::["{revlifecycle}" == "ratified"] :revremark: Ratified :refrev: {revnumber} endif::[] -:url-riscv: http://riscv.org -:doctype: book -:preface-title: Preamble -:colophon: -:appendix-caption: Appendix -:imagesdir: images -:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center] -//:back-cover-image: image:backpage.png[opacity=25%] -:experimental: -:reproducible: -:icons: font -:lang: en -:listing-caption: Listing -:sectnums: -:toc: left -:toclevels: 3 -:source-highlighter: pygments -ifdef::backend-pdf[] -:source-highlighter: coderay -endif::[] -:data-uri: -:hide-uri-scheme: -:stem: latexmath -:footnote: -:xrefstyle: short + include::preamble.adoc[] diff --git a/resources/fonts/DroidSans-Bold.ttf b/resources/fonts/DroidSans-Bold.ttf deleted file mode 100755 index d065b64e..00000000 Binary files a/resources/fonts/DroidSans-Bold.ttf and /dev/null differ diff --git a/resources/fonts/DroidSans.ttf b/resources/fonts/DroidSans.ttf deleted file mode 100755 index ad1efca8..00000000 Binary files a/resources/fonts/DroidSans.ttf and /dev/null differ diff --git a/resources/fonts/cmunbbx.ttf b/resources/fonts/cmunbbx.ttf deleted file mode 100755 index 7622f4c9..00000000 Binary files a/resources/fonts/cmunbbx.ttf and /dev/null differ diff --git a/resources/fonts/cmunbmo.ttf b/resources/fonts/cmunbmo.ttf deleted file mode 100755 index a7fbdcf0..00000000 Binary files a/resources/fonts/cmunbmo.ttf and /dev/null differ diff --git a/resources/fonts/cmunbso.ttf b/resources/fonts/cmunbso.ttf deleted file mode 100755 index f6ac3448..00000000 Binary files a/resources/fonts/cmunbso.ttf and /dev/null differ diff --git a/resources/fonts/cmunbxo.ttf b/resources/fonts/cmunbxo.ttf deleted file mode 100755 index eac47a7a..00000000 Binary files a/resources/fonts/cmunbxo.ttf and /dev/null differ diff --git a/resources/fonts/cmunsi.ttf b/resources/fonts/cmunsi.ttf deleted file mode 100755 index bd30a3f9..00000000 Binary files a/resources/fonts/cmunsi.ttf and /dev/null differ diff --git a/resources/fonts/cmunso.ttf b/resources/fonts/cmunso.ttf deleted file mode 100755 index 529277b5..00000000 Binary files a/resources/fonts/cmunso.ttf and /dev/null differ diff --git a/resources/fonts/cmunss.ttf b/resources/fonts/cmunss.ttf deleted file mode 100755 index d7513c86..00000000 Binary files a/resources/fonts/cmunss.ttf and /dev/null differ diff --git a/resources/fonts/cmunsx.ttf b/resources/fonts/cmunsx.ttf deleted file mode 100755 index d13901be..00000000 Binary files a/resources/fonts/cmunsx.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-black.ttf b/resources/fonts/mplus-1p-black.ttf deleted file mode 100755 index fb77753b..00000000 Binary files a/resources/fonts/mplus-1p-black.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-bold.ttf b/resources/fonts/mplus-1p-bold.ttf deleted file mode 100755 index ff80c7b9..00000000 Binary files a/resources/fonts/mplus-1p-bold.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-heavy.ttf b/resources/fonts/mplus-1p-heavy.ttf deleted file mode 100755 index 0e3a0453..00000000 Binary files a/resources/fonts/mplus-1p-heavy.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-light.ttf b/resources/fonts/mplus-1p-light.ttf deleted file mode 100755 index 71df0421..00000000 Binary files a/resources/fonts/mplus-1p-light.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-medium.ttf b/resources/fonts/mplus-1p-medium.ttf deleted file mode 100755 index bfd2b5e3..00000000 Binary files a/resources/fonts/mplus-1p-medium.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-regular.ttf b/resources/fonts/mplus-1p-regular.ttf deleted file mode 100755 index cccc4050..00000000 Binary files a/resources/fonts/mplus-1p-regular.ttf and /dev/null differ diff --git a/resources/fonts/mplus-1p-thin.ttf b/resources/fonts/mplus-1p-thin.ttf deleted file mode 100755 index b660ed0d..00000000 Binary files a/resources/fonts/mplus-1p-thin.ttf and /dev/null differ