sdf_tutorial_editing_guide
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
sdf_tutorial_editing_guide [2021/03/12 20:21] – [HTML Template] hc9 | sdf_tutorial_editing_guide [2022/03/02 19:57] – [Coding Style] hc9 | ||
---|---|---|---|
Line 2: | Line 2: | ||
===== Original Tutorial Site Editing ===== | ===== Original Tutorial Site Editing ===== | ||
- | This information is not for this wiki, but for the older, straight-HTML based SDF Tutorial pages, accessible via https:// | + | This information is not for this wiki, but for the older, |
You can more easily add to and edit [[start| this wiki]], but if you want to add to or update the other tutorials that haven' | You can more easily add to and edit [[start| this wiki]], but if you want to add to or update the other tutorials that haven' | ||
Line 86: | Line 86: | ||
If you don't have the time or inclination to learn HTML, you may still be able to contribute to the Tutorials Project. Write a tutorial (or a section, correction, addendum, etc.) in plain text and tack a note in '' | If you don't have the time or inclination to learn HTML, you may still be able to contribute to the Tutorials Project. Write a tutorial (or a section, correction, addendum, etc.) in plain text and tack a note in '' | ||
- | ==== Before You Start Coding! ==== | + | ===== Before You Start Coding! |
SDF tutorial files contain HTML code, but **they are not complete HTML documents**. When they are served to web browsers, the site's '' | SDF tutorial files contain HTML code, but **they are not complete HTML documents**. When they are served to web browsers, the site's '' | ||
Line 98: | Line 98: | ||
Tutorial files will also contain an RCS **$Id** tag, which will look something like: '' | Tutorial files will also contain an RCS **$Id** tag, which will look something like: '' | ||
- | === Using Images === | + | ==== Using Images |
**Do not hotlink images from other sites**. Put a copy of any image files you wish to use in ''/ | **Do not hotlink images from other sites**. Put a copy of any image files you wish to use in ''/ | ||
Line 119: | Line 119: | ||
</ | </ | ||
- | === Citing References === | + | ==== Citing References |
In the event that you rely heavily upon a source in your tutorial, // | In the event that you rely heavily upon a source in your tutorial, // | ||
Line 137: | Line 137: | ||
</ | </ | ||
- | Then, where the sources are cited in the text of your tutorial, use a superscript (''< | + | Then, where the sources are cited in the text of your tutorial, use a superscript ( '' |
<file config Superscript > | <file config Superscript > | ||
Line 157: | Line 157: | ||
There are further examples of this in the [[# | There are further examples of this in the [[# | ||
- | === Which HTML Version? === | + | ==== Which HTML Version? |
The current W3C recommendation is [[http:// | The current W3C recommendation is [[http:// | ||
Line 176: | Line 176: | ||
* ''< | * ''< | ||
* ''< | * ''< | ||
- | * ''< | + | * '' |
* ''< | * ''< | ||
* ''< | * ''< | ||
Line 183: | Line 183: | ||
Many closing tags are optional, but for code clarity they can be nice. Stay away from XHTML self-closing tag forms, however (ie. ''< | Many closing tags are optional, but for code clarity they can be nice. Stay away from XHTML self-closing tag forms, however (ie. ''< | ||
- | ==== Coding Style ==== | + | ===== Coding Style ===== |
You can //do a lot// with HTML and CSS. You can do even more if you throw Javascript into the mix. | You can //do a lot// with HTML and CSS. You can do even more if you throw Javascript into the mix. |
sdf_tutorial_editing_guide.txt · Last modified: 2022/03/02 19:57 by hc9