The Page Editing Style Guide

Once you have a CVS account, your area of the web site will be /user/account/. For example, mine is /user/dj_delorie/. You will not be able to change files outside your area. Of course, if you find that you *can*, let me know, because that's probably a bug.

Anyway, the first thing you should do is create an index.html file that says who you are and how to contact you. Any footprints you upload should end in .fp and if you link directly to them, the server does the right thing automatically. Likewise, for symbols end in .sym. See below for how to encode author and copyright information into symbols and footprints.

Tables should end in .csv .

When I notice your area has content, I'll add a link to it from the top page so that others can find it.

All html pages should use the global gedasymbols style. Look at the sources to other pages to see how it's being done. To use the global style, your html files should all start like this:

<!--#set var="title" value="Meaningful Title" -->
<!--#include virtual="/header.html" -->

Note that the index.html in your /user/ directory should have just your full name as the title, nothing else, as the server automatically reads those to generate the list of contributors. The last line in your HTML files should be this:

<!--#include virtual="/trailer.html" -->
Other than that, you should avoid using HTML constructs that change the appearance of the page (i.e. <P> is OK, but don't use align=center or any font or color tags.).

There are four basic types of files that are appropriate for

To keep things consistent, please list your files in that order on your index page. Also, the convention for subdirectories (if you have enough files to warrant them) is:


You, as the author, get to pick the terms under which your symbols are distributed and used. Note that putting them on implies a license for to distribute them according to the way web servers (and clients, search engines, etc) work.

For symbols, you should include invisible text attributes that specify your name, email (you may use any obvious anti-spam tricks you like), and distribution and licence terms. For footprints, include comments (any line beginning with # is a comment) or, for newer pcbs, a board-global Attribute() entry. Always use the keywords given below, so that in the future I can write an indexer of some sort (the automatic footprint web page handler already uses these). Examples, showing appropriate keywords, for symbols and footprints respectively, follow:

T . . .
author=DJ Delorie
T . . .
T . . .
# author: DJ Delorie
# email:
# dist-license: GPL 2
# use-license: unlimited
Element[ . . . ]

Note that "dist-license" is the license under which the files may be redistributed in some form whereby they can be used for other projects. Since gEDA uses open formats, this includes distributing project files. The "use-license" covers boards made using the symbols, so if you say "personal" here, that means the person can't sell those boards.

For the automatic symbol and footprint handlers, if the first word in the license matches a license web page a link will be created automatically (i.e. "GPL" above would link to GPL.html). Also, the email address will be linked automatically if it looks like an email address, and http-style links will be automatically converted.

Copyright 2007, all rights reserved unless specified otherwise. is maintained by DJ Delorie