<< $Id: template.txt,v 1.20 2005/11/17 20:37:40 layer Exp $ >> << Instructions in this template appear in comments like this. You can leave them in your entry or remove them. It is up to you. They are ignored by the entry processing program. INSTRUCTIONS FOR FILLING IN THIS TEMPLATE A bit about the formatting is this file, which is somewhat like the markup language that some wiki's use. * Please leave the section headers (== foo ==) as they are. * Paragraphs should not be indented. * Examples should be indented 2 spaces. They will be put into an HTML `pre' and will appear verbatim. * No HTML is allowed. All occurances of < and > will be escaped. * Links in your text can be described like this: href(name of link,http://...) * Emails in text can be specified as mailto(foo@bar.com) so they appear as links on the site. * Bold and italic are accomplished with bold(text) and italic(text). * Lists of items are accomplished with a ``* '', with no indentation before the first and subsequent lines. This sentence is in a valid list item. Each section for an entry starts with ``== ... ==''. The first comment inside each section gives a description of the type of text you should enter for that section. The first part of this comment has the form: TYPE: where will vary from section to section. Here are the valid types and the format for each: type description ---- ----------- plain-text Plain text. wml `wml' stands for `wiki-like markup language'. Sections of this type can use href(), mailto(), bold(), italic(), `* ' lists, and use indentation to distinguish from paragraphs and examples. url a fully formed and valid URL urls a list of URLs, one per line date a date (currently any format will do) version a version (currently any format will do) >> << ******************************************************************* >> << ********* ENTRY STARTS HERE *************************************** >> << ******************************************************************* >> == name == << The name of your entry. Anything from one word to a few is OK. The name can contain spaces, too. TYPE: plain-text >> == category == << Looking at the menu on the left of lispwire.com, which one would you say best describes your entry, or should we make a new entry? If we should make a new menu entry for your application, what would you suggest it be? TYPE: plain-text >> == author == << Descriptive text about the author(s). Use the mailto() macro to specify an email address. TYPE: wml >> == author-image == << If there is a url with your favorite picture, please include it here, otherwise send it to us via email. If there is more than one author, you can send us multiple links. TYPE: url >> == short-description == << A short description, 3 or 4 sentences long at the most. This description will appear on index pages of applications, which is why it needs to be short and concise. TYPE: wml >> == long-description == << A long description of your entry. Keep in mind this is probably the first thing potential users of your application will read. TYPE: wml >> == examples == << Some examples of your code in action; they need not be self-contained, just code segments that show the power of your code. The more examples the better. These will likely be the first example uses new users of your code will see. Wow them! TYPE: wml >> == instructions == << Instructions on how to load and use your code. We encourage everyone to have a file called "load.cl" that loads their project. TYPE: wml >> == tutorial == << A tutorial of how to do simple to complex things; intermix code and description. A comprehensive tutorial is strongly recommended. Remember, example text is indented, explanatory text is not. TYPE: wml >> == home-url == << The URL of the home page for your project. In some cases this will be empty. Just list the URL without using the href() macro. TYPE: url >> == doc-url == << The URLs to your documentation -- just list the URLs one per line, without using the href() macro. TYPE: urls >> == license == << If you have a specific license for the code, include the URL here. If not, and you want it to be public domain, specify that here too. TYPE: wml >> == book == << If there are books that are relevant to the audience of your program, list them here. Please include the title and book URL (to amazon.com or some other site). Recommended syntax is one "paragraph" per book (with no indentation): href(book title,http://...) by author. descriptive text... more text... TYPE: wml >> == references == << Include text which would be of interest to readers wishing to dive deeper into the subject of your application. TYPE: wml >> == source-fooball == << The URL where the source code can be obtained, or some description of the status of obtaining source code. TYPE: wml >> == release-date == << Specify the date of the current release. TYPE: date >> == release-version == << Specify the version of the current release. TYPE: version >> == status == << One of: alpha, beta or stable. You may also include descriptive text relevant to the status of the current version. TYPE: wml >> == history == << Any relevant version history. TYPE: wml >> == acl-dependencies == << Include here a description of dependencies on particlar versions of ACL. TYPE: wml >> == other-dependencies == << Include here a description of dependencies on other software; for example, if the software relies on another package (e.g., AllegroServe) to run, say that here. Also, if a specific operating system package (i.e., rpm package) is needed specify it here. TYPE: wml >> == platform == << If the software runs only on specific platforms for this software, include that information here. TYPE: wml >> == ad == << IGNORE -- this is an internal field. >>