@database AID.guide @$VER: AID Documentation 1 - 30 Oct 95 @author "Lorenzo Colloreta - " @(c) "1995 LcS" #STD RULER @{fg shine}@{u} @{uu}TITLE TO 55 CHARS@{u} @{uu}@{fg text} ## #STD FOOTER @{u} @{" Main Menu " link main} @{uu} @node "Main" "AID - Amiga Ideas Database" @next about =@ @{b}WELCOME TO@{ub} $###= @{b}----------@{ub}+ +@######. A I D >#######> ######$ Amiga Ideas Database @$.< @{b}------------------------@{ub} . %#@- Official Documentation =. +##$>>>=- .+>%###$.+@###% =% -###################. %#####@- >#%. .@#################= .@#######> Document Revision @##@. #################$ %##########- @{b}30-Oct-95@{ub} .####> $################$ %##########@ +####@ .################$ %###########= Written by >#####> $###############= %###########% Lorenzo Colloreta @#####@ -###############- %###########@ >#######= %############## @###########@ @{b}--------------------@{ub} -########@ +#############> -@###########% @{" About this guide " link about} $########@ #############. $############> @{" Distribution note " link "distribution" 0} .##########+ @###########$ @###########@ +##########> $###########- +############> @{" Introduction " link "intro"} >##########@ >##########@ %###########@ @{" Structure " link structure} =############- .######### @#########= @{" AID Databases " link databases} %#############- .########= =##########- @{" What " link what} @{" How " link how} =##############. #######$ -########@+ @{" Where " link where} to post... -###$ .%###. ######> .########> ++ -#- .####= @#####> @{" AID Standard " link standard} +. -##% >###%. @{" Request Forms " link forms} $#> -##@- @{" Quick Reminder " link reminder} @= >#$ @{" The future " link future} - $+ @{" About the author " link author} @endnode @node "distribution" "AID - Distibution notes" @{fg shine}@{u} @{uu}DISTRIBUTION AND LEGAL NOTES@{u} @{uu}@{fg text} This guide, the AID archive and related files are considered @{b}PUBLIC DOMAIN,@{ub} and they can freely spread without any fee. No modification of the files should occur, and any request or additional info should be posted to the maintainers of AID, in the ways suggested in this guide (see posting rules section). AID files can be freely spread and uploaded into electronic BBS systems or Internet sites, but please DO NOT upload these files where they already exist, especially on Aminet sites and newsgroups used for AID distribution. For any updated information about AID distribution just feel free to contact me, or any other AID maintainer. @{u} @{" Introduction " link intro} @{" Main Menu " link main} @{uu} @endnode @node "intro" "AID - Introduction" @next structure @prev distribution @{fg shine}@{u} @{uu}INTRODUCTION@{u} @{uu}@{fg text} AID stands for Amiga Ideas Database, it is supposed to become a wordwide meeting point for good programmers and good ideas. Fortunately the Amiga community has always been different from others systems users groups, as we share an unbeatable passion and affection for our beloved machine, followed by a great force in developing PD and Shareware software as well with strong efforts to collect and distribute it worldwide (I'm thinking of Aminet and other sources). All this didn't stop even during the big Commodore's crisis, as to demonstrate the unique power of Amiga users. AID is a link between Amiga Users, ideas and programming skill. I know the last two things don't always go together, so there could be someone who need a particular program or script but doesn't know how to do it (or where to get it) or a good programmer losing time searching for some good idea to develope. AID is a database where you can find IDEAS coming from people who need it, and, possibly, coming from other people, about similar programs already existing, or programs just written for the occasion by someone. So why don't we simply create a new newsgroup dedicated only to Amiga-Ideas? Well, I know newsgroups are a great place to look for help, but I found them very dispersing, they also need to be browsed periodically, and old messages may be discarded. Items are sorted by difficulty, by type (conventional program, Arexx script, Scala (tm) script, AmigaDOS script...), and should contain as much information as possible to describe what the user need. Replies containing suggestions about software have to be posted to the user who posted the request AND to the database itself. Items lasting on the database for more than a specified time (let's say about two months), will be moved into a not-recent database, as to maintain the main file more comfortable to handle. Programs and script realized specifically due to AID requests will be listed into another file. The AID archive could be maintained in several formats, allowing the wider distribution possible. The first phase of the distribution will be just via "rich-ascii" file, following AID @{" Standard " link standard}. @{u} @{" Structure " link structure} @{" Main Menu " link main} @{uu} @endnode @NODE about "About" @next distribution @prev main @{fg shine}@{u} @{uu}ABOUT THIS GUIDE@{u} @{uu}@{fg text} This guide contains all the information about the AID project, including instructions to read the database and to post requests. A shorter FAQ text which summarizes AID features is also available. Any updated info will be released mainly via: · the @{" AID WEB PAGE " link web} · Aminet (DOCS/MISC) · Amiga newsgroups Any kind of feedback can be posted to @{" the author " link author} via email or snail mail. >>> GERMAN USERS: You can obtain German docs and ask questions in German directly to @{b}Andreas Spreen@{ub}, German coordinator of AID. Email: andi@miglos.cadlab.de WEB : http://www.cadlab.de/~andi/ I hope you'll like this idea. The future of this project depends on YOU. Happy reading!... Lorenzo @{u} @{" Distribution " link distribution} @{" Main Menu " link main} @{uu} @ENDNODE @NODE web "Web page" @{fg shine}@{u} @{uu}AID WEB HOMEPAGE @{u} @{uu}@{fg text} AID has a homepage on the World Wide Web: · @{b}http://www.zen.it/~lcs/aid.html@{ub} · If you have web access refer to this page for any updated news and for downloading files containing documentation and AID archives. @{u} @{" Main Menu " link main} @{uu} @ENDNODE @NODE structure "AID Structure" @prev introduction @next databases @{fg shine}@{u} @{uu}AID STRUCTURE@{u} @{uu}@{fg text} Amiga Ideas Database is composed by documentation files and database files, mostly released in LHA format, conventional names identify the content of each file. - AID-faq : The Frequently Asked Questions text - AID-docs : The full AID documentation (This file) (Amigaguide and txt format) - AID-n : The main AID requests archive, where "n" is the release number - AID-goals : Archive containing software developed due to specific AID requests - AID-store : Comprehensive archive of all "old" AID requests since the first release - AID-ware : Will include any special software released for use with AID archives, such as browsers, search tools and similar. AID requests archive will be updated and released frequently, older requests will be moved to the store database, making the main database easier to handle. Requests archives are released in Amigaguide and plain ascii format. Further releases will include special formats for use with browsers and search tools, see AID @{" future " link future} page. @{u} @{" Databases " link databases} @{" Main Menu " link main} @{uu} @ENDNODE @NODE what "Use of AID" @prev databases @{fg shine}@{u} @{uu}HOW TO USE AID: WHAT@{u} @{uu}@{fg text} There are three main types of messages you can post to AID maintainers: - @{b}Software Request@{ub}: idea suggesting a software that it is supposed NOT EXISTING in the Amiga PD/Shareware or even commercial software pool. Types of software include: ·conventional programs (executable) ·AmigaDOS/Arexx/Scala(tm) scripts ·Libraries and devices ·Any language source code ·etc - @{b}Answer to request@{ub}: If you developed or plan to develope a software following an AID request, you should let us know, and your name will be included in the database - @{b}Software information@{ub}: If an AID request refers to an already EXISTING program you should let us know, specifying the program name and possible Internet download site(s). @{u} @{" How " link how} @{" Where " link where} @{" Main Menu " link main} @{uu} @ENDNODE @NODE how "Use of AID" @{fg shine}@{u} @{uu}HOW TO USE AID: HOW@{u} @{uu}@{fg text} @{b}POSTING REQUESTS@{ub} To send a request, first of all THINK TWICE on it :) then just fill in the forms you can find @{" here " link forms} and send them via email or snail mail. Any other kind of request will take much more time to be processed. If you are sending info related to an existing AID request, you should send the same message to the sender of the original request too, especially if you're announcing the development of a new software. Here's a @{" quick reminder " link reminder} for you, read it before posting. @{b}FEEDBACK FROM AID@{ub} As soon as your request has been processed you will receive an acknowledge message (email only!), even if your request cannot be included into the database. @{b}REJECTED REQUESTS@{ub} Requests may be rejected if: - There is existing PD/Shareware software with the SAME specifications of the request - The request is too general and cannot help developing new software - The request is not clearly explained - Any other reason making it difficult to understand @{u} @{" Where " link where} @{" <- What " link what} @{" Main Menu " link main} @{uu} @ENDNODE @NODE where "Use of AID" @next standard @{fg shine}@{u} @{uu}HOW TO USE AID: WHERE@{u} @{uu}@{fg text} · @{b}EMAIL@{ub}: @{b}lcs@zen.it@{ub} ========== ATTENTION: "Subject:" field should start with "@{b}AID-request@{ub}" =========== · @{b}SNAIL MAIL@{ub}: (May take long time!) AID Lorenzo Colloreta Via A Calugi 9 - loc.Pontelungo 51030 Pistoia ITALY · @{b}German users@{ub} Address German emails and forms directly to @{b}Andreas Spreen@{ub}, email: andi@miglos.cadlab.de @{u} @{" Standard " link standard} @{" Main Menu " link main} @{uu} @ENDNODE @NODE databases "AID Databases" @next what @prev introduction @{fg shine}@{u} @{uu}THE AID DATABASES@{u} @{uu}@{fg text} @{b}HOW TO GET THEM@{ub} You can obtain AID databases thru distribution sites: · @{" WEB Homepage " link web} · Aminet sites: directory DOCS/MISC · Usenet (not always): comp.sys.amiga.misc comp.sys.amiga.programmer · Directly by emailing me (lcs@zen.it) · A mailing list is supposed to start soon, it will depend on feedback @{b}DATA FORMATS@{ub} AID main archives are updated by maintainers in a "rich-ascii" file following AID standard. Released files are generated from the rich-ascii and converted into many formats. Formats currently available are: · Standard plain ascii · Amigaguide doc New formats will be available soon (see the @{" future " link future}), allowing users to search the archive for specific topics and perform automatic operations such as auto-downloading most recent databases directly from the Net. We plan to release a specific AID browser soon, any news will be reported in the @{" Web homepage " link web}. @{u} @{" What to post " link what} @{" Main Menu " link main} @{uu} @ENDNODE @NODE author "Author" @next author @prev future @{fg shine}@{u} @{uu}ABOUT ME@{u} @{uu}@{fg text} Please feel free to send any feedback, suggestion, idea, complaint to me, AID future will depend on you!! email: @{b}lcs@zen.it@{ub} WWW: http://www.zen.it/~lcs/index.html snail mail: Lorenzo Colloreta Via A.Calugi 9 - Loc.Pontelungo 51030 Pistoia ITALY phone: ++39 573 572058 (Fax on demand) @{u} @{uu} I wish to thank everyone who is contributing to this project, in particular @{b}Andreas Spreen@{ub} for his support, @{b}Udo Schuermann@{ub}, author of "KingFisher", for helping me converting AID database into kingfisher data (format available soon). Thanks to everyone at @{b}IAS, International Amiga Society@{ub}, take a look at our web page to find out info about this important group: http://snark.apana.org.au/IAS/Workbench/ias.html @{u} @{uu} ENJOY!! @{i}I thought it was easier...@{ui};) @{u} @{" Main Menu " link main} @{uu} @ENDNODE @NODE future "AID Future" @prev reminder @next author @{fg shine}@{u} @{uu}AID: THE FUTURE@{u} @{uu}@{fg text} First of all, @{b}AID future will depend on feedback@{ub} and suggestions from users, so feel free to contact us. We will release new formats for databases as soon as possible, and we plan to have soon a specific AID-browser, which will be able to perform several actions: · Search thru the database · Automatically download new databases from the net · Assist filling in forms for posting requests · Converting the rich ascii format into various standards · Automatically download (thru ftp) software announced in AID database (if URL is included) · .. and many many more If you are interested in writing an AID browser please let us know! Thanks to International Amiga Society we have the possibility to build up a mailing list for AID databases, email us if you need it and we'll try to set it up soon. Any other good suggestion and idea will be included into AID project, so just @{" contact us " link author}. @{u} @{" Author " link author} @{" Main Menu " link main} @{uu} @ENDNODE @NODE reminder "Reminder" @next future @prev forms @{fg shine}@{u} @{uu}QUICK REMINDER BEFORE POSTING@{u} @{uu}@{fg text} Pay attention here before posting your request: =============================================== · If you sent a new software request: are you SURE what you are looking for does not exist?. Remember to take a look at Aminet · Did you fill in the correct form according to info you want to send us? · Is the form correctly filled? Remember some fields are obligatory, some others may contain just a single 70 char line · Did you include all correct info and your address(es)? · Does the "Subject:" field of your email start with "AID-request"? · If you're sending an answer to an AID request, did you contact the author of the request as well? · If you're not sure about info you're posting, contact us @{u} @{" Future " link future} @{" Main Menu " link main} @{uu} @ENDNODE @NODE forms "Forms" @prev standard @next reminder @{fg shine}@{u} @{uu}AID FORMS FOR POSTING@{u} @{uu}@{fg text} In order to post a request you can take a look at the AID @{" standard " link standard} section.. @{b}Instructions@{ub}: select the correct form you need, according to information you want to send us, cut the text between the "cut here" markers and edit/delete the comment lines starting with "#". Fields with [++] in comment line may accept MORE than one line, other fields must contain @{b}less than 71@{ub} chars on a single line. Include it in a mail message and post it to lcs@zen.it ("Subject" must start with "AID-request"). Thank you. Choose the form according to the information you want to send us: @{" New software request (IDEA) " link fidea} @{" Info on existing software " link fexist} @{" Answer to AID request " link fanswer} @{u} @{" We remind you.. " link reminder} @{" Main Menu " link main} @{uu} @ENDNODE @NODE fidea "Forms" ** FORM TO POST A SOFTWARE REQUEST (IDEA) -----CUT HERE---------------------------- @IDEA .FROM #insert your full name here .EMAIL #insert your email address here (if any) .SHORT #program description in ONE line (70 chars) .FULL #full program description [++] #Optional fields, remove a field if you don't use it .MAIL #contact addresses different from email [++] .TITLE #supposed title, just for easy searching and linking .DIFFICULTY #Supposed difficulty. from 0 (easy) to 10 (hardest) .TYPE #Type of software (see standard) .SIMILAR #similar existing softwares [++] .FEATURES #all main desired features [++] .NOTES #Whatever you may want to say [++] .LINKS #If any, links to other previous AID requests [++] -----CUT HERE---------------------------- @{u} @{" Next Form " link fexist} @{" Main Menu " link main} @{uu} @ENDNODE @NODE fexist "Forms" **FORM TO POST INFO ABOUT EXISTING SOFTWARE -----CUT HERE---------------------------- @INFO .FROM #insert your full name here .EMAIL #insert your email address here (if any) .IDLINK #insert ID number(s) of related AID item(s) separated by #commas .SIMILAR #all info about similar software (even commercial), possibly #with downloading information (URL/filename) [++] #Optional fields, remove the field if you don't use it .NOTES #Whatever you may want to say [++] .MAIL #contact addresses different from email [++] -----CUT HERE---------------------------- @{u} @{" Next Form " link fanswer} @{" Main Menu " link main} @{uu} @ENDNODE @NODE fanswer "Forms" **FORM TO POST ANSWERS TO REQUESTED SOFTWARE -----CUT HERE---------------------------- @ANSWER .FROM #insert your full name here .EMAIL #insert your email address here (if any) .IDLINK #insert ID number of related AID item .ANSWER #answer to request (eg. "I'm developing it!") [++] #Optional fields, remove the field if you don't use it .NOTES #Whatever you may want to say [++] .MAIL #contact addresses different from email [++] -----CUT HERE---------------------------- @{u} @{" Reminder " link reminder} @{" Main Menu " link main} @{uu} @ENDNODE @NODE standard "AID standard" @next forms @prev where @{fg shine}@{u} @{uu}AID: THE STANDARD@{u} @{uu}@{fg text} The following pages contain quite technical information about AID standard for "rich-ascii" files. It is very similar to Fred Fish "Product-info" one, with field names starting with a period and the next line(s) containing field contents. In order to send a request to AID it is recommended to take a brief look at field names and usage. @{" Header and conventions " link head} @{" Fields " link fields} @{u} @{" Forms " link forms} @{" Main Menu " link main} @{uu} @ENDNODE @NODE head "Header standard" @{fg shine}@{u} @{uu}AID: THE STANDARD@{u} @{uu}@{fg text} Main conventions are: · Lines contain 70 chars · Lines starting with "@{b}#@{ub}" are treated as comments AID files header contains: @{b}#AID @{ub} : Identifies AID database @{b}#Version: n @{ub} : Standard version no. (now:1) @{b}#ID: n @{ub} : Release number @{b}#Release: @{ub} : Release date @{b}#Uploader: @{ub} : Uploader name and addresses @{u} @{" Field descr. " link fields} @{" Main Menu " link main} @{uu} @ENDNODE @NODE fields "Fields" @{fg shine}@{u} @{uu}AID: THE STANDARD@{u} @{uu}@{fg text} Fields description: ------------------- Obligatory when not specified! Standard Version: 1 @{b}.ID@{ub} <> PURPOSE: Identifies a request in a unique way FORMAT: 1 line, number ------------------------------------------------------ @{b}.DATE@{ub} <> PURPOSE: Date of processing FORMAT: 1 line, <
> or <
> EXAMPLE: 31-11-95 EXAMPLE: 04-Nov-95 ------------------------------------------------------ @{b}.FROM@{ub} PURPOSE: Full name of the request/answer author FORMAT: 1 line EXAMPLE: Lorenzo Colloreta NOTES: Don't add addresses here ------------------------------------------------------ @{b}.EMAIL@{ub} PURPOSE: email address of request author (if any) FORMAT: 1 line EXAMPLE: lcs@zen.it , lcs@zen.zen.it NOTES: Separate different addresses with comma ------------------------------------------------------ @{b}.SHORT@{ub} PURPOSE: Short program description FORMAT: 1 line EXAMPLE: browser for AID databases ------------------------------------------------------ @{b}.FULL@{ub} PURPOSE: Longer program description FORMAT: Multiple lines accepted EXAMPLE: Browser for AID database with many options ------------------------------------------------------ @{b}.MAIL@{ub} <> PURPOSE: Addresses different from email FORMAT: Multiple lines accepted EXAMPLE: Lorenzo Colloreta Via A.Calugi 9 - Loc.Pontelungo 51030 Pistoia - Italy Phone: +39 573 572058 ------------------------------------------------------ @{b}.TITLE@{ub} <> PURPOSE: Supposed software title (if any) FORMAT: 1 line EXAMPLE: AID-broswer ------------------------------------------------------ @{b}.DIFFICULTY@{ub} <> PURPOSE: Supposed difficulty according to sender's opinion. Range from 0 (EASY) to 10 (HARD) FORMAT: 1 line, number ------------------------------------------------------ @{b}.TYPE@{ub} <> PURPOSE: Suppposed type of software, according to sender's needs or opinions FORMAT: 1 line EXAMPLES: executable (conventional) Arexx Scala script Amigados script E source C source Library Device Basic source (...etc) ------------------------------------------------------ @{b}.SIMILAR@{ub} <> PURPOSE: Similar programs, if known FORMAT: Multiple lines accepted URL format suggested for internet access EXAMPLE: AID homepage at http://www.zen.it/~lcs/aid.html NOTES: Use the specific form to send info about similar software not included in the record ------------------------------------------------------ @{b}.FEATURES@{ub} <> PURPOSE: List needed features FORMAT: Multiple lines accepted EXAMPLE: Handle screenmode Save preferences Online help ------------------------------------------------------ @{b}.NOTES@{ub} <> PURPOSE: Add misc notes to the request FORMAT: Multiple lines accepted ------------------------------------------------------ @{b}.LINKS@{ub} <> PURPOSE: Links to other previous AID requests FORMAT: Multiple lines, numbers, separated by comma EXAMPLE: 11, 34, 46 55, 56 ------------------------------------------------------ @{b}.IDLINK@{ub} PURPOSE: Pointer to AID request (used for answering or sending info about previous request(s)) FORMAT: Multiple lines, numbers, separated by comma NOTES: It does not appear in the final database, but only in the posting form ------------------------------------------------------ @{b}.ANSWER@{ub} PURPOSE: Answer to request FORMAT: Multiple lines accepted EXAMPLE: I'm developing a browser using Arexx Download it from http://somewhere.com NOTES: Answer fields can be more than one in any database record. Maintainer will add author's info (address, date, etc) to the field ------------------------------------------------------ @{u} @{" Forms " link forms} @{" Main Menu " link main} @{uu} @ENDNODE