Skip to content

Commit 8b87df7

Browse files
eternauta1337eternauta1337
committed
added tutorial on writting tutorials
1 parent 7465084 commit 8b87df7

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

‎li/community/wikitutorials/src/WikiTutorials.html

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!DOCTYPE HTML>
2+
<html>
3+
<head>
4+
<title>Writting Tutorials</title>
5+
<!-- AS3 Syntax Highlighter -->
6+
<script type="text/javascript" src="http://away3d.com/static/syntaxHighlighter/scripts/shCore.js"></script>
7+
<script type="text/javascript" src="http://away3d.com/static/syntaxHighlighter/scripts/shBrushAS3.js"></script>
8+
<link type="text/css" rel="stylesheet" href="http://away3d.com/static/syntaxHighlighter/styles/shCoreEclipse.css"/>
9+
<script type="text/javascript">SyntaxHighlighter.all();</script>
10+
<!-- shadow box -->
11+
<link rel="stylesheet" type="text/css" href="http://away3d.com/static/shadowBox/shadowbox.css"/>
12+
<script type="text/javascript" src="http://away3d.com/static/shadowBox/shadowbox.js"></script>
13+
<script type="text/javascript">Shadowbox.init();</script>
14+
<!-- Wiki base styles -->
15+
<link rel="stylesheet" href="http://away3d.com/themes/wiki_themes/away3d/wiki_styles.css" type="text/css" media="screen" title="Global Styles" charset="utf-8"/>
16+
<!-- Styles for tutorials -->
17+
<link type="text/css" rel="stylesheet" href="http://away3d.com/wikicontent/styles/tutorial.css"/>
18+
</head>
19+
<body>
20+
<div class="tutorialMetadata">[[Category:Community]]</div>
21+
<article>
22+
This article will explain how to publish tutorials on the Away3D site, and which guidelines to follow to ensure the site's content is consistent.
23+
<section>
24+
<h4>User Access</h4>
25+
If you are a registered away3d.com user, you can email the Away3D team at <a href="mailto:[email protected]?subject=Tutorial Submission">[email protected]</a> and request that you are granted privileges for publishing articles in our tutorials wiki. Once this is done, you can create a new tutorial by typing the name of the article you want to create in the "Find or Create Tutorial" search box on the top-right of this page. If a page named like that does not previously exist, you should see an edit button. Once you press it, you enter edit mode for the article and will be able to submit your tutorial.
26+
</section>
27+
<section>
28+
<h4>Tutorial Writing Guidelines</h4>
29+
The following sections in this article will enumerate the guidelines to follow when writing articles for the tutorials wiki.
30+
<section>
31+
<h4>Using Other Tutorials as Templates</h4>
32+
The first thing you should do is enter edit mode for one of the older tutorials and extract its html code. This will show you a general structure to follow including css styling, usage of swf demos within figure elements, structure of sections, etc. Having the source of one of such tutorials should be of great help while you are developing your own.
33+
</section>
34+
<section>
35+
<h4>No p's</h4>
36+
Since this is a wiki, there is no need to use html p elements. The white space in whatever you enter in the edit window will be maintained, meaning that you can use line breaks to specify paragraphs and should not manually split lines within a paragraph.
37+
</section>
38+
<section>
39+
<h4>Sections and Navigation</h4>
40+
Have a look at how older tutorials put content within sections and have a nav element on top in order to quickly see and navigate to the sections within the tutorial.
41+
</section>
42+
<section>
43+
<h4>Aside</h4>
44+
If you see the source of one of the older tutorials, you will see an aside section that specifies the difficulty of the article, requirements etc. This is an important section of your article and is required. This section should include a link to the sources of the tutorial on github as well as a downloadable zip file. More on the sources section.
45+
</section>
46+
<section>
47+
<h4>Sources</h4>
48+
You can embed code snippets in the article using the appropriate pre tag ( see older tutorials for how to link it to syntax highlighter ). When listing entire classes or demos, you should provide a link to the file in github.com. To upload the files to this repository, please contact the Away3D team who will upload it for you or give you write access to the repository.
49+
</section>
50+
<section>
51+
<h4>Special Terms and Code</h4>
52+
See how older tutorials use the code html tag and styling for dealing with words that refer to new concepts or language variables.
53+
</section>
54+
<section>
55+
<h4>Demos</h4>
56+
All swf demos are image links within figure html tags with related captions. The caption includes a description of the demo and a link to its sources. The image triggers a shadowbox overlay that contains the demo. See the code on an older tutorial for this setup and please pay attention to the styling of the image, its size, and the size of the demo.
57+
</section>
58+
<section>
59+
<h4>BBCode</h4>
60+
Notice how at the start of articles there is a div with class "tutorialMetadata" that specifies the category of your tutorial. If you do not include this, your article will not be categorized and will be more difficult to find. You can also use BBCode tags to link to other pages in the wiki. Follow <a href="http://expressionengine.com/user_guide/modules/wiki/getting_started.html" target="_blank">this</a> link to learn more about BBCode usage in the wiki.
61+
</section>
62+
</section>
63+
</article>
64+
</body>
65+
</html>

0 commit comments

Comments
 (0)