PDA

View Full Version : [Docs] *** DOCUMENTATION CONTENTS ***



Nick
09-23-2009, 07:14 AM
Hotaru CMS Documentation

Contents

This page is a work-in-progress...

1. Getting Started with Hotaru CMS
(http://hotarucms.org/forumdisplay.php?f=20)
Guides for installing, upgrading, managing your files, themes and plugins, and what to do if you get stuck.

Introduction


What is Hotaru CMS? (http://hotarucms.org/showthread.php?t=66)

Installation & Upgrading


Installing Hotaru CMS (http://hotarucms.org/showthread.php?t=14)
Organizing Your Files for a Hassle-Free Upgrade (http://hotarucms.org/showthread.php?t=46)
Example .htaccess Files (http://hotarucms.org/showthread.php?276-Example-htaccess-Files)

Admin


Admin Settings Page - About (http://hotarucms.org/showthread.php?t=91)
About Debug Mode (http://hotarucms.org/showthread.php?367-About-Debug-Mode)

Plugins


Installing Your First Plugins (http://hotarucms.org/showthread.php?335-Installing-Your-First-Plugins&p=1319)
How to Upgrade a Plugin (http://hotarucms.org/showthread.php?t=95)

Widgets


Setting Up Posts Widgets
(http://hotarucms.org/showthread.php?t=224)

2. Design and Layout (http://hotarucms.org/forumdisplay.php?f=15)
Guides to help you understand how Hotaru themes work and how to create them.

General


Steps to Making a Custom Theme (http://hotarucms.org/showthread.php?t=86)
Themes: A Guide to index.php (http://hotarucms.org/showthread.php?t=6)
Designing around Plugin Hooks (http://hotarucms.org/showthread.php?t=101)
Customizing Plugin Templates (http://hotarucms.org/showthread.php?t=26)
Internal Linking (http://hotarucms.org/showthread.php?t=186)
How to Make a Theme Settings Page (http://hotarucms.org/showthread.php?389-How-to-Make-a-Theme-Settings-Page)

Header


Change the Title to a Logo (http://hotarucms.org/showthread.php?t=168)
About the Title Tags (http://hotarucms.org/showthread.php?t=52)

Sidebars


Hiding the Sidebar (http://hotarucms.org/showthread.php?t=207)
How to Add Another Sidebar (http://hotarucms.org/showthread.php?t=64)
Making Custom Widgets (http://hotarucms.org/showthread.php?t=225)

Pages


Getting the Page Name (http://hotarucms.org/showthread.php?t=206)
Create a Page (http://hotarucms.org/showthread.php?t=220)
Using Pagination (http://hotarucms.org/showthread.php?354-Using-Pagination)

Users


Changing the Default Avatar (http://hotarucms.org/showthread.php?t=205)
Showing User Avatars (http://hotarucms.org/showthread.php?337-Showing-User-Avatars)
Adding Extra Profile Fields (http://hotarucms.org/showthread.php?t=226)

3. Developing Plugins (http://hotarucms.org/forumdisplay.php?f=14)
Guides to help you build your own plugins for Hotaru CMS.

Plugin Basics


The Hotaru Cycle (http://hotarucms.org/showthread.php?t=121)
Overview of Hotaru Plugins (http://hotarucms.org/showthread.php?t=124)
Use the PEAR Coding Standards (http://hotarucms.org/showthread.php?t=67)
Global Constants and Variables (http://hotarucms.org/showthread.php?t=130)
Plugin Dependencies - Plugin A requires Plugin B (http://hotarucms.org/showthread.php?t=31)
Displaying Content with a Plugin (http://hotarucms.org/showthread.php?t=17)
Extending Plugins (http://hotarucms.org/showthread.php?339-Extending-Plugins)
Adding Content to User Profiles (http://hotarucms.org/showthread.php?478-Adding-Content-to-User-Profiles)

Case Studies


Making a Plugin - Case Study 1: Hello World (http://hotarucms.org/showthread.php?t=3)
Making a Plugin - Case Study 2: Hello World Widget (http://hotarucms.org/showthread.php?t=65)
Making a Plugin - Case Study 3: Tweet This (http://hotarucms.org/showthread.php?267-Making-a-Plugin-Case-Study-3-Tweet-This)

Plugin Hooks


Working with Plugin Hooks (http://hotarucms.org/showthread.php?t=11)
header_include Versus header_include_raw (http://hotarucms.org/showthread.php?t=122)
Testing for Active Plugins (http://hotarucms.org/showthread.php?620-Testing-for-Active-Plugins)

Passing Parameters


Passing Arguments within a Plugin (http://hotarucms.org/showthread.php?t=10)
Making Friendly URLs (http://hotarucms.org/showthread.php?t=19)
Custom Inspekt Functions (http://hotarucms.org/showthread.php?t=20)

Installation and Settings


Install and Upgrade Functions (http://hotarucms.org/showthread.php?t=185)
Save and Access Plugin Settings (http://hotarucms.org/showthread.php?t=9)
Creating a Plugin Settings Page (http://hotarucms.org/showthread.php?t=57)
Adding Permissions (http://hotarucms.org/showthread.php?129-Adding-Permissions)
Adding User Settings (http://hotarucms.org/showthread.php?361-Adding-User-Settings)

Using the Database


Working Directly with the Database (http://hotarucms.org/showthread.php?t=63)
Extra ezSQL Functions (http://hotarucms.org/showthread.php?328-Extra-ezSQL-Functions)
Hotaru's Different Caching Methods (http://hotarucms.org/showthread.php?269-Hotaru-s-Different-Caching-Methods)

Including Files


Language Files for Plugins (http://hotarucms.org/showthread.php?t=44)
Including Template, Language, JavaScript and CSS Files in a Plugin (http://hotarucms.org/showthread.php?t=45)

Notices and Error Messages


Display Success and Failure Messages (http://hotarucms.org/showthread.php?t=33)
Logging Results to a File (http://hotarucms.org/showthread.php?366-Logging-Results-to-a-File)

Miscellaneous


Changing the Meta Tags (http://hotarucms.org/showthread.php?t=165)
Adding Extra Post Information (http://hotarucms.org/showthread.php?341-Adding-Extra-Post-Information)