aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBill Traynor <wmat@riscv.org>2024-06-12 08:19:27 -0400
committerGitHub <noreply@github.com>2024-06-12 08:19:27 -0400
commit2dc16abaaf78fc36a4f2ce5286238ac62a18cb1c (patch)
treee8b284d82e6cbdec075ca6bb843b0d068f282b03
parentc8c8075a6a71be67ac723528070e3e50ff7586b2 (diff)
parent4b300298575c2c80502f1f5d55551ae003905655 (diff)
downloadriscv-isa-manual-2dc16abaaf78fc36a4f2ce5286238ac62a18cb1c.zip
riscv-isa-manual-2dc16abaaf78fc36a4f2ce5286238ac62a18cb1c.tar.gz
riscv-isa-manual-2dc16abaaf78fc36a4f2ce5286238ac62a18cb1c.tar.bz2
Merge pull request #1449 from riscv/dev/kbroch/setup-docs-resources-submodule
add docs-resources submodule to get pdf theme,fonts, and global attri…
-rw-r--r--.github/workflows/isa-build.yml9
-rw-r--r--.gitignore4
-rw-r--r--.gitmodules3
-rw-r--r--Makefile103
-rw-r--r--build/.gitignore12
-rw-r--r--build/Makefile119
m---------docs-resources0
-rwxr-xr-xsrc/resources/fonts/Montserrat-ExtraLight.ttfbin242128 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Montserrat-ExtraLightItalic.ttfbin246176 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Montserrat-Italic.ttfbin249088 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Montserrat-Light.ttfbin242068 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Montserrat-Medium.ttfbin243180 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Montserrat-MediumItalic.ttfbin248044 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Montserrat-Regular.ttfbin245708 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/OFL-M.txt93
-rwxr-xr-xsrc/resources/fonts/OFL-P.txt93
-rw-r--r--src/resources/fonts/OFL1.txt395
-rwxr-xr-xsrc/resources/fonts/Petrona-Light.ttfbin131328 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Petrona-LightItalic.ttfbin134656 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Petrona-Medium.ttfbin131292 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Petrona-MediumItalic.ttfbin134752 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Petrona-Thin.ttfbin130792 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/Petrona-ThinItalic.ttfbin133648 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/cmunbmr.ttfbin370388 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/cmunbtl.ttfbin410116 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/cmunbto.ttfbin462276 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/droid-sans-fallback.ttfbin190776 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/mplus-1mn-bold.ttfbin1242324 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/mplus-1mn-light.ttfbin1232704 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/mplus-1mn-medium.ttfbin1231932 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/mplus-1mn-regular.ttfbin1243076 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/mplus-1mn-thin.ttfbin1230540 -> 0 bytes
-rwxr-xr-xsrc/resources/fonts/mplus-1p-regular-fallback.ttfbin1359192 -> 0 bytes
-rw-r--r--src/resources/themes/riscv-spec.yml326
-rw-r--r--src/riscv-privileged.adoc13
-rw-r--r--src/riscv-unprivileged.adoc13
36 files changed, 123 insertions, 1060 deletions
diff --git a/.github/workflows/isa-build.yml b/.github/workflows/isa-build.yml
index 66e7401..3a03f40 100644
--- a/.github/workflows/isa-build.yml
+++ b/.github/workflows/isa-build.yml
@@ -29,6 +29,8 @@ jobs:
# Checkout the repository
- name: Checkout repository
uses: actions/checkout@v4
+ with:
+ submodules: recursive
# Set the short SHA for use in artifact names
- name: Set short SHA
@@ -43,8 +45,7 @@ jobs:
# https://hub.docker.com/r/riscvintl/riscv-docs-base-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 and HTML files using the container
- name: Build Files
@@ -52,7 +53,7 @@ jobs:
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 'export LANG=C.utf8; cd ./build && make'
+ /bin/sh -c 'export LANG=C.utf8; make'
# Upload the riscv-privileged PDF file
- name: Upload riscv-privileged.pdf
@@ -127,4 +128,4 @@ jobs:
${{ github.workspace }}/build/riscv-unprivileged.epub
env:
GITHUB_TOKEN: ${{ secrets.GHTOKEN }}
-
+ \ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 0253b91..c3a9cba 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,5 @@
.DS_Store
.*.swp
.vscode
-src/.asciidoctor
-src/diag*
+/build/*
+/images/*
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
new file mode 100644
index 0000000..8093ef9
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,103 @@
+# Makefile for RISC-V ISA Manuals
+#
+# 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 documentation for RISC-V ISA Manuals. It supports multiple build targets
+# for generating documentation in various formats (PDF, HTML, EPUB).
+#
+# Building with a preinstalled docker container is recommended.
+# Install by running:
+#
+# docker pull riscvintl/riscv-docs-base-container-image:latest
+#
+
+DOCS := \
+ riscv-privileged.adoc \
+ riscv-unprivileged.adoc
+
+DATE ?= $(shell date +%Y-%m-%d)
+DOCKER_IMG := riscvintl/riscv-docs-base-container-image:latest
+ifneq ($(SKIP_DOCKER),true)
+ DOCKER_CMD := docker run --rm -v ${PWD}:/build -w /build \
+ ${DOCKER_IMG} \
+ /bin/sh -c
+ DOCKER_QUOTE := "
+endif
+
+SRC_DIR := src
+BUILD_DIR := build
+
+DOCS_PDF := $(DOCS:%.adoc=%.pdf)
+DOCS_HTML := $(DOCS:%.adoc=%.html)
+DOCS_EPUB := $(DOCS:%.adoc=%.epub)
+
+XTRA_ADOC_OPTS :=
+ASCIIDOCTOR_PDF := asciidoctor-pdf
+ASCIIDOCTOR_HTML := asciidoctor
+ASCIIDOCTOR_EPUB := asciidoctor-epub3
+OPTIONS := --trace \
+ -a compress \
+ -a mathematical-format=svg \
+ -a pdf-fontsdir=docs-resources/fonts \
+ -a pdf-theme=docs-resources/themes/riscv-pdf.yml \
+ $(XTRA_ADOC_OPTS) \
+ -D build \
+ --failure-level=ERROR
+REQUIRES := --require=asciidoctor-bibtex \
+ --require=asciidoctor-diagram \
+ --require=asciidoctor-lists \
+ --require=asciidoctor-mathematical
+
+.PHONY: all build clean build-container build-no-container build-docs
+
+all: build
+
+build-docs: $(DOCS_PDF) $(DOCS_HTML) $(DOCS_EPUB)
+
+vpath %.adoc $(SRC_DIR)
+
+%.pdf: %.adoc
+ $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE)
+
+%.html: %.adoc
+ $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE)
+
+%.epub: %.adoc
+ $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_EPUB) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE)
+
+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..."
+ $(MAKE) build-docs
+ @echo "Build completed successfully inside Docker container."
+
+build-no-container:
+ @echo "Starting build..."
+ $(MAKE) SKIP_DOCKER=true build-docs
+ @echo "Build completed successfully."
+
+# Update docker image to latest
+docker-pull-latest:
+ docker pull ${DOCKER_IMG}
+
+clean:
+ @echo "Cleaning up generated files..."
+ rm -rf $(BUILD_DIR)
+ @echo "Cleanup completed."
diff --git a/build/.gitignore b/build/.gitignore
deleted file mode 100644
index cbc2485..0000000
--- a/build/.gitignore
+++ /dev/null
@@ -1,12 +0,0 @@
-*.aux
-*.bbl
-*.blg
-*.epub
-*.html
-*.log
-*.out
-*.pdf
-*.pdf.tmp
-*.toc
-images
-.asciidoctor
diff --git a/build/Makefile b/build/Makefile
deleted file mode 100644
index 6646629..0000000
--- a/build/Makefile
+++ /dev/null
@@ -1,119 +0,0 @@
-# Makefile for RISC-V ISA Manuals
-#
-# 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 documentation for RISC-V ISA Manuals. It supports multiple build targets
-# for generating documentation in various formats (PDF, HTML).
-#
-# Building with a preinstalled docker container is recommended.
-# Install by running:
-#
-# docker pull riscvintl/riscv-docs-base-container-image:latest
-#
-
-# Build Targets
-TARGETS_PDF := riscv-privileged.pdf riscv-unprivileged.pdf
-TARGETS_HTML := riscv-privileged.html riscv-unprivileged.html
-TARGETS_EPUB := riscv-privileged.epub riscv-unprivileged.epub
-TARGETS := $(TARGETS_PDF) $(TARGETS_HTML) $(TARGETS_EPUB)
-
-SHORT_TARGETS := priv-pdf unpriv-pdf priv-html unpriv-html priv-epub unpriv-epub
-
-# Declare phony targets
-.PHONY: all docker clean $(SHORT_TARGETS)
-
-# Default target builds all
-all: $(TARGETS)
-
-define run_with_docker
- cd .. && docker run -it -v `pwd`:/build riscvintl/riscv-docs-base-container-image:latest /bin/sh -c 'export LANG=C.utf8; cd ./build; $(1)'
-endef
-
-# Run natively if command exists, otherwise run with docker
-define maybe_run_with_docker
- @if command -v $(1) &> /dev/null; \
- then \
- $(1) $(2); \
- else \
- $(call run_with_docker, $(1) $(2)); \
- fi
-endef
-
-docker:
- $(call run_with_docker, make -$(MAKEFLAGS) all)
-
-# Asciidoctor options
-ASCIIDOCTOR_OPTS := -a compress \
- --attribute=mathematical-format=svg \
- --failure-level=ERROR \
- --require=asciidoctor-bibtex \
- --require=asciidoctor-diagram \
- --require=asciidoctor-mathematical \
- --trace
-
-# Source directory
-SRCDIR := ../src
-ALL_SRCS := $(shell find $(SRCDIR) -type f)
-
-# Privileged ISA build
-priv-pdf: riscv-privileged.pdf
-
-riscv-privileged.pdf: $(SRCDIR)/riscv-privileged.adoc $(ALL_SRCS)
- @echo "Building Privileged ISA"
- @rm -f $@.tmp
- $(call maybe_run_with_docker, asciidoctor-pdf, $(ASCIIDOCTOR_OPTS) --out-file=$@.tmp $<)
- @mv $@.tmp $@
-
-# Unprivileged ISA build
-unpriv-pdf: riscv-unprivileged.pdf
-
-riscv-unprivileged.pdf: $(SRCDIR)/riscv-unprivileged.adoc $(ALL_SRCS)
- @echo "Building Unprivileged ISA"
- @rm -f $@.tmp
- $(call maybe_run_with_docker, asciidoctor-pdf, $(ASCIIDOCTOR_OPTS) --out-file=$@.tmp $<)
- @mv $@.tmp $@
-
-# Privileged ISA HTML build
-priv-html: riscv-privileged.html
-
-riscv-privileged.html: $(SRCDIR)/riscv-privileged.adoc $(ALL_SRCS)
- @echo "Building Privileged ISA HTML"
- @rm -f $@.tmp
- $(call maybe_run_with_docker, asciidoctor, $(ASCIIDOCTOR_OPTS) --out-file=$@.tmp $<)
- @mv $@.tmp $@
-
-# Unprivileged ISA HTML build
-unpriv-html: riscv-unprivileged.html
-
-riscv-unprivileged.html: $(SRCDIR)/riscv-unprivileged.adoc $(ALL_SRCS)
- @echo "Building Unprivileged ISA HTML"
- @rm -f $@.tmp
- $(call maybe_run_with_docker, asciidoctor, $(ASCIIDOCTOR_OPTS) --out-file=$@.tmp $<)
- @mv $@.tmp $@
-
-priv-epub: riscv-privileged.epub
-
-riscv-privileged.epub: $(SRCDIR)/riscv-privileged.adoc $(ALL_SRCS)
- @echo "Building Privileged ISA EPUB"
- @rm -f $@.tmp
- $(call maybe_run_with_docker, asciidoctor-epub3, $(ASCIIDOCTOR_OPTS) --out-file=$@.tmp $<)
- @mv $@.tmp $@
-
-unpriv-epub: riscv-unprivileged.epub
-
-riscv-unprivileged.epub: $(SRCDIR)/riscv-unprivileged.adoc $(ALL_SRCS)
- @echo "Building Unprivileged ISA EPUB"
- @rm -f $@.tmp
- $(call maybe_run_with_docker, asciidoctor-epub3, $(ASCIIDOCTOR_OPTS) --out-file=$@.tmp $<)
- @mv $@.tmp $@
-
-clean:
- rm -f $(TARGETS) $(addsuffix .tmp,$(TARGETS))
diff --git a/docs-resources b/docs-resources
new file mode 160000
+Subproject 7a6ceaccd2cc0a8bb1fedf57a232af028afc0b9
diff --git a/src/resources/fonts/Montserrat-ExtraLight.ttf b/src/resources/fonts/Montserrat-ExtraLight.ttf
deleted file mode 100755
index ca0bbb6..0000000
--- a/src/resources/fonts/Montserrat-ExtraLight.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Montserrat-ExtraLightItalic.ttf b/src/resources/fonts/Montserrat-ExtraLightItalic.ttf
deleted file mode 100755
index f3c1559..0000000
--- a/src/resources/fonts/Montserrat-ExtraLightItalic.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Montserrat-Italic.ttf b/src/resources/fonts/Montserrat-Italic.ttf
deleted file mode 100755
index eb4232a..0000000
--- a/src/resources/fonts/Montserrat-Italic.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Montserrat-Light.ttf b/src/resources/fonts/Montserrat-Light.ttf
deleted file mode 100755
index 990857d..0000000
--- a/src/resources/fonts/Montserrat-Light.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Montserrat-Medium.ttf b/src/resources/fonts/Montserrat-Medium.ttf
deleted file mode 100755
index 6e079f6..0000000
--- a/src/resources/fonts/Montserrat-Medium.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Montserrat-MediumItalic.ttf b/src/resources/fonts/Montserrat-MediumItalic.ttf
deleted file mode 100755
index 0dc3ac9..0000000
--- a/src/resources/fonts/Montserrat-MediumItalic.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Montserrat-Regular.ttf b/src/resources/fonts/Montserrat-Regular.ttf
deleted file mode 100755
index 8d443d5..0000000
--- a/src/resources/fonts/Montserrat-Regular.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/OFL-M.txt b/src/resources/fonts/OFL-M.txt
deleted file mode 100755
index 7881887..0000000
--- a/src/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/src/resources/fonts/OFL-P.txt b/src/resources/fonts/OFL-P.txt
deleted file mode 100755
index 79320bd..0000000
--- a/src/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/src/resources/fonts/OFL1.txt b/src/resources/fonts/OFL1.txt
deleted file mode 100644
index 06c608d..0000000
--- a/src/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/src/resources/fonts/Petrona-Light.ttf b/src/resources/fonts/Petrona-Light.ttf
deleted file mode 100755
index 687a25f..0000000
--- a/src/resources/fonts/Petrona-Light.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Petrona-LightItalic.ttf b/src/resources/fonts/Petrona-LightItalic.ttf
deleted file mode 100755
index 0fd2e15..0000000
--- a/src/resources/fonts/Petrona-LightItalic.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Petrona-Medium.ttf b/src/resources/fonts/Petrona-Medium.ttf
deleted file mode 100755
index eecc1b6..0000000
--- a/src/resources/fonts/Petrona-Medium.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Petrona-MediumItalic.ttf b/src/resources/fonts/Petrona-MediumItalic.ttf
deleted file mode 100755
index d316f85..0000000
--- a/src/resources/fonts/Petrona-MediumItalic.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Petrona-Thin.ttf b/src/resources/fonts/Petrona-Thin.ttf
deleted file mode 100755
index 6c61a3c..0000000
--- a/src/resources/fonts/Petrona-Thin.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/Petrona-ThinItalic.ttf b/src/resources/fonts/Petrona-ThinItalic.ttf
deleted file mode 100755
index 85a0624..0000000
--- a/src/resources/fonts/Petrona-ThinItalic.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/cmunbmr.ttf b/src/resources/fonts/cmunbmr.ttf
deleted file mode 100755
index a9eb24f..0000000
--- a/src/resources/fonts/cmunbmr.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/cmunbtl.ttf b/src/resources/fonts/cmunbtl.ttf
deleted file mode 100755
index b0f26fa..0000000
--- a/src/resources/fonts/cmunbtl.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/cmunbto.ttf b/src/resources/fonts/cmunbto.ttf
deleted file mode 100755
index 10fcbbc..0000000
--- a/src/resources/fonts/cmunbto.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/droid-sans-fallback.ttf b/src/resources/fonts/droid-sans-fallback.ttf
deleted file mode 100755
index ad1efca..0000000
--- a/src/resources/fonts/droid-sans-fallback.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/mplus-1mn-bold.ttf b/src/resources/fonts/mplus-1mn-bold.ttf
deleted file mode 100755
index b631cf9..0000000
--- a/src/resources/fonts/mplus-1mn-bold.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/mplus-1mn-light.ttf b/src/resources/fonts/mplus-1mn-light.ttf
deleted file mode 100755
index 2abb31f..0000000
--- a/src/resources/fonts/mplus-1mn-light.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/mplus-1mn-medium.ttf b/src/resources/fonts/mplus-1mn-medium.ttf
deleted file mode 100755
index 2ccef34..0000000
--- a/src/resources/fonts/mplus-1mn-medium.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/mplus-1mn-regular.ttf b/src/resources/fonts/mplus-1mn-regular.ttf
deleted file mode 100755
index 9442e59..0000000
--- a/src/resources/fonts/mplus-1mn-regular.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/mplus-1mn-thin.ttf b/src/resources/fonts/mplus-1mn-thin.ttf
deleted file mode 100755
index 2af69a6..0000000
--- a/src/resources/fonts/mplus-1mn-thin.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/fonts/mplus-1p-regular-fallback.ttf b/src/resources/fonts/mplus-1p-regular-fallback.ttf
deleted file mode 100755
index cccc405..0000000
--- a/src/resources/fonts/mplus-1p-regular-fallback.ttf
+++ /dev/null
Binary files differ
diff --git a/src/resources/themes/riscv-spec.yml b/src/resources/themes/riscv-spec.yml
deleted file mode 100644
index e3dda77..0000000
--- a/src/resources/themes/riscv-spec.yml
+++ /dev/null
@@ -1,326 +0,0 @@
-extends: default
-font:
- catalog:
- merge: true
- sans-serif: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf
- #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
- italic: droid-sans-fallback.ttf
- bold: droid-sans-fallback.ttf
- bold_italic: 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
- svg:
- fallback-font-family: M+ 1mn
-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
- border_radius: 3
- border_width: 0.25
- border_color: EEEEEE
-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
- # codespan is currently used for inline monospaced in prose and table cells
-codespan:
- font-color: 000000
- #font_family: code
- #font_family: Droid Fallback
- font_family: M+ 1mn
- font_style: normal
-# font-size: 11.5
-menu_caret_content: " <font size=\"1.15em\"><color rgb=\"000000\">\u203a</color></font> "
-heading:
- align: left
- margin_bottom: $block_margin_bottom
- #margin_top: 0.25in
- margin_top: $block_margin_bottom
- min_height_after: auto
- font_color: 000000
- font_family: headings
- font_style: bold
- 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.0)
- h2-font-size: 11.5
- #h3_font_size: round($base_font_size * 1.7)
- h3-font-size: 11.5
- #h4_font_size: $base_font_size_large
- h4-font-size: 11.5
- #h5_font_size: $base_font_size
- h5-font-size: 11.5
- h6_font_size: $base_font_size_small
-title_page:
- align: center
- 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)
- margin-top: 25
- 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
- name: far-edit
- stroke_color: 6489b3
- tip:
- #name: comments-o
- name: far-comments
- stroke_color: 646b74
- size: 24
- important:
- #name: info
- name: fas-info-circle
- 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-color: 000000
- font_family: $codespan_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
- background_color: ffffff
- #border_color: cccccc
- #border_radius: $base_border_radius
- #border_width: 0.2
- caption:
- end: bottom
-conum:
- font_family: M+ 1mn
- font_color: $codespan_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 re-enable padding bottom once margin collapsing is implemented
- padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm]
-image:
- align: left
- caption:
- align: center
-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
-figure:
- caption:
- end: bottom
- align: center
-table:
- background_color: $page_background_color
- font-size: 9
- #head_background_color: #2596be
- #head_font_color: $base_font_color
- head_font_style: bold
- #body_background_color: <hex value>
- body_stripe_background_color: d7d7d7
- foot_background_color: f0f0f0
- border_color: dddddd
- border_width: $base_border_width
- cell_padding: 3
- caption:
- end: top
- align: center
- text-align: center
- max-width: none
-toc:
- indent: $horizontal_rhythm
- line_height: 1.4
- dot-leader:
- content: " "
- font_color: a9a9a9
- font-style: bold
- #levels: 2
- h2-font-style: bold
-# NOTE in addition to footer, header is also supported
-header:
- font_size: $base_font_size_small
- border_color: dddddd
- border_width: 0.35
- height: $base_line_height_length * 2.6
- line_height: 1
- padding: [$base_line_height_length / 1, 1, .5, 1]
- vertical_align: margin_inside
- recto:
- right:
- content: '{section-or-chapter-title} | Page {page-number}'
- verso:
- left:
- content: '{section-or-chapter-title} | Page {page-number}'
-footer:
- font_size: $base_font_size_small
- border_color: dddddd
- border_width: 0.35
- height: $base_line_height_length * 2.6
- line_height: 1
- padding: [$base_line_height_length / 1, 1, .5, 1]
- vertical_align: top
- #image_vertical_align: <alignment> or <number>
- # 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 International'
- #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/src/riscv-privileged.adoc b/src/riscv-privileged.adoc
index 0318802..afe0883 100644
--- a/src/riscv-privileged.adoc
+++ b/src/riscv-privileged.adoc
@@ -1,22 +1,18 @@
[[risc-v-isa]]
= The RISC-V Instruction Set Manual: Volume II: Privileged Architecture
+include::../docs-resources/global-config.adoc[]
:description: Volume II - Privileged Architecture
-:company: RISC-V.org
:revnumber: 20240528
//:revremark: Pre-release version
//development: assume everything can change
//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.
-:url-riscv: http://riscv.org
-:doctype: book
:colophon:
-:pdf-theme: ../src/resources/themes/riscv-spec.yml
-:pdf-fontsdir: ../src/resources/fonts/
:preface-title: Preamble
:appendix-caption: Appendix
-:imagesdir: images
-:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center]
+:imagesdir: ../docs-resources/images
+:title-logo-image: image:risc-v_logo.png["RISC-V International Logo",pdfwidth=3.25in,align=center]
:page-background-image: image:draft.png[opacity=20%]
//:title-page-background-image: none
//:back-cover-image: image:backpage.png[opacity=25%]
@@ -24,7 +20,7 @@
:experimental:
:reproducible:
:imagesoutdir: images
-:bibtex-file: ../src/resources/riscv-spec.bib
+:bibtex-file: src/resources/riscv-spec.bib
:bibtex-order: alphabetical
:bibtex-style: apa
:bibtex-format: asciidoc
@@ -58,6 +54,7 @@ endif::[]
:ne: &#8800;
:approx: &#8776;
:inf: &#8734;
+:imagesdir: images
_Contributors to all versions of the spec in alphabetical order (please contact
editors to suggest corrections): Krste Asanović, Peter Ashenden, Rimas
diff --git a/src/riscv-unprivileged.adoc b/src/riscv-unprivileged.adoc
index 4c14129..a755403 100644
--- a/src/riscv-unprivileged.adoc
+++ b/src/riscv-unprivileged.adoc
@@ -1,18 +1,14 @@
[[risc-v-isa]]
= The RISC-V Instruction Set Manual Volume I: Unprivileged Architecture
+include::../docs-resources/global-config.adoc[]
:description: Unprivileged Architecture
-:company: RISC-V.org
:revnumber: 20240411
//:revremark: Pre-release version
-:url-riscv: http://riscv.org
-:doctype: book
:colophon:
-:pdf-theme: ../src/resources/themes/riscv-spec.yml
-:pdf-fontsdir: ../src/resources/fonts/
:preface-title: Preamble
:appendix-caption: Appendix
-:imagesdir: images
-:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center]
+:imagesdir: ../docs-resources/images
+:title-logo-image: image:risc-v_logo.png["RISC-V International Logo",pdfwidth=3.25in,align=center]
:page-background-image: image:draft.png[opacity=20%]
//:title-page-background-image: none
//:back-cover-image: image:backpage.png[opacity=25%]
@@ -21,7 +17,7 @@
:experimental:
:reproducible:
:imagesoutdir: images
-:bibtex-file: ../src/resources/riscv-spec.bib
+:bibtex-file: src/resources/riscv-spec.bib
:bibtex-order: alphabetical
:bibtex-style: apa
:bibtex-format: asciidoc
@@ -55,6 +51,7 @@ endif::[]
:approx: &#8776;
:inf: &#8734;
:csrname: envcfg
+:imagesdir: images
_Contributors to all versions of the spec in alphabetical order (please contact editors to suggest
corrections): Derek Atkins,