simplify anchors and xrefs

This commit is contained in:
Christopher A. Mosher 2015-07-16 20:54:10 -04:00
parent c4ad3ef686
commit 078d790c9b
7 changed files with 35 additions and 23 deletions

View File

@ -1,3 +1,5 @@
anchor:building[]
== Building From Source

View File

@ -1,4 +1,4 @@
[[cards]]
anchor:cards[]
=== Peripheral Cards
@ -18,9 +18,9 @@ slot 6 disk
import slot 6 rom 0 /usr/lib/apple2/dos3x/16sector/controller/disk2.ex65
--------
The first line uses the <<_slot,slot>> command to
The first line uses the <<slot>> command to
insert a disk contoller card into slot 6, which is the standard
slot used for disk cards. The next line uses the <<_import,import>>
slot used for disk cards. The next line uses the <<import>>
command to load the card's ROM with the disk controller
firmware. This firmware is known as the ``bootstrap'' or ``P5'' ROM code.
It is seen by the Apple ][ at memory addresses $Cs00-$CsFF, where s is the
@ -29,7 +29,7 @@ at $C600-$C6FF). The firmware is copyright by Apple, and is available from
the http://mosher.mine.nu/apple2/[Apple II Library].
You can also load a floppy disk image (nibble format) into the drive,either by putting
the <<_load,load>> command into the +epple2.conf+ file, or by using the command prompt
the <<load>> command into the +epple2.conf+ file, or by using the command prompt
in the emulator (+F5+ key). For example, you could load the DOS 3.3 system master into
slot 6, drive 1, with this command

View File

@ -1,3 +1,5 @@
anchor:cassette_tape[]
=== Cassette Tape Interface
The Apple ][ and Apple ][ plus machines had the ability to save and load binary

View File

@ -1,6 +1,12 @@
anchor:commands[]
=== Commands
+<<_slot,slot>> <<_import,import>> <<_load,load>> <<_unload,unload>> <<_save,save>> <<_cassette,cassette>> <<_revision,revision>>+
+<<slot>> <<import>> <<load>> <<unload>> <<save>> <<cassette>> <<revision>>+
anchor:slot[]
==== slot
@ -12,7 +18,7 @@ slot <slot> <card>
+<slot>+ Slot number, 0 through 7, to insert the card into.
+<card>+ The type of <<cards,card>> to insert into the slot:
+<card>+ The type of card to insert into the slot (see <<cards>>):
* +language+
* +firmware+
@ -39,6 +45,8 @@ The emulated Apple should be _powered off_ before inserting or removing cards.
anchor:import[]
==== import
The +import+ command imports a binary image file into the emulated Apple's memory.
@ -79,7 +87,7 @@ p. 5-26 ``The 16K RAM Card'').
anchor:load[]
==== load
@ -113,7 +121,7 @@ for Windows (but it supposedly runs under Wine on Linux, too). Thanks to Andy Mc
anchor:unload[]
==== unload
@ -134,7 +142,7 @@ If the disk has been modified but not saved, the modifications will be DISCARDED
anchor:save[]
==== save
@ -158,7 +166,7 @@ next to the file-name of a disk image if it has any unsaved changes.
anchor:cassette[]
==== cassette
@ -176,13 +184,12 @@ cassette save
+<file-path>+ File path of the (special format) cassette tape image file.
The +cassette+ command allows the user to control the emulated cassette tape player.
See <<_cassette_tape_interface,Cassette>> for more information about operating the emulated
See <<cassette_tape>> for more information about operating the emulated
cassette player and cassette tape image files.
anchor:revision[]
==== revision

View File

@ -26,7 +26,7 @@ the distribution package is built.
You can specify a different configuration file for the emulator to use by
specifying its name as the argument when running the epple2 program.
The format of the configuration file is just lines of <<_commands,commands>>.
The format of the configuration file is just lines of <<commands>>.
Comments begin with a hash +#+ character, and continue to the end of the line.
=== Firmware
@ -34,9 +34,9 @@ Comments begin with a hash +#+ character, and continue to the end of the line.
Firmware, commonly called ROM images or ROMs, will need to be loaded
into the emulated ROM areas of the emulated Apple
in order for it to be able to boot the emulated Apple machine.
The firmware available is described <<firmware,above>>.
The <<firmware>> available is described above.
Once the firmware image
files are installed on your computer, you can use the <<_import,import>>
files are installed on your computer, you can use the <<import>>
command in the configuration file to load the image files into the emulator.
=== Peripheral Cards
@ -45,8 +45,8 @@ Another primary concern for configuring the Epple ][ is the insertion of
peripheral cards into the Apple's slots. The most useful card is probably the
Disk ][ Controller card; you will need to insert one of these cards if you want
to be able to load floppy disk images into the emulated Apple. The various
types of cards available are described on the <<cards,peripheral cards>> section.
You can use the <<_slot,slot>> command in the configuration file to insert
types of cards available are described in the <<cards>> section.
You can use the <<slot>> command in the configuration file to insert
them into the Apple's slots.
=== Sample Configuration Files

View File

@ -16,7 +16,7 @@ http://www.gnu.org/licenses/gpl-3.0-standalone.html[GPLv3].
Epple ][ Program:: link:download/epple2-{VERSION}.tar.gz[epple2-{VERSION}.tar.gz]
See <<_building_from_source,Building>> on how to build from sources.
See <<building>> on how to build from sources.
Source code is hosted on github:
https://github.com/cmosher01/Epple-II/[Epple-II]
@ -28,12 +28,13 @@ https://github.com/cmosher01/Epple-II/[Epple-II]
The _Epple ][ Program_ package is the emulator itself, which emulates the
Apple ][ or Apple ][ plus _hardware_, as well as the
<<cards,peripheral card>> hardware. This is the main program, so you will
<<cards>> hardware. This is the main program, so you will
certainly need to download this package. To have a full functioning emulator,
you will also need System ROMs and Card ROMs, as described in the following
sections.
[[firmware]]
anchor:firmware[]
=== System ROMs&mdash;The Main System Firmware (Demo or Real)
Since the Epple ][ program emulates only the hardware, you will also need to download some _system software_
@ -65,7 +66,7 @@ from the http://mosher.mine.nu/apple2/[Apple II Library].
not the Demo System ROM.)
If you are using any of the clock, the standard output, or the
standard input <<cards,peripheral cards>>, you will need to download their firmware as well,
standard input <<cards>>, you will need to download their firmware as well,
which are contained in the _Card ROMs_ package. You can choose either binary format
(ready to run) or source format (to assemble it yourself using the
http://www.floodgap.com/retrotech/xa/[xa Assembler]).

View File

@ -58,4 +58,4 @@ The file will be in the default directory, named +ep2_YYYYMMDDHHMMSS.bmp+.
[WARNING]
If you have modification to any floppy images or cassette images, and you
press the +End+ key, you will LOSE all those changes, unless you
save them first. See <<_commands,Commands>> for the +save+ command.
save them first. See <<commands>> for the +save+ command.