User Tools

Site Tools

Trace:
sdf_tutorial_editing_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
Next revisionBoth sides next revision
sdf_tutorial_editing_guide [2021/03/10 23:56] – created hc9sdf_tutorial_editing_guide [2021/03/17 03:52] – [Before You Start Coding!] 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>Revision_Control_System|RCS]]) straight-HTML based SDF Tutorial pages, accessible via https://sdf.org/?tutorials
  
-    * 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've grown up only knowing that hackers destroy computer networks and exploit people and their information. The solution is not to ridicule or shun these kiddiots, but to show them that there is a better and truer way. -- From the README.TXT+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't been migrated to the wiki yet, you may follow the directions below! 
 + 
 +===== 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've grown up only knowing that hackers destroy computer networks and exploit people and their information. The solution is not to ridicule or shun these kiddiots, but to show them that there is a better and truer way. -- From the README.TXT
  
 This guide has been introduced to help members more easily contribute to the SDF Tutorials project. The [[#creating_and_editing_tutorials|first section]] of the guide gives brief instructions for creating or editing tutorial files using RCS for version control. The [[#coding_a_tutorial|second part]] of the guide discusses tutorial-specific HTML coding and contains some template code. This guide has been introduced to help members more easily contribute to the SDF Tutorials project. The [[#creating_and_editing_tutorials|first section]] of the guide gives brief instructions for creating or editing tutorial files using RCS for version control. The [[#coding_a_tutorial|second part]] of the guide discusses tutorial-specific HTML coding and contains some template code.
Line 26: Line 30:
  
 <code> <code>
 +
 $ umask 022 $ umask 022
 $ echo -e "\n\$Id\$" > your_tutorial_filename.html $ echo -e "\n\$Id\$" > your_tutorial_filename.html
 +
 </code> </code>
  
Line 33: Line 39:
  
 <code> <code>
 +
 $ ci -u your_tutorial_filename.html $ ci -u your_tutorial_filename.html
 +
 </code> </code>
  
Line 47: Line 55:
  
 <code> <code>
 +
 $ co -l filename $ co -l filename
 +
 </code> </code>
  
Line 57: Line 67:
  
 <code> <code>
 +
 $ ci -u filename $ ci -u filename
 +
 </code> </code>
  
Line 94: Line 106:
 Incorrect: Incorrect:
 <code> <code>
 +
 <img src="tutorials/images/example.png"> <img src="tutorials/images/example.png">
 +
 </code> </code>
 +
 Correct: Correct:
 <code> <code>
 +
 <img src="http://sdf.org/tutorials/images/example.png" <img src="http://sdf.org/tutorials/images/example.png"
      alt="Image of a Blickensderfer No. 5 typewriter>      alt="Image of a Blickensderfer No. 5 typewriter>
 +
 </code> </code>
  
Line 120: Line 137:
 </file> </file>
  
-Then, where the sources are cited in the text of your tutorial, use a superscript (''<sup >'') number or a number in parenthesis hyperlinked to the appropriate list item.+Then, where the sources are cited in the text of your tutorial, use a superscript ( ''<nowiki><sup></nowiki>'' ) number or a number in parenthesis hyperlinked to the appropriate list item.
  
 <file config Superscript > <file config Superscript >
Line 138: Line 155:
 </file> </file>
  
-There are further examples of this in the [[#template|code template]] below.+There are further examples of this in the [[#html_template|code template]] below.
  
 === Which HTML Version? === === Which HTML Version? ===
Line 159: Line 176:
     * ''<img>''     * ''<img>''
     * ''<code>'', ''<samp>'', and ''<kbd>''     * ''<code>'', ''<samp>'', and ''<kbd>''
-    * ''<sup >'' and ''<sub>''+    * ''<nowiki><sup></nowiki>'' and ''<sub>''
     * ''<strong>'', ''<small>'', and ''<em>''     * ''<strong>'', ''<small>'', and ''<em>''
     * ''<i>'', ''<b>'', ''<u>'', and ''<s>''     * ''<i>'', ''<b>'', ''<u>'', and ''<s>''
Line 304: Line 321:
 </file> </file>
  
-$Id: tutorial_editing.html,v 1.24 2018/08/28 02:39:56 moondoggy Exp $<sup>1</sup> [[http://sdf.org/?tutorials/tutorial_editing|SDF Tutorial Editing Guide]] - legacy link +$Id: tutorial_editing.html,v 1.24 2018/08/28 02:39:56 moondoggy Exp $<sup>1</sup> [[http://sdf.org/?tutorials/tutorial_editing|SDF Tutorial Editing Guide]] - traditional link (using [[wp>Revision_Control_System|RCS]])\\
 <sup>1</sup> Replicated from the tutorial_editing.html,v 1.24 2018/08/28 text. <sup>1</sup> Replicated from the tutorial_editing.html,v 1.24 2018/08/28 text.
  
-To see how this template looks when rendered, visit [[http://sdf.org/?tutorials/tutorial_template|"http://sdf.org/?tutorials/tutorial_template"]].+To see how this template looks when rendered, visit ''[[http://sdf.org/?tutorials/tutorial_template|http://sdf.org/?tutorials/tutorial_template]]''.
  
sdf_tutorial_editing_guide.txt · Last modified: 2022/03/02 19:57 by hc9