💾 Archived View for mirrors.apple2.org.za › active › ftp.apple.asimov.net › asm › asm-template.txt captured on 2023-01-29 at 03:33:12.
View Raw
More Information
-=-=-=-=-=-=-
=============================================================================
Apple Software Map Entry Template
=============================================================================
The Apple Software Map is an attempt to catalog and organize the disk
images, emulators, utilities, and other paraphenalia in the ftp.asimov.net
archive. This template is based on the Linux Software Map, and thanks must
be extended to the LSM crew for their hard work in developing the concept
and the tools.
By filling out the ASM and sending it in, you are helping to keep the
archive organized, and increase the speed and ease of archive maintenance.
No uploads to ftp.asimov.net will be accepted without an ASM template.
=============================================================================
Instructions
=============================================================================
Any templates for new entries or modifications to existing entries should be
sent to asm-template@asimov.net. If they are correctly formatted, they will
be automatically added to the ASM, and you will receive e-mail to that
effect. If there is some problem, the template will be returned to you,
with the problems marked.
- PLEASE* use the entry template at the end when submitting information.
It has been designed so that all you have to do is fill in the blanks
and send it in as is. Your entry will be read into the database
directly from your email response with little if any hand manipulation.
DO NOT RENAME FIELDS. DO NOT REMOVE THE BEGIN OR END MARKERS. There
are no longer any limits on the fields lengths, but please try to be
short.
Complete as many fields as possible. You must fill in at least the Title,
Version, Entered-date, Description, and Primary-site fields.
Make any corrections to an existing entry that are necessary. The
initial data came from a variety of sources, and is not at all assumed
to be correct. Remember to update the Entered-date field if you update
an existing entry.
Thank you VERY much for your time and enthusiasm. Your contribution
will help to ensure that the Apple Software Map will continue to be a
trusted Apple resource.
=============================================================================
The ASM Entry Form
=============================================================================
The general syntax is now similar to that of netnews headers, i.e., a
keyword (at the beginning of a line), a colon (with no spaces separating
it from the keyword), and text that may be continued to the next line by
starting each continuing line with whitespace (space, tab). Empty lines
are also allowed (unlike netnews). Since fields may be several lines
long, there is no longer a separate keyword for each line (we now have
one "Description" keyword, where the older versions had "Desc1",
"Desc2", and so on).
There are no limits on the line lenght or the number of lines for one
keyword, but please try to be short, especially in the description. Please
keep each line (including keyword) below 80 characters for maximal viewing
comfort. Use a tab width of 8 spaces, or don't use tabs at all.
Mandatory fields: Title, Version, Entered-date, Description, Primary-site.
Descriptions of the fields (an empty form is included at the end; use that
to fill in).
PLEASE NOTE THAT THE "Begin3" AND "End" LINES ARE ESSENTIAL. IF YOU
REMOVE THEM, THE ENTRY WILL BE USELESS AND WILL REQUIRE MANUAL EDITING
BY ME AND I DON'T WANT TO DO THAT.
Note that case is significant.
Begin3
Title: The name of the package.
Author: The author of the package. This could be a corporation (IE
SSI, Origin, etc.)
Version: Version number or other designation. Use a date if
nothing else is appropriate. For most disk images, the
version and entered-date will be identical.
Entered-date: Date of when the ASM entry was last modified. Note that
you should fill in both Version and Entered-date.
Description: Short description of the package.
Keywords: A short list of carefully selected keywords that describe
the package.
Uploader: Uploader of package. In RFC822 format (i.e.,
something that will fit into a From: or To: header of a
normal Internet mail message). Preferred format:
mailname@site.domain.top (Full name)
Other formats will be converted to this format, if time
and energy of the ASM maintainer will allow it.
Primary-site: A specification of on which site, in which directory,
and which files are part of the package. First line
gives site and base directory, the rest give the sizes
and names of all files. Names are either relative to
the base directory, or full pathnames. If the ftp
site does not use Unix style pathname syntax, then
the full pathname must be given every time. The pathname
must not contain spaces. Example:
Primary-site: ftp.asimov.net /pub/apple_II/images/games/action
10kB fun_disk1.dsk.gz
12kB fun_disk2.dsk.gz
The file size may be given in bytes (no suffix), kilobytes
(k, kb), or megabytes (M, MB). The suffix may be separated
with spaces, and may be in upper case or lower case. The
size can be left off.
For very large packages that are contained within
one directory (say, a distribution), only the directory
need be listed. Adding a trailing slash makes it clear
that it is a directory.
The filename should be the final location, not an
"incoming" directory. If you don't know the final
location, at least make a good guess (since files _will_
be moved from incoming, it is not a good guess).
Platform: For disk images, note the original platform that this was
developed for (Apple ][/Apple ][+/Apple //e). If it is an
emulator, utility, etc. please note the machine that it is
intended to run on (Macintosh, IBM PC, Unix etc.)
End
=============================================================================
Empty Template
=============================================================================
Cut this out, fill it in, send it to me.
Begin3
Title:
Author:
Version:
Entered-date:
Description:
Keywords:
Uploader:
Primary-site:
Platform:
End