diff --git a/.github/workflows/build-pdf.yml b/.github/workflows/build-pdf.yml
index 591438d..a5581a7 100644
--- a/.github/workflows/build-pdf.yml
+++ b/.github/workflows/build-pdf.yml
@@ -1,82 +1,74 @@
---
-# This workflow installs dependencies for PDF generation, generates the PDF,
-# and uploads the PDF as an artifact.
-
-name: Build Document PDF
+name: Create Specification Document
+# The workflow is triggered by pull request, push to main, and manual dispatch.
on:
- push:
- branches:
- - main
- pull_request:
- branches:
- - main
workflow_dispatch:
inputs:
- create_release:
- description: Create a new Docs Dev Guide release if set to true
- required: false
- default: 'false'
- target_branch:
- description: Target Branch
+ version:
+ description: 'Release version, e.g. X.Y.Z:'
+ required: true
+ type: string
+ revision_mark:
+ description: 'Set revision mark as Draft, Release or Stable:'
required: true
- default: main
- release_notes:
- description: Release Notes
+ type: string
+ default: Draft
+ prerelease:
+ description: Tag as a pre-release?
required: false
+ type: boolean
+ default: true
+ draft:
+ description: Create release as a draft?
+ required: false
+ type: boolean
+ default: false
+ pull_request:
+ push:
+ branches:
+ - main
jobs:
build:
runs-on: ubuntu-latest
steps:
+ # Step 1: Checkout the repository
- name: Checkout repository
uses: actions/checkout@v3
+ with:
+ submodules: recursive
- # Set the short SHA for use in artifact names
- - name: Set short SHA
- run: echo "SHORT_SHA=$(echo ${GITHUB_SHA::7})" >> $GITHUB_ENV
-
- # Get the current date
- - name: Get current date
- run: echo "CURRENT_DATE=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
-
- # Pull the latest RISC-V Docs container image
- # https://github.com/riscv/riscv-docs-base-container-image
- # https://hub.docker.com/r/riscvintl/riscv-docs-base-container-image
+ # Step 2: Pull the latest RISC-V Docs container image
- name: Pull Container
- id: pull_container_image
- run: |
- docker pull riscvintl/riscv-docs-base-container-image:latest
+ run: docker pull riscvintl/riscv-docs-base-container-image:latest
- # Build PDF files using the container
+ # Step 3: Build Files
- name: Build Files
- id: build_files
- if: steps.pull_container_image.outcome == 'success'
- run: |
- docker run --rm -v ${{ github.workspace }}:/build riscvintl/riscv-docs-base-container-image:latest \
- /bin/sh -c make
+ run: make
+ env:
+ VERSION: v${{ github.event.inputs.version }}
+ REVMARK: ${{ github.event.inputs.revision_mark }}
- # Upload the priv-isa-asciidoc PDF file
- - name: Upload docs-dev-guide.pdf
- if: steps.build_files.outcome == 'success'
+ # Step 4: Upload the built PDF files as a single artifact
+ - name: Upload Build Artifacts
uses: actions/upload-artifact@v3
with:
- name: docs-dev-guide-${{ env.SHORT_SHA }}.pdf
- path: ${{ github.workspace }}/docs-dev-guide.pdf
- retention-days: 7
+ name: Build Artifacts
+ path: ${{ github.workspace }}/build/*.pdf
+ retention-days: 30
+ # Create Release
- name: Create Release
- if: steps.build_files.outcome == 'success' && github.event_name == 'workflow_dispatch' && github.event.inputs.create_release == 'true'
uses: softprops/action-gh-release@v1
with:
- draft: false
- tag_name: docs-dev-guide-${{ env.SHORT_SHA }}-${{ env.CURRENT_DATE }}
- name: ${{ env.CURRENT_DATE }}
- body: |
- This release was created by: ${{ github.event.sender.login }}
- Release Notes: ${{ github.event.inputs.release_notes }}
- files: |
- ${{ github.workspace }}/docs-dev-guide.pdf
+ files: ${{ github.workspace }}/build/*.pdf
+ tag_name: v${{ github.event.inputs.version }}
+ name: Release ${{ github.event.inputs.version }}
+ draft: ${{ github.event.inputs.draft }}
+ prerelease: ${{ github.event.inputs.prerelease }}
env:
GITHUB_TOKEN: ${{ secrets.GHTOKEN }}
+ if: github.event_name == 'workflow_dispatch'
+ # This condition ensures this step only runs for workflow_dispatch events.
diff --git a/.gitignore b/.gitignore
index a136337..d9b4f01 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1 @@
-*.pdf
+/build/*
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..78a8f9c
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs-resources"]
+ path = docs-resources
+ url = https://github.com/riscv/docs-resources
diff --git a/Makefile b/Makefile
index 61e0c70..810eb4d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,21 +1,70 @@
-HEADER_SOURCE := book_header.adoc
-PDF_RESULT := docs-dev-guide.pdf
-# Not all document sources are yet listed here. Not just adoc files but
-# images/ and resources/ content. Once they are the target can remove the
-# phony use.
-SOURCES := $(HEADER_SOURCE)
-
-all: $(PDF_RESULT)
-
-.PHONY: $(PDF_RESULT)
-$(PDF_RESULT): $(SOURCES)
- asciidoctor-pdf \
- --attribute=mathematical-format=svg \
- --attribute=pdf-fontsdir=resources/fonts \
- --attribute=pdf-theme=resources/themes/riscv-pdf.yml \
- --failure-level=ERROR \
- --require=asciidoctor-bibtex \
- --require=asciidoctor-diagram \
- --require=asciidoctor-mathematical \
- --out-file=$@ \
- $(HEADER_SOURCE)
+# Makefile for RISC-V Doc Template
+#
+# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+# International License. To view a copy of this license, visit
+# http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
+# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+#
+# Description:
+#
+# This Makefile is designed to automate the process of building and packaging
+# the Doc Template for RISC-V Extensions.
+
+DATE ?= $(shell date +%Y-%m-%d)
+VERSION ?= v0.0.0
+REVMARK ?= Draft
+DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \
+riscvintl/riscv-docs-base-container-image:latest
+
+SRC_DIR := src
+BUILD_DIR := build
+HEADER_SOURCE := $(SRC_DIR)/docs-dev-guide.adoc
+
+ASCIIDOCTOR_PDF := asciidoctor-pdf
+ASCIIDOCTOR_HTML := asciidoctor
+OPTIONS := --trace \
+ -a compress \
+ -a mathematical-format=svg \
+ -a revnumber=${VERSION} \
+ -a revremark=${REVMARK} \
+ -a revdate=${DATE} \
+ -a pdf-fontsdir=docs-resources/fonts \
+ -a pdf-theme=docs-resources/themes/riscv-pdf.yml \
+ -D $(BUILD_DIR) \
+ --failure-level=ERROR
+REQUIRES := --require=asciidoctor-bibtex \
+ --require=asciidoctor-diagram \
+ --require=asciidoctor-mathematical
+
+.PHONY: all build clean build-container build-no-container
+
+all: build
+
+build:
+ @echo "Checking if Docker is available..."
+ @if command -v docker >/dev/null 2>&1 ; then \
+ echo "Docker is available, building inside Docker container..."; \
+ $(MAKE) build-container; \
+ else \
+ echo "Docker is not available, building without Docker..."; \
+ $(MAKE) build-no-container; \
+ fi
+
+build-container:
+ @echo "Starting build inside Docker container..."
+ $(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $(HEADER_SOURCE)"
+ $(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $(HEADER_SOURCE)"
+ @echo "Build completed successfully inside Docker container."
+
+build-no-container:
+ @echo "Starting build..."
+ $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $(HEADER_SOURCE)
+ $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $(HEADER_SOURCE)
+ @echo "Build completed successfully."
+
+clean:
+ @echo "Cleaning up generated files..."
+ rm -rf $(BUILD_DIR)
+ @echo "Cleanup completed."
diff --git a/docs-resources b/docs-resources
new file mode 160000
index 0000000..66f972d
--- /dev/null
+++ b/docs-resources
@@ -0,0 +1 @@
+Subproject commit 66f972d7dc961551a7815d2fceb82fbea7ce2c44
diff --git a/resources/fonts/Montserrat-ExtraLight.ttf b/resources/fonts/Montserrat-ExtraLight.ttf
deleted file mode 100755
index ca0bbb6..0000000
Binary files a/resources/fonts/Montserrat-ExtraLight.ttf and /dev/null differ
diff --git a/resources/fonts/Montserrat-ExtraLightItalic.ttf b/resources/fonts/Montserrat-ExtraLightItalic.ttf
deleted file mode 100755
index f3c1559..0000000
Binary files a/resources/fonts/Montserrat-ExtraLightItalic.ttf and /dev/null differ
diff --git a/resources/fonts/Montserrat-Italic.ttf b/resources/fonts/Montserrat-Italic.ttf
deleted file mode 100755
index eb4232a..0000000
Binary files a/resources/fonts/Montserrat-Italic.ttf and /dev/null differ
diff --git a/resources/fonts/Montserrat-Light.ttf b/resources/fonts/Montserrat-Light.ttf
deleted file mode 100755
index 990857d..0000000
Binary files a/resources/fonts/Montserrat-Light.ttf and /dev/null differ
diff --git a/resources/fonts/Montserrat-Medium.ttf b/resources/fonts/Montserrat-Medium.ttf
deleted file mode 100755
index 6e079f6..0000000
Binary files a/resources/fonts/Montserrat-Medium.ttf and /dev/null differ
diff --git a/resources/fonts/Montserrat-MediumItalic.ttf b/resources/fonts/Montserrat-MediumItalic.ttf
deleted file mode 100755
index 0dc3ac9..0000000
Binary files a/resources/fonts/Montserrat-MediumItalic.ttf and /dev/null differ
diff --git a/resources/fonts/Montserrat-Regular.ttf b/resources/fonts/Montserrat-Regular.ttf
deleted file mode 100755
index 8d443d5..0000000
Binary files a/resources/fonts/Montserrat-Regular.ttf and /dev/null differ
diff --git a/resources/fonts/OFL-M.txt b/resources/fonts/OFL-M.txt
deleted file mode 100755
index 11146a2..0000000
--- a/resources/fonts/OFL-M.txt
+++ /dev/null
@@ -1,93 +0,0 @@
-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/resources/fonts/OFL-P.txt b/resources/fonts/OFL-P.txt
deleted file mode 100755
index 22dcd1c..0000000
--- a/resources/fonts/OFL-P.txt
+++ /dev/null
@@ -1,93 +0,0 @@
-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/resources/fonts/OFL1.txt b/resources/fonts/OFL1.txt
deleted file mode 100644
index 2f244ac..0000000
--- a/resources/fonts/OFL1.txt
+++ /dev/null
@@ -1,395 +0,0 @@
-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/resources/fonts/Petrona-Light.ttf b/resources/fonts/Petrona-Light.ttf
deleted file mode 100755
index 687a25f..0000000
Binary files a/resources/fonts/Petrona-Light.ttf and /dev/null differ
diff --git a/resources/fonts/Petrona-LightItalic.ttf b/resources/fonts/Petrona-LightItalic.ttf
deleted file mode 100755
index 0fd2e15..0000000
Binary files a/resources/fonts/Petrona-LightItalic.ttf and /dev/null differ
diff --git a/resources/fonts/Petrona-Medium.ttf b/resources/fonts/Petrona-Medium.ttf
deleted file mode 100755
index eecc1b6..0000000
Binary files a/resources/fonts/Petrona-Medium.ttf and /dev/null differ
diff --git a/resources/fonts/Petrona-MediumItalic.ttf b/resources/fonts/Petrona-MediumItalic.ttf
deleted file mode 100755
index d316f85..0000000
Binary files a/resources/fonts/Petrona-MediumItalic.ttf and /dev/null differ
diff --git a/resources/fonts/Petrona-Thin.ttf b/resources/fonts/Petrona-Thin.ttf
deleted file mode 100755
index 6c61a3c..0000000
Binary files a/resources/fonts/Petrona-Thin.ttf and /dev/null differ
diff --git a/resources/fonts/Petrona-ThinItalic.ttf b/resources/fonts/Petrona-ThinItalic.ttf
deleted file mode 100755
index 85a0624..0000000
Binary files a/resources/fonts/Petrona-ThinItalic.ttf and /dev/null differ
diff --git a/resources/fonts/cmunbmr.ttf b/resources/fonts/cmunbmr.ttf
deleted file mode 100755
index a9eb24f..0000000
Binary files a/resources/fonts/cmunbmr.ttf and /dev/null differ
diff --git a/resources/fonts/cmunbtl.ttf b/resources/fonts/cmunbtl.ttf
deleted file mode 100755
index b0f26fa..0000000
Binary files a/resources/fonts/cmunbtl.ttf and /dev/null differ
diff --git a/resources/fonts/cmunbto.ttf b/resources/fonts/cmunbto.ttf
deleted file mode 100755
index 10fcbbc..0000000
Binary files a/resources/fonts/cmunbto.ttf and /dev/null differ
diff --git a/resources/fonts/droid-sans-fallback.ttf b/resources/fonts/droid-sans-fallback.ttf
deleted file mode 100755
index ad1efca..0000000
Binary files a/resources/fonts/droid-sans-fallback.ttf and /dev/null differ
diff --git a/resources/fonts/mplus-1mn-bold.ttf b/resources/fonts/mplus-1mn-bold.ttf
deleted file mode 100755
index b631cf9..0000000
Binary files a/resources/fonts/mplus-1mn-bold.ttf and /dev/null differ
diff --git a/resources/fonts/mplus-1mn-light.ttf b/resources/fonts/mplus-1mn-light.ttf
deleted file mode 100755
index 2abb31f..0000000
Binary files a/resources/fonts/mplus-1mn-light.ttf and /dev/null differ
diff --git a/resources/fonts/mplus-1mn-medium.ttf b/resources/fonts/mplus-1mn-medium.ttf
deleted file mode 100755
index 2ccef34..0000000
Binary files a/resources/fonts/mplus-1mn-medium.ttf and /dev/null differ
diff --git a/resources/fonts/mplus-1mn-regular.ttf b/resources/fonts/mplus-1mn-regular.ttf
deleted file mode 100755
index 9442e59..0000000
Binary files a/resources/fonts/mplus-1mn-regular.ttf and /dev/null differ
diff --git a/resources/fonts/mplus-1mn-thin.ttf b/resources/fonts/mplus-1mn-thin.ttf
deleted file mode 100755
index 2af69a6..0000000
Binary files a/resources/fonts/mplus-1mn-thin.ttf and /dev/null differ
diff --git a/resources/fonts/mplus-1p-regular-fallback.ttf b/resources/fonts/mplus-1p-regular-fallback.ttf
deleted file mode 100755
index cccc405..0000000
Binary files a/resources/fonts/mplus-1p-regular-fallback.ttf and /dev/null differ
diff --git a/resources/themes/riscv-pdf.yml b/resources/themes/riscv-pdf.yml
deleted file mode 100644
index bc6a0f3..0000000
--- a/resources/themes/riscv-pdf.yml
+++ /dev/null
@@ -1,299 +0,0 @@
----
-font:
- catalog:
- 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
- bold_italic: cmunbto.ttf
- # M+ 1mn supports ASCII and the circled numbers used for conums
- M+ 1mn:
- normal: mplus-1mn-regular.ttf
- bold: mplus-1mn-bold.ttf
- 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-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
-page:
- background_color: ffffff
- layout: portrait
- margin: [0.5in, 0.67in, 0.67in, 0.67in]
- # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress
- margin_inner: 0.75in
- margin_outer: 0.59in
- size: A4
-base:
- font-family: body
- font_size: 11.5
- line_height_length: 12
- 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_color:
- border_radius: 3
- border_width: 0.25
- border_color:
-
-vertical_rhythm: $base_line_height_length
-horizontal_rhythm: $base_line_height_length
- # QUESTION should vertical_spacing be block_spacing instead?
-vertical_spacing: $vertical_rhythm
-link:
- font_color: 428bca
- # literal is currently used for inline monospaced in prose and table cells
-codespan:
- font_color: b12146
- font_family: code
-menu_caret_content: ' › '
-heading:
- align: left
- font_color: 3e058e
- 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
-caption:
- align: left
- font_size: $base_font_size * 0.95
- font_style: italic
- # FIXME perhaps set line_height instead of / in addition to margins?
- margin_inside: $vertical_rhythm / 3
- #margin_inside: $vertical_rhythm / 4
- margin_outside: 0
-lead:
- font_size: $base_font_size_large
- line_height: 1.4
-abstract:
- font_color: 5c6266
- font_size: $lead_font_size
- line_height: $lead_line_height
- font_style: italic
- first_line_font_style: bold
- title:
- align: left
- font_color: $heading_font_color
- font_family: $heading_font_family
- font_size: $heading_h4_font_size
- font_style: $heading_font_style
-sidebar:
- font-style: italic
- background-color: f5f5fc
- border-color: 8d81b8
- border-radius: 3
- border-width: 0.2
-sidebar-title:
- 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]
- icon:
- note:
- name: pencil-square-o
- stroke_color: 6489b3
- tip:
- name: comments-o
- stroke_color: 646b74
- size: 24
- important:
- name: info
- stroke_color: 5f8c8b
- warning:
- stroke_color: 9c4d4b
- caution:
- stroke_color: c99a2c
- label:
- text_transform: uppercase
- font_style: bold
-#blockquote:
-# font_color: $base_font_color
-# font_size: $base_font_size_large
-# border_color: $base_border_color
-# border_width: 2
- # FIXME disable negative padding bottom once margin collapsing is implemented
-# padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2]
-# cite_font_size: $base_font_size_small
-# cite_font_color: 51278d
-# code is used for source blocks (perhaps change to source or listing?)
-code:
- font_color: $base_font_color
- font_family: $literal_font_family
- #font_size: ceil($base_font_size)
- font-size: 11
- padding: $code_font_size
- 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
- border_color: cccccc
- border_radius: $base_border_radius
- border_width: 0.2
-conum:
- font_family: M+ 1mn
- font_color: $literal_font_color
- font_size: $base_font_size
- line_height: 4 / 3
-example:
- border_color: $base_border_color
- border_radius: $base_border_radius
- border_width: 0.2
- background_color: ffffff
- # FIXME reenable padding bottom once margin collapsing is implemented
- padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm]
-image:
- align: left
-prose:
- margin_top: $block_margin_top
- margin_bottom: $block_margin_bottom
-thematic_break:
- border_color: $base_border_color
- border_style: solid
- border_width: $base_border_width
- margin_top: $vertical_rhythm * 0.5
- margin_bottom: $vertical_rhythm * 1.5
-description_list:
- term_font_style: bold
- term_spacing: $vertical_rhythm / 4
- description_indent: $horizontal_rhythm * 1.25
-list:
- indent: $horizontal_rhythm * 1.5
- #marker_font_color: 404040
- # NOTE outline_list_item_spacing applies to list items that do not have complex content
- item_spacing: $vertical_rhythm / 2
-table:
- background_color: $page_background_color
- #head_background_color:
- #head_font_color: $base_font_color
- head_font_style: bold
- #body_background_color:
- body_stripe_background_color: d7d7d7
- foot_background_color: f0f0f0
- border_color: dddddd
- border_width: $base_border_width
- cell_padding: 3
-toc:
- indent: $horizontal_rhythm
- line_height: 1.4
- dot_leader:
- #content: ". "
- font_color: a9a9a9
- #levels: 2 3
-# NOTE in addition to footer, header is also supported
-header:
- font_size: $base_font_size_small
- # NOTE if background_color is set, background and border will span width of page
- border_color: dddddd
- border_width: 0.35
- height: $base_line_height_length * 2.6
- line_height: 1
- padding: [$base_line_height_length / 1.3, 1, 0, 1]
- vertical_align: margin_inside
- #image_vertical_align: or
- # additional attributes for content:
- # * {page-count}
- # * {page-number}
- # * {document-title}
- # * {document-subtitle}
- # * {chapter-title}
- # * {section-title}
- # * {section-or-chapter-title}
- recto:
- right:
- content: '{section-or-chapter-title} | Page {page-number}'
- verso:
- left:
- content: '{section-or-chapter-title} | Page {page-number}'
- # left: 'Page {page-number} | {section-or-chapter-title}'
-footer:
- font_size: $base_font_size_small
- # NOTE if background_color is set, background and border will span width of page
- border_color: dddddd
- border_width: 0.25
- height: $base_line_height_length * 2.5
- line_height: 1
- padding: [$base_line_height_length / 2, 1, 0, 1]
- vertical_align: top
- #image_vertical_align: or
- # additional attributes for content:
- # content: '{company}'
- # * {page-count}
- # * {page-number}
- #center:
- #content: '{document-title}'
- # * {document-subtitle}
- # * {chapter-title}
- # * {section-title}
- # * {section-or-chapter-title}
- recto:
- #columns: "<50% =0% >50%"
- right:
- #content: '{page-number}'
- content: '{document-title} | © RISC-V'
- #content: '{document-title} | © RISC-V'
- #center: '{page-number}'
- #content: '{revdate}'
- verso:
- #columns: $footer_recto_columns
- left:
- content: $footer_recto_right_content
- #center: '{page-number}'
- #content: '{page-number}'
diff --git a/a_few_basics.adoc b/src/a_few_basics.adoc
similarity index 99%
rename from a_few_basics.adoc
rename to src/a_few_basics.adoc
index 1ad8ee0..1a381bb 100644
--- a/a_few_basics.adoc
+++ b/src/a_few_basics.adoc
@@ -63,7 +63,7 @@ See <> for additional information on blocks.
While authoring in asciidoc, you cannot jump directly from a Head 1 to a Head 3 or 4. Your headers must appear in sequence from Head 1 to Head 2, and onward. If you skip over a header in the sequence, asciidoctor throws an error.
-Following is an axample of a valid sequence of headers.
+Following is an example of a valid sequence of headers.
```adoc
= Title head (book or report title)
diff --git a/authoring.adoc b/src/authoring.adoc
similarity index 97%
rename from authoring.adoc
rename to src/authoring.adoc
index 1851313..47975e3 100644
--- a/authoring.adoc
+++ b/src/authoring.adoc
@@ -9,7 +9,7 @@ In either case, please feel free to examine the AsciiDoc source files for this `
=== About Asciidoctor
-AsiiDoc is the markup language and Asciidoctor is a set of toolchains that support publishing from AsciiDoc.
+AsciiDoc is the markup language and Asciidoctor is a set of toolchains that support publishing from AsciiDoc.
There are three major Asciidoctor toolchains:
diff --git a/bibliography.adoc b/src/bibliography.adoc
similarity index 100%
rename from bibliography.adoc
rename to src/bibliography.adoc
diff --git a/blocks_notes_markers.adoc b/src/blocks_notes_markers.adoc
similarity index 97%
rename from blocks_notes_markers.adoc
rename to src/blocks_notes_markers.adoc
index f605ad4..85ec226 100644
--- a/blocks_notes_markers.adoc
+++ b/src/blocks_notes_markers.adoc
@@ -37,7 +37,7 @@ This is more content in the sidebar block.
****
-You can add a title, along with any kind of content. Best practice for many of the "commentaries" in the LaTeX source that elucidate the decisionmaking process is to convert to this format with the `TIP` icon that illustrates a conversation or discussion, as in the following example:
+You can add a title, along with any kind of content. Best practice for many of the "commentaries" in the LaTeX source that elucidate the decision-making process is to convert to this format with the `TIP` icon that illustrates a conversation or discussion, as in the following example:
[source,adoc]
----
@@ -428,9 +428,9 @@ Asciidoctor-bibtex enables options that allow for establishing a single source o
For asciidoctor-bibtex to work, please install the Ruby gems as documented in the docs-templates README file.
-NOTE: This has now been tested and is the preferred procedure for adding a biliography.
+NOTE: This has now been tested and is the preferred procedure for adding a bibliography.
-The doc header file in the docs-templates repo now contains the following attributes for the purpose of implementing a biliograpy using asciidoctor-bibtex:
+The doc header file in the docs-templates repo now contains the following attributes for the purpose of implementing a bibliography using asciidoctor-bibtex:
[source,adoc]
----
@@ -439,7 +439,7 @@ The doc header file in the docs-templates repo now contains the following attrib
:bibtex-style: apa
----
-The repo also contains the most recent version of the `riscv-spec.bib` file for asciidocotor-bibtex to use while building the bibliogrpahy.
+The repo also contains the most recent version of the `riscv-spec.bib` file for asciidoctor-bibtex to use while building the bibliography.
When you run asciidoctor-bibtex as part of the build, it searches for the bibtex file first in the folder and subfolders of the document header, and then in `\~/Documents`."
@@ -454,7 +454,7 @@ with the result, cite:[riscvtr(12)]
Add age numbers (locators) using the pattern:
-[sorce,adoc]
+[source,adoc]
----
cite:[Kim-micro2005(45)]
----
diff --git a/colophon.adoc b/src/colophon.adoc
similarity index 100%
rename from colophon.adoc
rename to src/colophon.adoc
diff --git a/book_header.adoc b/src/docs-dev-guide.adoc
similarity index 90%
rename from book_header.adoc
rename to src/docs-dev-guide.adoc
index 8d8da81..150abbc 100644
--- a/book_header.adoc
+++ b/src/docs-dev-guide.adoc
@@ -9,22 +9,23 @@
//stable: assume everything could change
//frozen: of you implement this version you assume the risk that something might change because of the public review cycle but we expect little to no change.
//ratified: you can implement this and be assured nothing will change. if something needs to change due to an errata or enhancement, it will come out in a new extension. we do not revise extensions.
+:revinfo:
:url-riscv: http://riscv.org
:doctype: book
-//:doctype: report
:preface-title: Preamble
:colophon:
:appendix-caption: Appendix
:imagesdir: images
-:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center]
+:title-logo-image: image:risc-v_logo.png["RISC-V International Logo",pdfwidth=3.25in,align=center]
//:page-background-image: image:draft.svg[opacity=20%]
//:title-page-background-image: none
:back-cover-image: image:backpage.png[opacity=25%]
// Settings:
:experimental:
:reproducible:
-:imagesoutdir: images
-:bibtex-file: resources/riscv-spec.bib
+:imagesoutdir: ../build/images
+:srcdir: src
+:bibtex-file: {srcdir}/riscv-spec.bib
:bibtex-order: alphabetical
:bibtex-style: apa
:icons: font
@@ -39,7 +40,7 @@ ifdef::backend-pdf[]
endif::[]
:table-caption: Table
:figure-caption: Figure
-:xrefstyle: full
+:xrefstyle: short
:chapter-refsig: Chapter
:section-refsig: Section
:appendix-refsig: Appendix
@@ -57,7 +58,7 @@ This document is released under a Creative Commons Attribution 4.0 International
//the colophon allows for a section after the preamble that is part of the frontmatter and therefore not assigned a page number.
include::colophon.adoc[]
-//While some documents need several levels of introductory material, other documents only need a breif introduction. You can choose to have either colophon or an overview, or to have both.
+//While some documents need several levels of introductory material, other documents only need a brief introduction. You can choose to have either colophon or an overview, or to have both.
//include::overview.adoc[]
include::authoring.adoc[]
diff --git a/images/backpage.png b/src/images/backpage.png
similarity index 100%
rename from images/backpage.png
rename to src/images/backpage.png
diff --git a/images/circuit.png b/src/images/circuit.png
similarity index 100%
rename from images/circuit.png
rename to src/images/circuit.png
diff --git a/images/diagram-classes.svg b/src/images/diagram-classes.svg
similarity index 100%
rename from images/diagram-classes.svg
rename to src/images/diagram-classes.svg
diff --git a/images/draft.png b/src/images/draft.png
similarity index 100%
rename from images/draft.png
rename to src/images/draft.png
diff --git a/images/example-3.svg b/src/images/example-3.svg
similarity index 100%
rename from images/example-3.svg
rename to src/images/example-3.svg
diff --git a/images/graphviz/litmus_sample.txt b/src/images/graphviz/litmus_sample.txt
similarity index 100%
rename from images/graphviz/litmus_sample.txt
rename to src/images/graphviz/litmus_sample.txt
diff --git a/images/image-example.svg b/src/images/image-example.svg
similarity index 100%
rename from images/image-example.svg
rename to src/images/image-example.svg
diff --git a/images/image_placeholder.png b/src/images/image_placeholder.png
similarity index 100%
rename from images/image_placeholder.png
rename to src/images/image_placeholder.png
diff --git a/images/risc-v_logo.png b/src/images/risc-v_logo.png
similarity index 100%
rename from images/risc-v_logo.png
rename to src/images/risc-v_logo.png
diff --git a/images/wavedrom/instruction_formats.adoc b/src/images/wavedrom/instruction_formats.adoc
similarity index 100%
rename from images/wavedrom/instruction_formats.adoc
rename to src/images/wavedrom/instruction_formats.adoc
diff --git a/images/wavedrom/test4wvdrm.adoc b/src/images/wavedrom/test4wvdrm.adoc
similarity index 100%
rename from images/wavedrom/test4wvdrm.adoc
rename to src/images/wavedrom/test4wvdrm.adoc
diff --git a/images/wavedrom/wavedrom-example.svg b/src/images/wavedrom/wavedrom-example.svg
similarity index 100%
rename from images/wavedrom/wavedrom-example.svg
rename to src/images/wavedrom/wavedrom-example.svg
diff --git a/images/wavedrom/wavedrom-example2.svg b/src/images/wavedrom/wavedrom-example2.svg
similarity index 100%
rename from images/wavedrom/wavedrom-example2.svg
rename to src/images/wavedrom/wavedrom-example2.svg
diff --git a/index.adoc b/src/index.adoc
similarity index 100%
rename from index.adoc
rename to src/index.adoc
diff --git a/linting.adoc b/src/linting.adoc
similarity index 100%
rename from linting.adoc
rename to src/linting.adoc
diff --git a/presentation/install-tools.adoc b/src/presentation/install-tools.adoc
similarity index 100%
rename from presentation/install-tools.adoc
rename to src/presentation/install-tools.adoc
diff --git a/presentation/readme.adoc b/src/presentation/readme.adoc
similarity index 100%
rename from presentation/readme.adoc
rename to src/presentation/readme.adoc
diff --git a/resources/riscv-spec.bib b/src/riscv-spec.bib
similarity index 100%
rename from resources/riscv-spec.bib
rename to src/riscv-spec.bib
diff --git a/tables_graphics.adoc b/src/tables_graphics.adoc
similarity index 94%
rename from tables_graphics.adoc
rename to src/tables_graphics.adoc
index 73311c7..3961591 100644
--- a/tables_graphics.adoc
+++ b/src/tables_graphics.adoc
@@ -90,7 +90,7 @@ NOTE: Annotations have been added to the code to illustrate their use.
=== Unicode symbols
-For pdf, five-digit unicdole symbols generally don't work and some other unicode symbols are buggy. This happens because the Ruby asciidcotor-pdf toolchain makes ue of Prawn to build pdfs and it's Prawn that has the problems.
+For PDFs, five-digit unicode symbols generally don't work and some other unicode symbols are buggy. This happens because the Ruby asciidoctor-pdf toolchain makes use of Prawn to build PDFs and it's Prawn that has the problems.
Here are a few unicode examples from https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references that might be useful:
@@ -133,7 +133,7 @@ sym,num,name
r,114,latin small letter r
|===
-For many symbols, then, we must turn to asciidoctor-mathematical. See <>.
+For many symbols, then, we must turn to asciidoctor-mathematical. See <>.
[[unicode-not-working]]
.Unicode identified as not working
@@ -153,9 +153,9 @@ While asciidoc can render graphics in all popular formats, by far the highest qu
https://wavedrom.com/[WaveDrom sequence diagrams] are essential to the RISC-V specifications. We are in the process of phasing in an automated process for incorporating WaveDrom diagrams into the professional quality pdf output so please stay tuned.
-https://asciidoctor.org/docs/asciidoctor-diagram/#image-output-location[Asciidocdoctor-pdf] enables automation of diagrams from scripts, including WaveDrom.
+https://asciidoctor.org/docs/asciidoctor-diagram/#image-output-location[Asciidocdoctor-pdf] enables automation of diagrams from scripts, including Wavedrom.
-Even as we are using WaveDrom to simplify the creation of accurate svgs for register diagrams, the graphical elements--those for the various diagrams--add complexity to the build.
+Even as we are using Wavedrom to simplify the creation of accurate SVGs for register diagrams, the graphical elements--those for the various diagrams--add complexity to the build.
==== Automated diagramming
@@ -296,7 +296,7 @@ include::images/wavedrom/filename.adoc
The Unpriv appendices contain Graphviz diagrams with associated keys that are arranged in tables. While in the LaTeX version, the diagrams and tables are arranged side-by-side, for the AsciiDoc version;
* each Graphviz diagram should be directly above the key table.
-* store scripts for Graphiviz diagrams in the images/graphviz directory, as .txt
+* store scripts for Graphviz diagrams in the images/graphviz directory, as .txt
* import the Graphviz by reference using the pattern in the following example.
[source,adoc]
@@ -501,7 +501,7 @@ DiagramBlock <|-- DitaaBlock
DiagramBlock <|-- PlantUmlBlock
....
-NOTE: Asciidoctor supports dditional diagram types. For information on additional diagram types, see the https://docs.asciidoctor.org/diagram-extension/latest/[Asciidoctor-diagram documentation].
+NOTE: Asciidoctor supports additional diagram types. For information on additional diagram types, see the https://docs.asciidoctor.org/diagram-extension/latest/[Asciidoctor-diagram documentation].
===== A mention of Bytefield
@@ -522,7 +522,7 @@ Currently the idea of making use of Bytefield as an additional diagram type is b
=== Mathematical notations
-WARNING: Asciidoctor-mathematical has some limitations. For inline expressions, the graphical representations appear small and they are centered virtically. In some cases where there is a single-character Asciidoctor-mathemtical expresssion, it unintentionally looks like a superscript. For this reason, always use viable alternatives like _italics_ or unicode (see <>).
+WARNING: Asciidoctor-mathematical has some limitations. For inline expressions, the graphical representations appear small and they are centered vertically. In some cases where there is a single-character Asciidoctor-mathematical expression, it unintentionally looks like a superscript. For this reason, always use viable alternatives like _italics_ or unicode (see <>).
==== Superscripts and subscripts
@@ -584,5 +584,5 @@ latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$]
[TIP]
====
-Latexmath rendering has some limitations with respect to sizing and placement inline. This happens because of how the images for the mathemtical symbols are rendered within the build process. For this reason, please avoid using single character latexmath expresions inline and prefentially make use of unicode or superscripts and subscripts when possible.
+Latexmath rendering has some limitations with respect to sizing and placement inline. This happens because of how the images for the mathematical symbols are rendered within the build process. For this reason, please avoid using single character latexmath expressions inline and preferentially make use of unicode or superscripts and subscripts when possible.
====
diff --git a/wavedrom_edit.adoc b/src/wavedrom_edit.adoc
similarity index 99%
rename from wavedrom_edit.adoc
rename to src/wavedrom_edit.adoc
index defbfae..925a4b3 100644
--- a/wavedrom_edit.adoc
+++ b/src/wavedrom_edit.adoc
@@ -165,4 +165,4 @@ At the time of this writing, we have noticed the following unexpected results du
* Some, but not all, unicode that works in AsciiDoc (see <> ) actually breaks the Wavedrom diagram build, and other unicode does not break the Wavedrom diagram build but still doesn't render properly.
* Latexmath appears to not work at all in Wavedrom diagrams.
-* After struggling to understand why various options that we explored for an acceptable ≠ in Wavedrom diagrams and discovering the above rather confusing results, we decided to use `!=` as a workaround. With the fact that both Ascoddoctor and Wavedrom are evolving, and also the fact that bytefield is being considered as an alternative diagrams rendering solution, it seems possible that this workaround will be temporary.
+* After struggling to understand why various options that we explored for an acceptable ≠ in Wavedrom diagrams and discovering the above rather confusing results, we decided to use `!=` as a workaround. With the fact that both Asciidoctor and Wavedrom are evolving, and also the fact that bytefield is being considered as an alternative diagrams rendering solution, it seems possible that this workaround will be temporary.
diff --git a/writing.adoc b/src/writing.adoc
similarity index 100%
rename from writing.adoc
rename to src/writing.adoc