To submit a HOWTO, you must email it to me in a special format. After checking it out, my system will send you a confirmation URL. Cut and paste that URL into your web browser, and your HOWTO will be installed!
If you later want to update the HOWTO, simply mail in a replacement. As long as the category, filename, and email address all match, the old will be replaced with the new. Send me email if you want a HOWTO removed or renamed.
Note: Your email address will be published with your HOWTO, and you must provide a valid one (else your howto cannot be installed). This is to make people think twice about being jerks and submitting stupid or inappropriate howtos.
The HOWTO submission format is as in this example:
To: firstname.lastname@example.org Subject: (doesn't matter) %%howto-version: 1.0 %%title: Your Title Here %%url: http://blah.com/blah-blah.html %%category: djgpp %%filename: dosemu-install %%author: Your Name Here One paragraph summary of what the howto is about Body of HOWTO %%end-howto
The first section is just the regular mail headers. Your mail program may not even place them in with the text of the mail - they may be fill-in fields. The important thing is that the message must be mailed to email@example.com (don't send anything else there). It doesn't matter what you put for a subject, it will be ignored.
The second section is part of the mail message itself. It's important that you format this section correctly, or else your mail will be rejected. Note that each line starts with two percents, a field name, a colon, one or more spaces or tabs, and the value of the field. There must be no spaces around the percents or before the colon, and you must use lower case. The howto-version field must be first, but the other fields may be in any order.
OK, next you must skip a line and write a one paragraph (four 80-column lines or less) summary about what this howto is all about. This will be displayed in addition to the title in cases where there is sufficient room to allow the extra text. Usually your title will be all the user sees. This paragraph will also be placed at the top of your howto's page. No HTML is allowed, nor will URLs be tagged as such.
OK, next you must skip a line and fill in your HOWTO. Don't use HTML - it will not do what you expect. Do not include a title or header; one will be provided for you. You may include URLs in your text; they will be marked as hypertext links (just type the url, don't use <a>). There is a limit of 1000 80-column lines per HOWTO (about 16 printed pages).
The last line in your howto must be the %%end-howto line. This doesn't have to be the last line in your mail. In fact, it's there to make sure the program that handles these mails knows how to remove any automatic signature from the mail. You must include this line exactly as is - two percents and the words "end-howto" with no spaces, alone on a line.
|webmaster donations bookstore||delorie software privacy|
|Copyright © 2003 by DJ Delorie||Updated Oct 2003|