[Docs] *** DOCUMENTATION CONTENTS ***

Hotaru CMS Documentation

Contents

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

1. Getting Started with Hotaru CMS

Guides for installing, upgrading, managing your files, themes and plugins, and what to do if you get stuck.

Introduction

• What is Hotaru CMS?

Installation & Upgrading

• Installing Hotaru CMS
• Organizing Your Files for a Hassle-Free Upgrade
• Example .htaccess Files

Admin

• Admin Settings Page - About
• About Debug Mode

Plugins

• Installing Your First Plugins
• How to Upgrade a Plugin

Widgets

• Setting Up Posts Widgets
  

​

2. Design and Layout

Guides to help you understand how Hotaru themes work and how to create them.

General

• Steps to Making a Custom Theme
• Themes: A Guide to index.php
• Designing around Plugin Hooks
• Customizing Plugin Templates
• Internal Linking
• How to Make a Theme Settings Page

Header

• Change the Title to a Logo
• About the Title Tags

Sidebars

• Hiding the Sidebar
• How to Add Another Sidebar
• Making Custom Widgets

Pages

• Getting the Page Name
• Create a Page
• Using Pagination

Users

• Changing the Default Avatar
• Showing User Avatars
• Adding Extra Profile Fields

​

3. Developing Plugins

Guides to help you build your own plugins for Hotaru CMS.

Plugin Basics

• The Hotaru Cycle
• Overview of Hotaru Plugins
• Use the PEAR Coding Standards
• Global Constants and Variables
• Plugin Dependencies - Plugin A requires Plugin B
• Displaying Content with a Plugin
• Extending Plugins
• Adding Content to User Profiles

Case Studies

• Making a Plugin - Case Study 1: Hello World
• Making a Plugin - Case Study 2: Hello World Widget
• Making a Plugin - Case Study 3: Tweet This

Plugin Hooks

• Working with Plugin Hooks
• header_include Versus header_include_raw
• Testing for Active Plugins

Passing Parameters

• Passing Arguments within a Plugin
• Making Friendly URLs
• Custom Inspekt Functions

Installation and Settings

• Install and Upgrade Functions
• Save and Access Plugin Settings
• Creating a Plugin Settings Page
• Adding Permissions
• Adding User Settings

Using the Database

• Working Directly with the Database
• Extra ezSQL Functions
• Hotaru's Different Caching Methods

Including Files

• Language Files for Plugins
• Including Template, Language, JavaScript and CSS Files in a Plugin

Notices and Error Messages

• Display Success and Failure Messages
• Logging Results to a File

Miscellaneous

• Changing the Meta Tags
• Adding Extra Post Information

​