教程格式指南
版本1.3
如果您想发布关于youcl的教程，请阅读本指南，了解如何格式化教程，使其符合youcl的外观和感觉，并尽可能吸引尽可能多的读者。 这些准则还可帮助您最大限度地减少文档的大小。
1我使用什么程序来编写我的HowTo？
使用HTML编辑器，如Dreamweaver或免费的替代Bluegriffon http://www.bluegriffon.org/或任何其他创建有效HTML的HTML编辑器。 不要使用MS Word来生成HTML内容，因为Word会产生“奇怪”的HTML ...
2如何开始？
好的，你坐在你的HTML编辑器的前面，准备开始，但下一步呢？ 请将此HTML骨架复制到编辑器中：
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title></title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
.command {
padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;
font-family: Courier New, Courier, mono;
font-size: 12px;
font-style: italic;
}
.system {
color: black;
font-family: Courier New, Courier, mono;
font-size: 12px;
font-style: italic;
}
.highlight {
color: #FF0000;
font-family: Georgia, "Times New Roman", Times, serif;
font-size: 12px;
text-decoration: underline;
}
-->
</style>
</head>
<body>
</body>
</html>
|
现在你在<body>和</ body>标签之间编写你的教程。
3格式化
3.1正常文本
始终使用正常文本和标题的默认字体！ 不要使用<font>标签，也不要定义自己的CSS类。 在您发布了关于youcl的教程之后，所有格式将由youcl CSS类完成。
例如，像
<p><font size="2" face="Verdana, Arial, Helvetica, sans-serif">This is a sentence.</font></p>
应该避免。 只需使用
<p>This is a sentence.</p>
代替。 在youcl上，它将如下所示：
这是一句话。
3.2标题
请使用<h1> ... </ h1> ， <h2> ... </ h2> ， <h3> ... </ h3> ， <h4> ... </ h4>或<h5> ... </ h5>格式化标题。 再次，不要使用<font>标签或CSS类来格式化它们。
标题
<h3>This Is A Heading</h3>
将在youcl上看起来像这样：
这是标题
3.3命令
请使用CSS类.command （在HTML框架的<head> ... </ head>部分中定义）来格式化shell命令，以便读者知道它是必须在shell上执行的。 例如，
<p class="command">chmod 755 /path/to/file</p>
将在youcl上看起来像这样：
chmod 755 /path/to/file
3.4文件内容
文件内容应包含<pre> ... </ pre> 。 例如，如果要向读者显示/etc/resolv.conf的内容，可以这样做：
<pre>search server
nameserver 145.253.2.75
nameserver 193.174.32.18
nameserver 194.25.0.60</pre>
这将在youcl中看起来像这样：
search server nameserver 145.253.2.75 nameserver 193.174.32.18 nameserver 194.25.0.60
3.5文件名，协议名称，系统规格，技术规格等。
如果你正在写关于没有命令的Linux系统相关的项目，但是你想以特殊的方式进行格式化，你可以使用CSS类.system 。 例如，如果您在正常文本中提到文件名，那么格式如下：
<p>Next we edit <span class="system">/etc/network/interfaces</span> so that it looks like this:...</p>
在youcl上，它将如下所示：
接下来我们编辑/ etc / network / interfaces ，使它看起来像这样：
3.6突出显示
如果要突出显示某些内容，可以使用CSS类.highlight 。 例如，
<p class="highlight">server1:</p>
看起来像这样：
server1：
5图像
请勿使用超过550像素的图像！
4发布您的教程
请将您的教程（按照第1至3章创建的HTML文件）与图像一起压缩， 并将 zip文件发送到tutorial@youcl.com 。 请在电子邮件中包含您的youcl用户名 ，以便我们以您的名义发布教程。
6管理员批准
您的新教程不会立即向公众提供。 我们的管理员将检查它（格式，内容等），很可能您的教程将被批准。 之后它可以在youcl上找到。
