| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| sdf_tutorial_editing_guide [2025/03/05 00:22] – added link to new RCS page peteyboy | sdf_tutorial_editing_guide [2025/03/06 18:27] (current) – [Original Tutorial Site Editing] clean text, changed link to authoring page peteyboy |
|---|
| ===== Original Tutorial Site Editing ===== | ===== Original Tutorial Site Editing ===== |
| |
| This information is not for this wiki, but for the older, [[rcs|RCS]]-versioned straight-HTML-based SDF Tutorial pages, accessible via https://sdf.org/?tutorials | :!: This tutorial is //not for editing this wiki//, but for the older, [[rcs|RCS]]-versioned straight-HTML-based SDF Tutorial pages, accessible via https://sdf.org/?tutorials |
| |
| 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! | You can easily [[wiki_authoring|contribute to this wiki]], but if you want to add to or update the HTML tutorials instead, you may follow the directions below! |
| |
| ===== Introduction ====== | ===== Introduction ====== |
| </code> | </code> |
| |
| **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.** | **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.** The way to figure this out is to run ''rlog <filename>'', which will tell you which user has checked out the file (run ''man rlog'' for more details on its use). On the flip side of this, **be sure you check in and unlock any file you change** when you are done making your changes (see commands for checking back in below). |
| |
| You may now 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'' (e.g., if you are editing ''/sys/html/tutorials/nmap_for_dummies.html'', the URL will be ''http://sdf.org/?tutorials/nmap_for_dummies''). | You may now 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'' (e.g., if you are editing ''/sys/html/tutorials/nmap_for_dummies.html'', the URL will be ''http://sdf.org/?tutorials/nmap_for_dummies''). |
| |
| When you check-in a file, you will be asked to describe the changes you've made to it. Be as terse as you like, but please write something useful. | When you check-in a file, you will be asked to describe the changes you've made to it. Be as terse as you like, but please write something useful. |
| | |
| | If you want to see what has been changed, you may use the ''rcsdiff'' command. Type ''man rcsdiff'' for details. Mostly you just need the ''-r'' flag, and you can run ''rlog'' to see what the recent version numbers are. |
| | |
| |
| ==== Editing the FAQs ==== | ==== Editing the FAQs ==== |
