MirrorRepos/RomWBW
1
0
Fork 1
mirror of https://github.com/wwarthen/RomWBW.git synced 2026-02-06 14:11:48 -06:00
Code Issues Projects Releases Wiki Activity

More Work on Document Creation Process

Browse Source 
- Replaced m4 with gpp
This commit is contained in:
Wayne Warthen
2021-10-21 20:18:02 -07:00
parent 475596b7b4
commit 149f84f64a
15 changed files with 75 additions and 739 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Source/Doc/Applications.md
View File

@@ -1,13 +1,14 @@
include(`Common.m4')
define({{doc_title}},{{Applications}})
\include{"Common.h"}
\define{doc_title}{Applications}
---
title: |
| doc_product doc_title
| \doc_product \doc_title
|
| Version doc_ver
author: doc_author (mailto:doc_authmail)
date: doc_date
institution: doc_orgname
| Version \doc_ver
author: \doc_author (mailto:\doc_authmail)
date: \doc_date
institution: \doc_orgname
documentclass: article
toc: true
toc-depth: 1
@@ -60,8 +61,8 @@ on the media.
Most of the applications are included as source code in the RomWBW
distribution and are built in the normal build process. The source
code is found in the Source\\Apps directory of the distribution. The
binary executable applications are found in the Binary\\Apps directory.
code is found in the Source\\\\Apps directory of the distribution. The
binary executable applications are found in the Binary\\\\Apps directory.
The following table clarifies where each of the applications can be
found:
@@ -555,7 +556,7 @@ manually perform a verification function with the `FLASH VERIFY` form
of the command.
The author's documentation for the application is found in the RomWBW
distribution in the Doc\\Contrib directory.
distribution in the Doc\\\\Contrib directory.
## Notes
@@ -984,6 +985,6 @@ The `TUNE` application was custom written for RomWBW. All of the
hardware interface code is specific to RomWBW. The sound file decoding
software was adapted and embedded from pre-existing sources. The YM
player code is from MYMPLAY 0.4 by Lieves!Tuore and the PT player code
is (c)2004-2007 S.V.Bulba <vorobey@mail.khstu.ru>.
is (c)2004-2007 S.V.Bulba <vorobey@@mail.khstu.ru>.
The source code is provided in the RomWBW distribution.

27
Source/Doc/Architecture.md
View File

@@ -1,13 +1,14 @@
include(`Common.m4')
define({{doc_title}},{{Architecture}})
\include{"Common.h"}
\define{doc_title}{Architecture}
---
title: |
| doc_product doc_title
| \doc_product \doc_title
|
| Version doc_ver
author: doc_author (mailto:doc_authmail)
date: doc_date
institution: doc_orgname
| Version \doc_ver
author: \doc_author (mailto:\doc_authmail)
date: \doc_date
institution: \doc_orgname
documentclass: book
classoption:
- oneside
@@ -44,14 +45,14 @@ header-includes:
\includegraphics[width=\paperwidth]{Graphics/Logo.pdf} \par
\vfill
\raggedleft
{\scshape \bfseries \fontsize{48pt}{56pt} \selectfont doc_product \par}
{\bfseries \fontsize{32pt}{36pt} \selectfont doc_title \par}
{\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 Version \doc_ver \\ \doc_date \par}
\vspace{24pt}
{\large \itshape doc_orgname \\ \href{http://doc_orgurl}{doc_orgurl} \par}
{\large \itshape \doc_orgname \\ \href{http://\doc_orgurl}{\doc_orgurl} \par}
\vspace{12pt}
{\large \itshape doc_author \\ \href{mailto:doc_authmail}{doc_authmail} \par}
{\large \itshape \doc_author \\ \href{mailto:\doc_authmail}{\doc_authmail} \par}
\end{titlepage}
}
\pagestyle{empty}
@@ -70,7 +71,7 @@ include-before:
```{=latex}
\clearpage
\pagenumbering{arabic}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill doc_product doc_title}}}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill \doc_product \doc_title}}}
```
Overview

6
Source/Doc/Build.cmd
View File

@@ -7,7 +7,7 @@ setlocal
::
set TOOLS=..\..\Tools
set PATH=%TOOLS%\m4;%PATH%
set PATH=%TOOLS%\m4;%TOOLS%\gpp;%PATH%
if not "%1"=="" (call :GenDoc %1 & goto :eof)
@@ -37,9 +37,9 @@ echo.
echo Processing document %1.md...
m4 -D doc_date="%date%" %1.md >%1.tmp
gpp -T <%1.md >%1.tmp
pandoc %1.tmp -f markdown -t latex -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 || exit /b
pandoc %1.tmp -f markdown -t html -o %1.html --default-image-extension=png || exit /b
pandoc %1.tmp -f markdown -t dokuwiki -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

19
Source/Doc/Catalog.md
View File

@@ -1,14 +1,15 @@
include(`Common.m4')
define({{doc_title}},{{Disk Catalog}})
define({{doc_author}},{{Mykl Orders}})
\include{"Common.h"}
\define{doc_title}{Disk Catalog}
\define{doc_author}{Mykl Orders}
---
title: |
| doc_product doc_title
| \doc_product \doc_title
|
| Version doc_ver
author: doc_author
date: doc_date
institution: doc_orgname
| Version \doc_ver
author: \doc_author
date: \doc_date
institution: \doc_orgname
documentclass: article
classoption:
- oneside
@@ -39,7 +40,7 @@ header-includes:
\pagestyle{fancyplain}
\fancyhf{}
\pagenumbering{arabic}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill doc_product doc_title}}}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill \doc_product \doc_title}}}
\lfoot{\small RetroBrew Computing Group ~~ {\xrfill[3pt]{1pt}[cyan]} ~~ \thepage}
```

8
Source/Doc/Common.h Normal file
View File

@@ -0,0 +1,8 @@
\define{doc_ver}{3.1 Pre-release}
\define{doc_product}{RomWBW}
\define{doc_title}{Document Title}
\define{doc_author}{Wayne Warthen}
\define{doc_date}{\date{%d %b %Y}}
\define{doc_authmail}{wwarthen@@gmail.com}
\define{doc_orgname}{RetroBrew Computers Group}
\define{doc_orgurl}{www.retrobrewcomputers.org}

25
Source/Doc/GettingStarted.md
View File

@@ -1,13 +1,14 @@
include(`Common.m4')
define({{doc_title}},{{Getting Started}})
\include{"Common.h"}
\define{doc_title}{Getting Started}
---
title: |
| doc_product doc_title
| \doc_product \doc_title
|
| Version doc_ver
author: doc_author (mailto:doc_authmail)
date: doc_date
institution: doc_orgname
| Version \doc_ver
author: \doc_author (mailto:\doc_authmail)
date: \doc_date
institution: \doc_orgname
documentclass: article
classoption:
- oneside
@@ -37,10 +38,10 @@ header-includes:
## Z80/Z180 System Software
| Version doc_ver
| doc_date
| Version \doc_ver
| \doc_date
doc_author [doc_authmail](mailto:doc_authmail)
\doc_author [\doc_authmail](mailto:\doc_authmail)
### Download
@@ -1141,7 +1142,7 @@ To cancel: Ctrl-X, pause, Ctrl-X
Thanks for the upload
E>flash write rom.rom
FLASH4 by Will Sowerbutts <will@sowerbutts.com> version 1.2.3
FLASH4 by Will Sowerbutts <will@@sowerbutts.com> version 1.2.3
Using RomWBW (v2.6+) bank switching.
Flash memory chip ID is 0xBFB7: 39F040
@@ -1383,4 +1384,4 @@ RetroBrew Computers projects is via the community forums:
Submission of issues and bugs are welcome at the
[RomWBW GitHub Repository](https://github.com/wwarthen/RomWBW).
Also feel free to email doc_author at [doc_authmail](mailto:doc_authmail).
Also feel free to email \doc_author at [\doc_authmail](mailto:\doc_authmail).

6
Source/Doc/Makefile
View File

@@ -1,7 +1,7 @@
#
# NOTE: Pandoc, Latex (MiKTeX or TexLive), and M4 must be installed
# NOTE: Pandoc, Latex (MiKTeX or TexLive), and gpp must be installed
# and available on commandline for this build to work!!!
# Typically "sudo apt install pandoc, texlive-latex-extra, M4"
# Typically "sudo apt install pandoc, texlive-latex-extra, gpp"
#
OBJECTS = GettingStarted.pdf GettingStarted.gfm GettingStarted.txt Applications.pdf Architecture.pdf Catalog.pdf ROM_Applications.pdf
# DEST = ../../Doc
@@ -13,7 +13,7 @@ include $(TOOLS)/Makefile.inc
all :: deploy
%.tmp : %.md
m4 -D doc_date="`date +"%d %b %Y"`" $< >$@
gpp -T $< >$@
%.pdf : %.tmp
pandoc $< -f markdown -t latex -s -o $@ --default-image-extension=pdf

19
Source/Doc/ROM_Applications.md
View File

@@ -1,14 +1,15 @@
include(`Common.m4')
define({{doc_title}},{{ROM Applications}})
define({{doc_author}},{{Phillip Summers}})
\include{"Common.h"}
\define{doc_title}{ROM Applications}
\define{doc_title}{Phillip Summers}
---
title: |
| doc_product doc_title
| \doc_product \doc_title
|
| Version doc_ver
author: doc_author
date: doc_date
institution: doc_orgname
| Version \doc_ver
author: \doc_author
date: \doc_date
institution: \doc_orgname
documentclass: article
toc: true
toc-depth: 1
@@ -129,7 +130,7 @@ Examples: `D 100 1FF`
0130: E5 CD 6C 1F C1 C1 E5 2A C9 8C E5 CD 45 05 E5 CD åÍl.ÁÁå*É.åÍE.åÍ
0140: 59 1F C3 00 00 C3 AE 01 C3 51 04 C3 4C 02 C3 57 Y.Ã..î.ÃQ.ÃL.ÃW
0150: 02 C3 64 02 C3 75 02 C3 88 02 C3 B2 03 C3 0D 04 .Ãd.Ãu.Ã..ò.Ã..
0160: C3 19 04 C3 22 04 C3 2A 04 C3 35 04 C3 40 04 C3 Ã..Ã".Ã*.Ã5.Ã@.Ã
0160: C3 19 04 C3 22 04 C3 2A 04 C3 35 04 C3 40 04 C3 Ã..Ã".Ã*.Ã5.Ã@@.Ã
0170: 48 04 C3 50 04 C3 50 04 C3 50 04 C3 8F 02 C3 93 H.ÃP.ÃP.ÃP.Ã..Ã.
0180: 02 C3 94 02 C3 95 02 C3 85 04 C3 C7 04 C3 D1 01 .Ã..Ã..Ã..ÃÇ.ÃÑ.
0190: C3 48 02 C3 E7 04 C3 56 03 C3 D0 01 C3 D0 01 C3 ÃH.Ãç.ÃV.ÃÐ.ÃÐ.Ã

2
Source/ver.inc
View File

@@ -2,4 +2,4 @@
#DEFINE RMN 1
#DEFINE RUP 1
#DEFINE RTP 0
#DEFINE BIOSVER "3.1.1-pre.128"
#DEFINE BIOSVER "3.1.1-pre.130"

2
Source/ver.lib
View File

@@ -3,5 +3,5 @@ rmn equ 1
rup equ 1
rtp equ 0
biosver macro
db "3.1.1-pre.128"
db "3.1.1-pre.130"
endm