XSkriptTutorial.Mitarbeit
Search:
print pdf

So you want to help improve the Tutorial for X script? Great! We are glad to have you aboard. To maintain conformity of this tutorial even with additions of many authors, here a few tips for the general layout:

  • Each new chapter should start with “ChapterX” where X stands for the chapter number. Subchapter’s numbers are separated with a hyphen, thus, e.g., "Chapter3-2".

  • Each Tutorial should be understandable for newcomers. If you use a linguistic element which is used in none of the previous chapters, please explain it there.

  • To avoid having to read trough the entire tutorial to find out whether a linguistic element was already used, it should be written in the table of contents of every chapter which novelties.

  • Source code should be entered as =delphi[= ... =]. Linguistic elements, used for the first time in the Tutorial, should be emphasized in red. In addition simply uses !- ... -!.

  • When explaining text concepts from the source code, these explanations should be shown in fat.

  • When you add a segment to your text which was not constructed yet, the suitable reference with " %MissingLink % or reference %% " should be used. This way the correct link can be added later with ease.

  • Whenever you make a reference to another chapter, you should also make a link to that chapter.

  • Please try your best to keep your scripts free of bugs (errors). In case of doubt you ca always use the Forums to get confirmation.

  • If you complement the list of the concepts, please put an anchor before that concept, so that we can refer this concept later on. Use the name of the concept as the name of the anchor.

  • To refer in the Tutorial to a concept from the concept list, the following code is to be used: [[concept: LinkName text]] LinkName gives the Anchor and text the text that will be displayed. Concepts should only be linked the first time they are used in the tutorial.

  • Every chapter should develop an independent mission, this will help newcomers when learning.

  • Alongside the Tutorial you also have the HOW-TOs. Examples for a certain problem should be put there. This in contrast with a chapter, that should cover a complete theme, e.g., UFOS, news windows, ground applications, etc.

Recent Changes - Edit Menue
Page last modified on 21.04.2005, 13:25 by Napivo
Edit Page - Attributes - Page History