How to layout your tutorial
How to layout your tutorials
Introduction
This brief guide will give you a basic idea how your tutorials should be setup and some other information.What should I know?
Your user information
When you view a tutorial, the author's avatar and name, the submission date etc. are placed in the sidebar to the right.Everyone can see who submitted the tutorial and where the credits should go to.
Copyright information
It's nice to have a bit of copyright included on your page. That way, if someone steals your code you have a copyright notice which demands they should remove the stolen code and/or give appropriate credit to you. You can also include re-distribution notes. See the bottom of this page for an example.Structure
If you haven't read the policy, the tutorial system demands a strict structure. I'll explain the structure of the tutorials.Structure
Headings
Headings are denoted by the <h4> tags. They come in large, underlined text so you can see each section easily.Sub-headings
If you want to split each section into further sub-headings, you can do (like this tutorial). All you have to do is use the <h5> tags.Codes
All codes must be surrounded with a <code> tag. Everything within them will be highlighted and laid out for easy view.
<?php
echo "My message";
?>
As you can see above, the PHP code was highlighted by each particular area. When placing code in the <code> tags that you want highlighting, make sure to replace the < tag with < and it will be highlighted at run-time.If you want to place some text that you don't want highlighting, you must use the &lt; tag. IE:
<
&lt;
Becomes
<
<
Other tags
Other tags you can use are things like <b>, <u>, <i>, <a>, <em>, <table>, <div>, <span> etc.You cannot use the tags <html>, <head>, <style>, <script>, <base>, <link>, <meta>, <body>, <title>
