Tutorial File Locations
Tutorials |
/sys/html/tutorials |
Tutorial Images |
/sys/html/tutorials/images |
File Check-out/Check-in Process
Check-out |
|
Check-in |
ci -u filename
End description with a single ".". |
|
|
HTML Style Guide
The code in tutorial files represents the contents of a <body>
element, and must not contain the following elements/tags: <html>
/ </html>
<head>
/ </head>
<meta>
<base>
<body>
/ </body>
|
Tutorial files also contain an RCS $Id tag, something like: $Id:filename.html,v 1.11 2011/01/01 11:11:11 username Exp $
. This is automatically generated by RCS and should be left as the last line of the file. |
To maximize backwards compatibility, try to restrict yourself to the following elements. • Structural Elements <h1>
, ..., <h6>
• Grouping/Block-Level Elements <p> <pre> <ul>
, <ol>
, <dl>
and their subordinates <blockquote> <hr> <table>
and its subordinates and, of course, <div>
• Text-level/Inline Elements <br> <a> <img> <code>
, <samp>
, and <kbd> <sup>
and <sub> <strong>
, <small>
, and <em> <i>
, <b>
, <u>
, and <s> <dfn>
, <var>
, and <cite>
|
Many closing tags are optional, but for code clarity they can be nice. Stay away from XHTML self-closing tag forms (ie. <br/>
, <hr/>
, <img src="some_url"/>
, et cetera). |
|
|
Creating a new tutorial
Change your working directory to /sys/html/tutorials. cd /sys/html/tutorials
|
Use umask to make sure your new file is readable.
|
Create your new tutorial file. echo -e "\n\$Id\$" > your_tutorial_filename.html
|
Use ci -u to check-in and unlock the new file. ci -u your_tutorial_filename.html
|
Enter a meaningful description for your new tutorial, end the description with a line with a single ".". How to contribute to the SDF .
|
Now your new tutorial file is created and you can edit it using the Editing a tutorial guide below.
Editing a tutorial
Change your working directory to /sys/html/tutorials. cd /sys/html/tutorials
|
Use the command co -l to check out the tutorial file and lock it while you edit it. If when using co -l you are told that the file is already locked please STOP what you are doing and wait for it to be checked back in. If it does not get checked back in, email the author and let them know you want to check out the file and edit it.
|
Edit the file using your preferred text editor. If you save your work periodically, you can load and reload the tutorial in your web browser to see your changes. The URL for the tutorial file will be http://sdf.org/?tutorials/filename_without_extension (eg. If you are editing /sys/html/tutorials/nmap_for_dummies.html, the URL will be http://sdf.org/?tutorials/nmap_for_dummies). |
Check-in the updated tutorial.
|
Describe the changes you've made to it. Be as terse as you like, but please write something useful. End the description with a line with a single ".". Added a section on describing changes. .
|
Your updated tutorial should now be checked back.
Note: If this is a new tutorial, once your tutorial is ready for public display you will also need to add it to the tutorials index by following the steps above for the index.html file in the tutorials directory.
|