查看“︁SDF HTML教程编辑指南”︁的源代码

''下面的说明是关于创建和编辑基于HTML的用户贡献的教程。要为SDF wiki 教程贡献，请看SDF wiki 教程。''


=== 目录 ===

* 简介
* 创建和编辑HTML教程
** 创建一个新的教程
** 编辑一个现有的教程
** 编辑FAQ
* 编码一个教程
** 在你开始写代码之前!
*** 使用图像
*** 引用参考文献
*** 哪个HTML版本？
** 代码风格
** 教程模板


----

=== 简介 ===
<blockquote>每天都有许多年轻的、非常容易受影响的人发现SDF。他们问我们一些我们可能觉得很愚蠢的问题，但这并不是他们的错。他们在成长过程中只知道黑客会破坏计算机网络，利用人们和他们的信息。解决方案不是嘲笑或回避这些孩子，而是告诉他们有一个更好、更真实的方法。

-- 摘自README.TXT</blockquote>本指南的编写是为了帮助成员更容易地为SDF HTML教程项目做出贡献。指南的第一部分<!-- 待编辑 -->简要说明了如何使用RCS<ref>Revision Control System</ref>进行版本控制来创建或编辑教程文件。指南的第二部分<!-- 待编辑 -->讨论了针对教程的HTML代码，并包含一些模板代码。

你最好阅读一下教程文件目录（<code>/sys/html/tutorials</code>）中SDF HTML教程项目的原始<code>README.TXT</code>。它不仅表达了项目的目的，而且还包含了比这里更详细的RCS使用信息。

本指南假定读者具有基本的shell使用和文本文件编辑知识。熟悉HTML是不必要的，尽管它可能会有帮助。

=== 创建和编辑教程 ===
要创建或编辑一个教程，请将你的工作目录改为/sys/html/tutorials，在你的SDF主集群（例如sdf.org，而不是MetaArray）的shell中：

<syntaxhighlight lang="shell" line="1">
$ cd /sys/html/tutorials
</syntaxhighlight>

==== 创建一个新的教程 ====
在教程目录内，你可以使用echo来快速创建一个空的HTML文件，同时在底部有一个RCS Id标签。首先使用umask命令，以确保新文件的权限允许网络服务器（和其他用户）读取它。<syntaxhighlight lang="shell" line="1">
$ umask 022
$ echo -e "\n\$Id\$" > your_tutorial_filename.html
</syntaxhighlight>使用命令<code>ci -u</code>将该文件用RCS签入，并将其解锁，以便任何人都可以编辑它。<syntaxhighlight lang="shell" line="1">
$ ci -u your_tutorial_filename.html
</syntaxhighlight>在你第一次签入一个文件时，你会被要求对其进行描述。请写一些有用的东西。

现在你可以使用下一节<!-- 等待编辑 -->的说明编辑你的教程，以检查文件是否进入和离开RCS。

一旦你的教程准备好公开展示，请将其添加到可用的教程列表中，以便人们能够在网上真正找到它。你必须编辑教程目录中的<code>index.html</code>文件来完成这项工作。编辑<code>index.html</code>文件时，请使用与编辑教程时相同的签入/签出程序。

==== 编辑一个现有的教程 ====
在tutorials目录下，使用<code>co -l</code>命令用RCS检查文件，并在你进行编辑时锁定它。<syntaxhighlight lang="shell" line="1">
$ co -l filename
</syntaxhighlight>'''<u>如果在使用<code>co -l</code>时，你被告知该文件已经被锁定，请停止你正在做的事情，并等待它被重新检入。如果它没有被检入，请给作者发电子邮件，让他们知道你想检出该文件并编辑它。</u>'''

现在你可以使用你喜欢的文本编辑器编辑该文件。如果你定期保存你的工作，你可以在你的网络浏览器中加载和重新加载教程以查看你的变化。教程文件的URL将是<code><nowiki>http://sdf.org/?tutorials/filename_without_extension</nowiki></code>（例如，如果你正在编辑<code>/sys/html/tutorials/nmap_for_dummies.html</code>，URL将是<code><nowiki>http://sdf.org/?tutorials/nmap_for_dummies</nowiki></code>）。

当你完成了对文件的编辑，使用命令<code>ci -u</code>将该文件用RCS签入，并解锁，以便其他人可以编辑它。<syntaxhighlight lang="shell" line="1">
$ ci -u filename
</syntaxhighlight>当你签入一个文件时，你会被要求描述你对它所做的修改。随你怎么说，但请写一些有用的东西。

===== 签入之前撤销编辑 =====
'''<u>如果在编辑完一个文件后，你希望不签入你的修改，恢复到没有你的修改的版本</u>'''，只需运行一个带有解锁的签出，类似于你之前的签出方式：<syntaxhighlight lang="shell" line="1">
$ co -u filename
</syntaxhighlight>你可能会收到一个警告，询问你是否要删除文件的写入权限---你*需要*，因此输入*yes*。这将把以前版本的文件重新加载到当前文件夹中，并解锁，以便其他人可以再次进行修改。如果你想再试一次，请使用与上述相同的步骤。

==== 编辑FAQ ====
MetaARPA会员也可以编辑[https://sdf.org/?faq FAQ]。这些是纯文本文件，能在<code>/sys/html/tutorials/FAQ/</code>中找到。每个部分的FAQ列表都在一个点文件"<code>.list</code>"中。这些FAQ文件与<code>faq</code>命令所显示的文件定期同步。

=== 编码一个教程 ===
教程是用HTML编码的。如果你对HTML已经驾轻就熟，那么你离编辑你的教程就只有一步之遥了!请阅读 "在你开始写代码之前"<!-- 待编辑 -->部分，了解一些实施的具体细节，并在继续前至少略过编码风格部分。

如果你'''不'''熟悉HTML，W3C<ref>World Wide Web Consortium</ref>网站有一个非常简短的教程，即《[http://www.w3.org/MarkUp/Guide/ HTML入门]》，它将教会你足够多的基础知识，以便能够编写一个教程。此外，本页面的模板还提供了大量的评论，以帮助HTML初学者。



注释：