From 9fbf6730b18eeb55e6cd08dc26a9d2b6af2c7df0 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Mon, 21 Jan 2008 19:21:29 +0000 Subject: added user guide template for developers to use in their own projects --- user_guide/doc_style/index.html | 80 ++++++++++++++++++++++++ user_guide/doc_style/template.html | 124 +++++++++++++++++++++++++++++++++++++ 2 files changed, 204 insertions(+) create mode 100644 user_guide/doc_style/index.html create mode 100644 user_guide/doc_style/template.html (limited to 'user_guide/doc_style') diff --git a/user_guide/doc_style/index.html b/user_guide/doc_style/index.html new file mode 100644 index 000000000..eb78da1b7 --- /dev/null +++ b/user_guide/doc_style/index.html @@ -0,0 +1,80 @@ + + + + +CodeIgniter User Guide : Writing Documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

CodeIgniter User Guide Version 1.6.0

+
+ + + + + + + + + +
+ + +
+ + + +
+ +

Writing Documentation

+ +

To help facilitate a consistent, easy-to-read documentation style for CodeIgniter projects, Ellislab is making the markup and CSS from the CodeIgniter user guide freely available to the community for their use. For your convenience, a template file has been created that includes the primary blocks of markup used with brief samples.

+ +

Files

+ + + + +
+ + + + + + + \ No newline at end of file diff --git a/user_guide/doc_style/template.html b/user_guide/doc_style/template.html new file mode 100644 index 000000000..c01f85fb8 --- /dev/null +++ b/user_guide/doc_style/template.html @@ -0,0 +1,124 @@ + + + + +CodeIgniter Project Documentation Template + + + + + + + + + + + + + + + +
+ + + + + +

Project Title

+
+ + + + + + + + + +
+ + +
+ + + +
+ + +

Foo Class

+ +

Brief description of Foo Class. If it extends a native CodeIgniter class, please link to the class in the CodeIgniter documents here.

+ +

Important:  This is an important note with EMPHASIS.

+ +

Features:

+ + + +

Usage Heading

+ +

Description of using Foo. Highlight variables and filenames in regular text with the <var> tag, and code using the <dfn> tag.

+ + + $this->load->library('foo');
+
+ $this->foo->bar('bat'); + + + +

Table Preferences

+ +

Use tables where appropriate for long lists of preferences.

+ + + + + + + + + + + + + + + + + + + + + +
PreferenceDefault ValueOptionsDescription
fooFooNoneDescription of foo.
barBarbat, bag, or bakDescription of bar.
+ +

Foo Function Reference

+ +

$this->foo->bar()

+

Description

+$this->foo->bar('baz') + +
+ + + + + + + \ No newline at end of file -- cgit v1.2.3-24-g4f1b