Actions

JDOC

Difference between revisions of "Joomla! 1.5 Template Tutorials Project"

From Joomla! Documentation

m (Introduction)
m (Adjusted link after page move)
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{shortcut|JTTP}}Welcome to the Joomla! 1.5 Template Tutorials Project.  Here you will find information about how we are going about writing these fabulous new tutorials.  If you would like to volunteer to lend us a hand then please send an email to [mailto:chris.davenport@joomla.org Chris Davenport].
+
{{shortcut|JTTP|JDOC:TTP}}Welcome to the Joomla! 1.5 Template Tutorials Project.  Here you will find information about how we are going about writing these fabulous new tutorials.  If you would like to volunteer to lend us a hand then please send an email to [mailto:chris.davenport@joomla.org Chris Davenport].
  
 
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
 
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
  
 
== Introduction ==
 
== Introduction ==
New or potential contributors to this project should read the [[Introduction to the Template Tutorials Project|Introduction to the Template Tutorials Project]].
+
New or potential contributors to this project should read the [[/Introduction|Introduction to the Template Tutorials Project]].
 
The process of writing the new template tutorials is also an experiment in single source modular documentation.  The idea is that we write the material in "fragments" or "chunks" which can be re-used in a variety of contexts.  In order for this to work, we need to write the chunks in a context-free manner so that they can be assembled into different output documents in any sequence.  In other words we need to ensure that each chunk still makes sense even when taken out of context.
 
The process of writing the new template tutorials is also an experiment in single source modular documentation.  The idea is that we write the material in "fragments" or "chunks" which can be re-used in a variety of contexts.  In order for this to work, we need to write the chunks in a context-free manner so that they can be assembled into different output documents in any sequence.  In other words we need to ensure that each chunk still makes sense even when taken out of context.
  
 
The following is the current Table of Contents for the Template Tutorials:
 
The following is the current Table of Contents for the Template Tutorials:
{{Tutorial:Table of Contents}}
+
{{:Joomla! 1.5 Template Tutorial/Table of Contents}}
  
 
== How to do stuff ==
 
== How to do stuff ==
Line 15: Line 15:
  
 
== Stuff you need to refer to ==
 
== Stuff you need to refer to ==
* [[Outline_for_Template_Tutorials|Outline of the Template Tutorials]]
+
* [[/Outline|Outline of the Template Tutorials]]
 
*: This has been produced as a starting point.  The tutorials listed on the main page show how one document can been produced by automatically assembling, on the fly, fragments which are stored and managed as individual wiki pages.  Click on the Edit tab and see how the source for each of these tutorials is simply a list of references to modules.  There is no actual content in any of them.
 
*: This has been produced as a starting point.  The tutorials listed on the main page show how one document can been produced by automatically assembling, on the fly, fragments which are stored and managed as individual wiki pages.  Click on the Edit tab and see how the source for each of these tutorials is simply a list of references to modules.  There is no actual content in any of them.
* [[Template Tutorial Guidelines|Template Tutorial Guidelines]]
+
* [[/Guidelines|Template Tutorial Guidelines]]
 
*: These guidelines will help us to keep some consistency over all the tutorials where multiple authors are working on different sections of the material.  They will be continuously revised and refined in the light of experience.
 
*: These guidelines will help us to keep some consistency over all the tutorials where multiple authors are working on different sections of the material.  They will be continuously revised and refined in the light of experience.
* [[Who is working on what]]
+
* [[JDOC:Who is working on what]]
 
*: If you want to work on one or more pages of the documentation then please update this page so we don't get duplication of effort.  If you want to collaborate with someone on one or more pages, that's fine too of course; you can use this page to find out who to contact.
 
*: If you want to work on one or more pages of the documentation then please update this page so we don't get duplication of effort.  If you want to collaborate with someone on one or more pages, that's fine too of course; you can use this page to find out who to contact.
  
Line 59: Line 59:
 
* [[:Category:Plugins|Plugins]]
 
* [[:Category:Plugins|Plugins]]
 
* [[:Category:Templates|Templates]]
 
* [[:Category:Templates|Templates]]
[[Category:Templates]]
+
<noinclude>[[Category:Templates]][[Category:Documentation Working Group]]</noinclude>

Revision as of 17:32, 15 January 2011

Shortcuts:
JTTP
JDOC:TTP

Welcome to the Joomla! 1.5 Template Tutorials Project. Here you will find information about how we are going about writing these fabulous new tutorials. If you would like to volunteer to lend us a hand then please send an email to Chris Davenport.

Consult the User's Guide for information on using the wiki software.

Contents

Introduction

New or potential contributors to this project should read the Introduction to the Template Tutorials Project. The process of writing the new template tutorials is also an experiment in single source modular documentation. The idea is that we write the material in "fragments" or "chunks" which can be re-used in a variety of contexts. In order for this to work, we need to write the chunks in a context-free manner so that they can be assembled into different output documents in any sequence. In other words we need to ensure that each chunk still makes sense even when taken out of context.

The following is the current Table of Contents for the Template Tutorials:

  • J1.5:Getting Started with Templates
  • Understanding Joomla! templates
  • J1.5:Customising the Milky Way template
  • J1.5:Customising the Beez template
  • J1.5:Customising the JA Purity template
  • Creating a basic Joomla! template
  • More advanced Joomla! templates
  • Customising the way modules are displayed
  • J1.5:Template parameters
  • How to override the output from the Joomla! core|Template overrides
  • Making templates translatable
  • Distributing Joomla! templates
  • Advanced topics
  • Template reference material


How to do stuff

Stuff you need to refer to

  • Outline of the Template Tutorials
    This has been produced as a starting point. The tutorials listed on the main page show how one document can been produced by automatically assembling, on the fly, fragments which are stored and managed as individual wiki pages. Click on the Edit tab and see how the source for each of these tutorials is simply a list of references to modules. There is no actual content in any of them.
  • Template Tutorial Guidelines
    These guidelines will help us to keep some consistency over all the tutorials where multiple authors are working on different sections of the material. They will be continuously revised and refined in the light of experience.
  • JDOC:Who is working on what
    If you want to work on one or more pages of the documentation then please update this page so we don't get duplication of effort. If you want to collaborate with someone on one or more pages, that's fine too of course; you can use this page to find out who to contact.

Content Categories

The following sections on this page list category pages for all the principal categories required for the Template Tutorials Project. You can use these pages to help you find a suitable module to include (or rather transclude) into a compound document. You can't create new chunk pages using these pages.

Contents by Chunk Type

  • Primary chunks (listed alphabetically)
    • Definition lists
      These are most commonly used to list components, so for example, we might create a definition list which lists the names of the principal files contained within a template and introduce the purpose of each.
    • Glossaries
      These are a specific form of definition list that defines technical terms.
    • Procedures
      These are step-by-step instructions that explain how to perform tasks.
    • Processes
      These are similar to procedures and topics. Processes differ from procedures in that they are narrative rather than imperative. They explain what someone or something does (declarative), not what users should do (imperative).
    • Topics
      These are texts that answer specific questions.
    • Troubleshooting scenarios
      These are a hybrid of topics and procedures. Each scenario explains one problem and its solution.

Secondary chunks are always included into primary chunks. They are never used directly. Secondary chunks can be constructed separately, although they don't have to be. For example, figures will probably be constructed using a separate graphics package and may well be produced by a graphic artist working independently within the documentation team. Secondary chunks can be re-used within different primary chunks. Documents are assembled from primary chunks only; secondary chunks must be integrated into primary chunks before they are used.

Contents by User Experience Level

Contents by Joomla! Resource Type