Merge branch 'main' into reorg

Signed-off-by: Kersten Richter <[email protected]>

src/a_few_basics.adoc

@@ -133,7 +133,7 @@ Example output:
 
 ==== Nested list
 
-To create a nested unordered list, use `** ` before the nested item. 
+To create a nested unordered list, use `** ` before the nested item.
 
 ----
 * Priv

src/authoring.adoc

@@ -54,4 +54,3 @@ The following list contains links to resources for text editors/IDEs support of
 ** https://plugins.jetbrains.com/plugin/7391-asciidoc[jetbrain asciidoc plugin]
 * https://www.sublimetext.com/[Sublime Text] (NOTE: Sublime is not free)
 ** https://packagecontrol.io/packages/AsciiDoc[asciidoc package for Sublime Text2]
-

src/blocks_notes_markers.adoc

@@ -336,3 +336,4 @@ TIP: They can contain any type of content, including admonitions like this, and
 const { expect, expectCalledWith, heredoc } = require('../test/test-utils')
 ----
 ****
+=======

src/graphics.adoc

@@ -1,7 +1,7 @@
 [[graphics]]
 == Graphics
 
-Graphics help people learn, break up text, and can overall improve your document content. 
+Graphics help people learn, break up text, and can overall improve your document content.
 
 While AsciiDoc can render graphics in all popular formats, by far the highest quality graphics rendering is from `.svg` format. This format is the preferred graphic type to use in RISC-V documents.
 
@@ -19,7 +19,7 @@ You can certainly use one of the other supported types, but know that they might
 
 Follow these guidelines for graphics.
 
-* Store your graphics in a subfolder. For the RISC-V main ISA doc, this folder is the https://github.com/riscv/riscv-isa-manual/tree/main/src/images[`images` folder]. Place your graphic in the subfolder that correspondes to its type. 
+* Store your graphics in a subfolder. For the RISC-V main ISA doc, this folder is the https://github.com/riscv/riscv-isa-manual/tree/main/src/images[`images` folder]. Place your graphic in the subfolder that correspondes to its type.
 * The build process creates the final image object. Do *not* create any generated image files into GitHub.
 * Introduce your graphic with a lead-in sentence. "The following image shows ..."
 * Use "following" and "preceding" to locate your image. Avoid using "above" or "below" (Doesn't make sense for people that use screen readers.)

src/images/bytefield/examplebyte.adoc

@@ -15,4 +15,4 @@
 (draw-box (text "(WARL)" {:font-weight "bold"}) {:font-size 18 :span 15 :text-anchor "start" :borders {:top :border-unrelated :bottom :border-unrelated :right :border-unrelated}})
 
 (draw-box "MXLEN" {:font-size 24 :span 32 :borders {}})
-----
+----

src/index_bib.adoc

@@ -1,7 +1,7 @@
 [[index_bib]]
 == Index and bibliography
 
-An index and bibliography are included in the main priv and unpriv docs. You can develop your own index and bibliography for your stand alone document, but if it is to be merged into the main docs, you must merge the index and bibliography as well. 
+An index and bibliography are included in the main priv and unpriv docs. You can develop your own index and bibliography for your stand alone document, but if it is to be merged into the main docs, you must merge the index and bibliography as well.
 
 === Index markers
 

src/style-guidelines.adoc

@@ -16,6 +16,7 @@ Follow these basic formatting guidelines.
 * Use *`monospace bold`* for any literals.
 * Any number range, use regular font.
 * Put punctuation outside of quotes, unless you are quoting someone directly.
+=======
 
 .Formatting guidelines for names
 * Instructions are lowercase (`ld`, `c`.`lw`)
@@ -38,8 +39,6 @@ Use the following guidelines when you document a CSR:
 * As a general rule, whenever you use a term in tics, it should be followed by what the thing is to help with translation. So avoid statements similar to this one:  “`misa` also helps distinguish different variants of a design.”  And instead use this one: “The `misa` CSR also helps distinguish different variants of a design.”
 * Fields for registers are formatted in this style: `register`.FIELD. For example, `sstatus`.SPP.
 
-[[naming-rules]]
-
 [[table-rules]]
 === Table formatting
 
@@ -68,4 +67,5 @@ Follow these punctuation rules for tables.
 * If all cells in a table column are complete sentences, then end each cell with a period.
 * If all cells in a table column are sentence fragments, then do not use a period to end each cell.
 * If cells in a table column contain a mixture of complete and fragmented sentences, then first try to make them all parallel - either all complete sentences or all sentence fragments. However, if this approach is impractical, then punctuate each cell independently, and punctuate appropriate for that individual cell. 
-- Do not end column headers with punctuation, including a period, an ellipsis, or a colon.
+* Do not end column headers with punctuation, including a period, an ellipsis, or a colon.
+

src/tables_symbols_math.adoc

@@ -1,18 +1,19 @@
 [[tables_symbols_math]]
 === Tables
 
+By using tables, you can group information into logical units, which can make the infromation presented easier to understand.
+
+[[tables-gen]]
+==== General rules for tables
 Follow these general rules when you create a table.
 
 * Avoid tables in the middle of lists.
 * Do not use tables to lay out a page. For example, if you have a long list of items, do not use a 2 column table to save space. The information should make sense side by side.
-* Do not create a table that has a single row or a single column, unless you are following a previous layout. For example, if each section in a chapter includes a table of options, then use a table even if one of the sections has only a single option. 
+* Do not create a table that has a single row or a single column, unless you are following a previous layout. For example, if each section in a chapter includes a table of options, then use a table even if one of the sections has only a single option.
 * Always use table headers and captions to make your tables more accessible.
 * Use introductory sentences for your table. For example, "The following table contains the options for the CSR." You can use either a period or a colon for your introductory sentence.
 * Do not refer to the "table above" or the "below table". Use words such as "The following table" or "The preceeding table".
 
-For table formatting rules, see <<table-rule>>.
-
-
 [WARNING]
 ====
 *Never* use automated wrapping for table titles, figure captions, and example captions. Asciidoctor reads a hard return as an indicator to start a new "Normal" paragraph.

src/word-usage.adoc

@@ -26,7 +26,7 @@ Following:: Don't use "following" by itself. Don't say "See the following". Inst
 If (whether):: Use if as a condition, such as logic. If a, then b.
 Use whether to indicate choice or alternative. Event a happens, whether event b does or not.
 
-Latin phrases:: Avoid abbreviations such as etc., e.g., i.e. They do not translate well. Instead use "and so on" and "for example,". If you do use e.g. or i.e., then know that e.g. means "for example" and i.e means "in other words". With e.g., it is understood that there are more examples than just the ones listed; "The colors of the rainbow, e.g. red, yellow and green". With i.e., however, it is intended as a replacement for the previous text. "The primary colors, i.e. red, blue, and yellow". 
+Latin phrases:: Avoid abbreviations such as etc., e.g., i.e. They do not translate well. Instead use "and so on" and "for example,". If you do use e.g. or i.e., then know that e.g. means "for example" and i.e means "in other words". With e.g., it is understood that there are more examples than just the ones listed; "The colors of the rainbow, e.g. red, yellow, and green". With i.e., however, it is intended as a replacement for the previous text. "The primary colors, i.e. red, blue, and yellow".
 
 Legal:: Use only to indicate that something is allowed because of a law. "RISC-V processors are legally available." Avoid using when something is allowed. Instead, use "valid".