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/11 00:00] – [Before You Start Coding!] hc9 | sdf_tutorial_editing_guide [2022/03/02 19:57] – [Coding Style] hc9 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SDF Tutorial Editing Guide ====== | + | ====== SDF HTML Tutorial Editing Guide ====== |
- | ===== Introduction | + | ===== Original Tutorial Site Editing |
+ | This information is not for this wiki, but for the older, ([[wp> | ||
- | * Many young and very impressionable people discover SDF every day. They ask us what we might feel are stupid questions, but it's not their fault. They' | + | 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' |
+ | |||
+ | ===== Introduction ====== | ||
+ | Many young and very impressionable people discover SDF every day. They ask us what we might feel are stupid questions, but it's not their fault. They' | ||
This guide has been introduced to help members more easily contribute to the SDF Tutorials project. The [[# | This guide has been introduced to help members more easily contribute to the SDF Tutorials project. The [[# | ||
Line 26: | Line 30: | ||
< | < | ||
+ | |||
$ umask 022 | $ umask 022 | ||
$ echo -e " | $ echo -e " | ||
+ | |||
</ | </ | ||
Line 33: | Line 39: | ||
< | < | ||
+ | |||
$ ci -u your_tutorial_filename.html | $ ci -u your_tutorial_filename.html | ||
+ | |||
</ | </ | ||
Line 47: | Line 55: | ||
< | < | ||
+ | |||
$ co -l filename | $ co -l filename | ||
+ | |||
</ | </ | ||
Line 57: | Line 67: | ||
< | < | ||
+ | |||
$ ci -u filename | $ ci -u filename | ||
+ | |||
</ | </ | ||
Line 74: | 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 86: | 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 94: | Line 106: | ||
Incorrect: | Incorrect: | ||
< | < | ||
+ | |||
<img src=" | <img src=" | ||
+ | |||
</ | </ | ||
+ | |||
Correct: | Correct: | ||
< | < | ||
+ | |||
<img src=" | <img src=" | ||
| | ||
+ | |||
</ | </ | ||
- | === 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 120: | 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 140: | 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 159: | Line 176: | ||
* ''< | * ''< | ||
* ''< | * ''< | ||
- | * ''< | + | * '' |
* ''< | * ''< | ||
* ''< | * ''< | ||
Line 166: | 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. | ||
Line 304: | Line 321: | ||
</ | </ | ||
- | $Id: tutorial_editing.html, | + | $Id: tutorial_editing.html, |
< | < | ||
- | To see how this template looks when rendered, visit [[http:// | + | To see how this template looks when rendered, visit '' |
sdf_tutorial_editing_guide.txt · Last modified: 2022/03/02 19:57 by hc9