From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide/doc_style/index.html | 87 ------------------------- user_guide/doc_style/template.html | 128 ------------------------------------- 2 files changed, 215 deletions(-) delete mode 100644 user_guide/doc_style/index.html delete 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 deleted file mode 100644 index 27a1756e7..000000000 --- a/user_guide/doc_style/index.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - - -Writing Documentation : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

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 deleted file mode 100644 index d59d5e4ed..000000000 --- a/user_guide/doc_style/template.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - -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

- -

Within a text string, highlight variables using <var></var> tags, and highlight code using the <dfn></dfn> tags.

- -

Sub-heading

- -

Put code examples within <code></code> tags:

- - - $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