Continuing Doc Update

Mostly done with User Guide now.

Source/Doc/Applications.md

@@ -1,5 +1,5 @@
 $define{doc_title}{Applications}$
-$include{"Common.h"}$
+$include{"Book.h"}$
 
 # Summary
 

Source/Doc/Basic.h

@@ -0,0 +1,47 @@
+$define{doc_ver}{Version 3.1 Pre-release}$
+$define{doc_product}{RomWBW}$
+$define{doc_root}{https://github.com/wwarthen/RomWBW/raw/dev/Doc}$
+$ifndef{doc_title}$ $define{doc_title}{Document Title}$ $endif$
+$ifndef{doc_author}$ $define{doc_author}{Wayne Warthen}$ $endif$
+$define{doc_date}{$date{%d %b %Y}$}$
+$ifndef{doc_authmail}$ $define{doc_authmail}{wwarthen@gmail.com}$ $endif$
+$define{doc_orgname}{RetroBrew Computers Group}$
+$define{doc_orgurl}{www.retrobrewcomputers.org}$
+$define{doc_user}{[RomWBW User Guide]($doc_root$/RomWBW User Guide.pdf)}$
+$define{doc_sys}{[RomWBW System Guide]($doc_root$/RomWBW System Guide.pdf)}$
+$define{doc_apps}{[RomWBW Applications]($doc_root$/RomWBW Applications.pdf)}$
+$define{doc_romapps}{[RomWBW ROM Applications]($doc_root$/RomWBW ROM Applications.pdf)}$
+$define{doc_catalog}{[RomWBW Disk Catalog]($doc_root$/RomWBW Disk Catalog.pdf)}$
+$define{doc_errata}{[RomWBW Errata]($doc_root$/RomWBW Errata.pdf)}$
+
+---
+title: $doc_product$ $doc_title$
+subtitle: $doc_ver$
+author: $doc_author$ ([$doc_authmail$](mailto:$doc_authmail$))
+date: $doc_date$
+institution: $doc_orgname$
+papersize: letter
+geometry:
+- top=1.5in
+- bottom=1.5in
+- left=1.5in
+- right=1.5in
+# - showframe
+# - pass
+fontsize: 12pt
+# linestretch: 1.25
+colorlinks: true
+# sansfont: helvetic
+sansfont: roboto
+# sansfont: bera
+# sansfont: arial
+monofont: roboto-mono
+# monofont: bera
+# monofont: inconsolata
+monofontoptions: 'Scale=0.75'
+header-includes:
+- |
+  ```{=latex}
+  \renewcommand*{\familydefault}{\sfdefault}
+  ```
+---

Source/Doc/Book.h

@@ -1,39 +1,15 @@
-$define{doc_ver}{3.1 Pre-release}$
-$define{doc_product}{RomWBW}$
-$define{doc_root}{https://github.com/wwarthen/RomWBW/raw/dev/Doc}$
-$ifndef{doc_title}$ $define{doc_title}{Document Title}$ $endif$
-$ifndef{doc_author}$ $define{doc_author}{Wayne Warthen}$ $endif$
-$define{doc_date}{$date{%d %b %Y}$}$
-$ifndef{doc_authmail}$ $define{doc_authmail}{wwarthen@gmail.com}$ $endif$
-$define{doc_orgname}{RetroBrew Computers Group}$
-$define{doc_orgurl}{www.retrobrewcomputers.org}$
+$include{"Basic.h"}$
 
 ---
 # Force pandoc to enable graphics for Logo in title page!
 graphics: true
-title: $doc_product$ $doc_title$
-author: $doc_author$ (mailto:$doc_authmail$)
-date: $doc_date$
-institution: $doc_orgname$
 documentclass: book
 classoption:
 - oneside
 toc: true
-toc-depth: 1
+toc-depth: 2
 numbersections: true
-secnumdepth: 1
-papersize: letter
-geometry:
-- top=1.5in
-- bottom=1.5in
-- left=1.5in
-- right=1.5in
-# - showframe
-# - pass
-linestretch: 1.25
-colorlinks: true
-fontfamily: helvet
-fontsize: 12pt
+secnumdepth: 2
 header-includes:
 - \setlength{\headheight}{15pt}
 - |
@@ -53,7 +29,7 @@ header-includes:
       {\scshape \bfseries \fontsize{48pt}{56pt} \selectfont $doc_product$ \par}
       {\bfseries \fontsize{32pt}{36pt} \selectfont $doc_title$ \par}
       \vspace{24pt}
-      {\huge Version $doc_ver$ \\ $doc_date$ \par}
+      {\huge $doc_ver$ \\ $doc_date$ \par}
       \vspace{24pt}
       {\large \itshape $doc_orgname$ \\ \href{http://$doc_orgurl$}{$doc_orgurl$} \par}
       \vspace{12pt}
@@ -63,7 +39,7 @@ header-includes:
   \pagestyle{empty}
   ```
 include-before:
-- \renewcommand{\chaptername}{Section}
+# - \renewcommand{\chaptername}{Section}
 - |
   ```{=latex}
   \pagestyle{fancyplain}
@@ -76,5 +52,5 @@ include-before:
 ```{=latex}
 \clearpage
 \pagenumbering{arabic}
-\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill $doc_product$  $doc_title$}}}
+\lhead{\fancyplain{}{\nouppercase{\bfseries \leftmark \hfill $doc_product$  $doc_title$}}}
 ```

Source/Doc/Build.cmd

@@ -35,23 +35,22 @@ goto :eof
 
 echo.
 
-echo Processing document %1.md...
+echo Processing document %1...
 
 ::gpp -o %1.tmp %1.md
 ::gpp -o %1.tmp -U "\\" "" "{" "}{" "}" "{" "}" "#" "" %1.md
 ::gpp -o %1.tmp -U "" "" "(" "," ")" "(" ")" "#" "" -M "#" "\n" " " " " "\n" "(" ")" %1.md
 gpp -o %1.tmp -U "$" "$" "{" "}{" "}$" "{" "}" "@@@" "" -M "$" "$" "{" "}{" "}$" "{" "}" %1.md || exit /b
 
-:: pandoc %1.tmp -f markdown -s -o %1.tex --default-image-extension=pdf || exit /b
-:: pause
-:: rem texify --pdf --clean %1.ltx || exit /b
-:: texify --pdf %1.tex || exit /b
-:: goto :eof
+::pandoc %1.tmp -f markdown -s -o %1.tex --default-image-extension=pdf || exit /b
+::::rem texify --pdf --clean %1.ltx || exit /b
+::texify --pdf --clean --engine=luatex --verbose %1.tex || exit /b
+::goto :eof
 
-pandoc %1.tmp -f markdown -t pdf -s -o %1.pdf --default-image-extension=pdf || exit /b
+pandoc %1.tmp -f markdown -t pdf -s -o %1.pdf --default-image-extension=pdf --pdf-engine=lualatex || exit /b
 pandoc %1.tmp -f markdown -t html -s -o %1.html --default-image-extension=png || exit /b
 pandoc %1.tmp -f markdown -t dokuwiki -s -o %1.dw --default-image-extension=png || exit /b
 pandoc %1.tmp -f markdown -t gfm -o %1.gfm --default-image-extension=png || exit /b
-pandoc %1.tmp -f markdown -t plain -s -o %1.txt --default-image-extension=png || exit /b
+pandoc %1.tmp -f markdown -t gfm-yaml_metadata_block -s -o %1.txt --markdown-headings=setext --default-image-extension=png || exit /b
 
 goto :eof

Source/Doc/Catalog.md

@@ -1,7 +1,7 @@
 $define{doc_title}{Disk Catalog}$
 $define{doc_author}{Mykl Orders}$
 $define{doc_authmail}{}$
-$include{"Common.h"}$
+$include{"Book.h"}$
 
 # RomWBW Distribution File Catalog
 

Source/Doc/Errata.md

@@ -1,5 +1,5 @@
 $define{doc_title}{Errata}$
-$include{"Common.h"}$
+$include{"Book.h"}$
 
 # Errata
 

Source/Doc/ROM_Applications.md

@@ -1,7 +1,7 @@
 $define{doc_title}{ROM Applications}$
 $define{doc_author}{Phillip Summers}$
 $define{doc_authmail}{}$
-$include{"Common.h"}$
+$include{"Book.h"}$
 
 # Summary
 

Source/Doc/ReadMe.md

@@ -1,21 +1,23 @@
 $define{doc_title}{ReadMe}$
-$include{"Common.h"}$
-$define{doc_user}{[RomWBW User Guide]($doc_root$/RomWBW User Guide.pdf)}$
-$define{doc_sys}{[RomWBW System Guide]($doc_root$/RomWBW System Guide.pdf)}$
-$define{doc_apps}{[RomWBW Applications]($doc_root$/RomWBW Applications.pdf)}$
-$define{doc_romapps}{[RomWBW ROM Applications]($doc_root$/RomWBW ROM Applications.pdf)}$
-$define{doc_catalog}{[RomWBW Disk Catalog]($doc_root$/RomWBW Disk Catalog.pdf)}$
-$define{doc_errata}{[RomWBW Errata]($doc_root$/RomWBW Errata.pdf)}$
+$include{"Basic.h"}$
+
+| $doc_product$ $doc_title$
+| $doc_ver$
+| $doc_author$  ([$doc_authmail$](mailto:$doc_authmail$))
+| $doc_date$
 
 # Overview
 
-RomWBW provides a complete software system for a wide variety of
-hobbyist Z80/Z180/Z280 CPU-based systems produced by these developer
-communities:
+RomWBW software provides a complete, commercial quality 
+implementation of CP/M (and workalike) operating systems and 
+applications for modern Z80/180/280 retro-computing hardware systems.
+A wide variety of platforms are supported including those
+produced by these developer communities:
 
 * [RetroBrew Computers](https://www.retrobrewcomputers.org)
 * [RC2014](https://rc2014.co.uk)
 * [retro-comp](https://groups.google.com/forum/#!forum/retro-comp)
+* [Small Computer Central](https://smallcomputercentral.com/)
 
 General features include:
 
@@ -25,7 +27,7 @@ General features include:
 * Video drivers including TMS9918, SY6545, MOS8563, HD6445
 * Keyboard (PS/2) drivers via VT8242 or PPI interfaces
 * Real time clock drivers including DS1302, BQ4845
-* Multiple OS support including CP/M 2.2, ZSDOS, CP/M 3, ZPM3, QPM, & p-System
+* OS Adaptations of CP/M 2.2, ZSDOS, CP/M 3, NZ-COM, ZPM3, QPM, p-System, and FreeRTOS
 * Built-in VT-100 terminal emulation support
 
 RomWBW is distributed as both source code and pre-built ROM and disk
@@ -37,12 +39,11 @@ ROM firmware itself:
 * ROM BASIC (Nascom BASIC and Tasty BASIC)
 * ROM Forth
 
-
 A dynamic disk drive letter assignment mechanism allows mapping
 operating system drive letters to any available disk media.
 Additionally, mass media devices (IDE Disk, CF Card, SD Card) support
 the use of multiple slices (up to 256 per device). Each slice contains
-a complete CP/M file system and can be mapped independently to any
+a complete CP/M filesystem and can be mapped independently to any
 drive letter. This overcomes the inherent size limitations in legacy
 OSes and allows up to 2GB of accessible storage on a single device.
 
@@ -67,24 +68,26 @@ such that all of the operating systems and applications on a disk
 will run on any RomWBW-based system.  To put it simply, you can take
 a disk (or CF/SD Card) and move it between systems transparently.
 
-A tool is provided that allows you to access a FAT-12/16/32 file system.
- The FAT file system may be coresident on the same disk media as RomWBW 
-slices or on stand-alone media.  This makes exchanging files with modern
- OSes such as Windows, MacOS, and Linux very easy.
+A tool is provided that allows you to access a FAT-12/16/32 filesystem.
+The FAT filesystem may be coresident on the same disk media as RomWBW slices
+or on stand-alone media.  This makes exchanging files with modern OSes
+such as Windows, MacOS, and Linux very easy.
+
+# Getting Started
 
 # Acquiring RomWBW
 
 The [RomWBW Repository](https://github.com/wwarthen/RomWBW) on GitHub is
-the official distribution location for all project source and 
-documentation.  The fully-built distribution releases are available on 
-the [RomWBW Releases Page](https://github.com/wwarthen/RomWBW/releases) 
-of the repository.  On this page, you will normally see a Development 
-Snapshot as well as recent stable releases. Unless you have a specific 
-reason, I suggest you stick to the most recent stable release. Expand 
+the official distribution location for all project source and
+documentation.  The fully-built distribution releases are available on
+the [RomWBW Releases Page](https://github.com/wwarthen/RomWBW/releases)
+of the repository.  On this page, you will normally see a Development
+Snapshot as well as recent stable releases. Unless you have a specific
+reason, I suggest you stick to the most recent stable release. Expand
 the "Assets" drop-down for the release you want to download, then select
-the asset named RomWBW-vX.X.X-Package.zip. The Package asset includes 
+the asset named RomWBW-vX.X.X-Package.zip. The Package asset includes
 all pre-built ROM and Disk images as well as full source code. The other
-assets contain only source code and do not have the pre-built ROM or 
+assets contain only source code and do not have the pre-built ROM or
 disk images.
 
 All source code and distributions are maintained on GitHub. Code
@@ -92,10 +95,10 @@ contributions are very welcome.
 
 # Installation & Operation
 
-In general, installation of RomWBW on your platform is very simple. You 
+In general, installation of RomWBW on your platform is very simple. You
 just need to program your ROM with the correct ROM image from the RomWBW
-distribution.  Subsequently, you can write disk images on your disk 
-drives (IDE disk, CF Card, SD Card, etc.) which then provides even more 
+distribution.  Subsequently, you can write disk images on your disk
+drives (IDE disk, CF Card, SD Card, etc.) which then provides even more
 functionality.
 
 Complete instructions for installation and operation of RomWBW are
@@ -128,10 +131,10 @@ please let me know if I missed you!
   derived and he has always been a great source of knowledge and
   advice.
 
-* Douglas Goodall contributed code, time, testing, and advice in  "the 
-  early days". He created an entire suite of application programs to   
+* Douglas Goodall contributed code, time, testing, and advice in  "the
+  early days". He created an entire suite of application programs to
   enhance the use of RomWBW. Unfortunately, they have become unusable
-  due  to internal changes within RomWBW. As of RomWBW 2.6, these 
+  due  to internal changes within RomWBW. As of RomWBW 2.6, these
   applications are no longer provided.
 
 * David Giles created support for the Z180 CSIO which is now included
@@ -144,6 +147,13 @@ please let me know if I missed you!
   AY-3-8910 sound driver as well as a long list of general code
   enhancements.
 
+* Spencer Owen created the RC2014 series of hobbyist kit computers
+  which has exponentially increased RomWBW usage.
+
+* Stephen Cousins has likewise created a series of hobbyist kit
+  computers at Small Computer Central and is distributing RomWBW
+  with many of them.
+
 * Phillip Stevens contributed support for FreeRTOS.
 
 * Curt Mayer contributed the original Linux / MacOS build process.

Source/Doc/SystemGuide.md

@@ -1,5 +1,5 @@
 $define{doc_title}{System Guide}$
-$include{"Common.h"}$
+$include{"Book.h"}$
 
 Overview
 ========
@@ -406,6 +406,16 @@ bits are defined as YXXXX.
 
 ### Function 0x00 -- Character Input (CIOIN)
 
+| **Inputs**                             | **Outputs**                            |
+|----------------------------------------|----------------------------------------|
+| B: 0x00 | A: Status (0-OK, else error) |
+| C: Serial Device Unit Number | E: Character Received |
+| C: Serial Device Unit Number | E: Character Received |
+| C: Serial Device Unit Number | E: Character Received |
+
+
+
+
 | _Entry Parameters_
 |       B: 0x00
 |       C: Serial Device Unit Number