[[riscv-authoring]]
= Authoring and Editing RISC-V Specifications
:description: A working template for documenting RISC-V architecture in asciidoc
:company: RISC-V.org
:revdate: 12/2021
:revnumber: 0.
: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.
:revinfo:
:url-riscv: http://riscv.org
:doctype: book
:preface-title: Preamble
:colophon:
:appendix-caption: Appendix
:imagesdir: images
: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: ../build/images
:srcdir: src
:bibtex-file: {srcdir}/riscv-spec.bib
:bibtex-order: alphabetical
:bibtex-style: apa
:icons: font
:lang: en
:listing-caption: Listing
:sectnums:
:toc: left
:toclevels: 4
:source-highlighter: pygments
ifdef::backend-pdf[]
:source-highlighter: coderay
endif::[]
:table-caption: Table
:figure-caption: Figure
:xrefstyle: short
:chapter-refsig: Chapter
:section-refsig: Section
:appendix-refsig: Appendix
:data-uri:
:hide-uri-scheme:
:stem: latexmath
:footnote:

This is the preamble, which can contain contributor information and should contain the Creative Commons Attribution statement below.

For this book example, I have copied information directly from several Web sites that are hosted by asciidoctor.org and devoted to providing Asciidoc/Asciidoctor documentation, and have authored some explanations. Graphics used are either explicitly available for free, are property of RISC-V International, or were created using Wavedrom.

This document is released under a Creative Commons Attribution 4.0 International License.

//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 brief introduction. You can choose to have either colophon or an overview, or to have both.
include::intro.adoc[]

include::authoring.adoc[]

include::a_few_basics.adoc[]

include::tables_symbols_math.adoc[]

include::blocks_notes_markers.adoc[]

include::graphics.adoc[]

include::writing.adoc[]

include::style-guidelines.adoc[]

include::linting.adoc[]

//please note that the index must precede the bibliography for both to work within the same book.
include::index.adoc[]

include::bibliography.adoc[]
