Skip to content

Commit

Permalink
Publish documentation for v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
fadden committed Mar 5, 2024
1 parent dbcd243 commit b09f7f5
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 19 deletions.
16 changes: 8 additions & 8 deletions Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ or use one of these links to download a recent stable release:

System | Self-Cont'd? | Link
------------- | ------------ | ----
Windows x86 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x86_fd.zip
Windows x86 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x86_sc.zip
Windows x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x64_fd.zip
Windows x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x64_sc.zip
Mac OS x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_osx-x64_fd.zip
Mac OS x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_osx-x64_sc.zip
Linux x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_linux-x64_fd.zip
Linux x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_linux-x64_sc.zip
Windows x86 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x86_fd.zip
Windows x86 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x86_sc.zip
Windows x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x64_fd.zip
Windows x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x64_sc.zip
Mac OS x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_osx-x64_fd.zip
Mac OS x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_osx-x64_sc.zip
Linux x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_linux-x64_fd.zip
Linux x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_linux-x64_sc.zip

Once downloaded, unzip the file somewhere convenient (Safari on the Mac will do the unzip
for you). There is no installer; the commands are executed directly from where they are unzipped.
Expand Down
22 changes: 16 additions & 6 deletions docs/Manual-cp2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Contents:
- [Disk Image Sizes](#disk-image-sizes)
- [Filename Extensions](#filename-extensions)
- [Filesystem Types](#filesystem-types)
- [Import and Export](#import-and-export)
- [Export Specifications](#export-specifications)
- [Import Specifications](#import-specifications)
- [Resource Fork and Attribute Preservation](#resource-fork-and-attribute-preservation)
- [Finding Resource Forks](#finding-resource-forks)
- [Access Flags](#access-flags)
Expand Down Expand Up @@ -47,6 +48,10 @@ To reduce verbiage in this document, disk images and file archives are
collectively referred to as "archives" here. A distinction is made for
certain commands that only work with one or the other.

This file is the reference manual for the command-line application. A
tutorial, as well as information about the Windows GUI application, can be
found at https://ciderpress2.com/.

### Frequently Asked Questions ###

*Q*: How do I list the contents of a disk image or file archive?
Expand Down Expand Up @@ -1530,7 +1535,7 @@ The filesystems that may be formatted onto a disk image are:

Creation of Gutenberg, MFS, and RDOS disks is not supported.

### Import and Export ###
### Export Specifications ###

The export specification has the form `<conv-tag>[,name=value]...`. The
`conv-tag` specifies the converter to use, and the optional name/value pairs
Expand Down Expand Up @@ -1605,6 +1610,8 @@ Graphics:
- `macpaint`: MacPaint graphics document
- `psclip`: Print Shop clip art, monochrome and color
- `mult` (bool): true=multiplies pixels 2x horiz, 3x vert (default)
- `psfont`: Print Shop font
- `mult` (bool): true=multiplies pixels 2x horiz, 3x vert (default)
- `shr`: Apple IIgs super hi-res screen ($C1/0000)
- `shr3200`: Apple IIgs super hi-res 3200-color screen ($C1/0002)
- `shr3201`: Apple IIgs compressed super hi-res 3200-color screen
Expand Down Expand Up @@ -1635,6 +1642,8 @@ The result of the conversion takes one of the following forms:
- Formatted documents are output in Rich Text Format (.RTF).
- Spreadsheets and other cell-grid formats are output as Comma-Separated
Value (.CSV) files, UTF-8 encoded.
- Files that can be used on a modern system, such as GIF images and PDF
documents, are extracted without modification.

Specifying the special value `best` as the converter tag will analyze the file
and choose the conversion that seems most appropriate. It's not possible to
Expand All @@ -1646,11 +1655,12 @@ doesn't require the resource fork, e.g. a hex dump, the resource fork will be
ignored. The only exception to this is the `rsrc` converter, which just
formats the resource fork.

### Import Specifications ###

Import specifications work the same as export specifications, though there is
no `best` conversion. All attribute preservation parsing options (NAPS,
AppleSingle, etc.) will be disabled, because the input files are expected to
be host files.
Import specifications have the same form as export specifications (described
in the previous section), though there is no `best` conversion when importing.
All attribute preservation parsing options (NAPS, AppleSingle, etc.) will be
ignored, because the input files are expected to be host files.

The available converters are:
- `bas`: convert Applesoft BASIC listing back to a tokenized program (only
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ handful of top-level documents (like the project README and installation
instructions) are copied out of the `top` directory.

Some text variable substitutions can be performed on HTML and Markdown files
as they are copied, e.g. all occurrences of `1.0.0` will be replaced with
as they are copied, e.g. all occurrences of `1.0.1` will be replaced with
the current app version. This is used to update the links in the download
instructions (`Install.md`) to point at the current release.

Expand Down
2 changes: 2 additions & 0 deletions docs/cli-tutorial/export.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ <h2>Exporting Files</h2>
random-access text files.</li>
<li>PNG bitmap (.PNG). Used for all graphics.</li>
</ol>
<p>Files viewable directly on a modern system, such as GIF images and PDF documents,
will be extracted without modification.</p>

<p>You can't specify conversion options when using "best" mode, but you can set
defaults in the config file (more on that later).</p>
Expand Down
7 changes: 5 additions & 2 deletions docs/gui-manual/viewing.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,11 @@ <h2>Conversions</h2>
<li>Bitmap. Used for anything graphical. Exports as .PNG.</li>
</ol>
<p>Technically there is a fifth type, "host image", which is used for GIF, JPEG, and
PNG files. These can be displayed directly by the host system, so there's no need to
convert them first.</p>
PNG files. These can be displayed directly by the Windows application, so there's no
need to convert them first. For <code>.pdf</code>, <code>.rtf</code>, and Word documents
identified by HFS file type, the file will be extracted to a temporary file and displayed
with the system's default handler for the <code>.pdf</code>, <code>.rtf</code>, or
<code>.doc</code> filename extension.</p>

<p>The set of conversions that can be applied to a file are determined automatically,
and placed in the <samp>Conversion</samp> pop-up menu. They will be sorted by
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h4>Key features:</h4>

<p>
<a href="https://github.com/fadden/CiderPress2/releases/latest">
<b>Download</b> the latest release (1.0.0)</a> from github.</p>
<b>Download</b> the latest release (1.0.1)</a> from github.</p>

<h4>Free Software</h4>
<p>The full source code for CiderPress II is available on
Expand Down
2 changes: 1 addition & 1 deletion ndocs/publish.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


# Current version string. Used for text substitution.
app_version = "1.0.0"
app_version = "1.0.1"
pkg_version = app_version

# ----- nothing configurable below -----
Expand Down

0 comments on commit b09f7f5

Please sign in to comment.