# Read me

#### *XOOPS Documentation Series*

![](https://xoops.org/images/logoXoops4GithubRepository.png)

## XOOPS 2.5x Module Developer Cookbook

**for XOOPS 2.5.10+**

#### for PHP 7.0+

Version 0.9

### Developer Guide

### View it on: [Gitbook](https://xoops.gitbook.io/xoops-modules-cookbook/)

© 2020 XOOPS Project ([www.xoops.org](https://xoops.org))

### Tutorial Purpose

This document is a Cookbook documenting the recommended structure for XOOPS 2.5.10+ modules, best practices, as well as recipes for common tasks

### How to Contribute

[You can contribute on GitHub](https://github.com/XoopsDocs/xoops-modules-cookbook) by forking the book repository, editing the markdown files with a text editor, and submitting the changes via a Pull Request

Changes will be [pushed to Gitbook.io automatically](https://xoops.gitbook.io/xoops-modules-cookbook/).

## Table of Content

* [Introduction](https://xoops.gitbook.io/xoops-modules-cookbook/introduction)
* [Our Standards](https://xoops.gitbook.io/xoops-modules-cookbook/coding-standards/standards)  
* [Best Practices](https://xoops.gitbook.io/xoops-modules-cookbook/best-practices/best-practices)
* [Database](https://xoops.gitbook.io/xoops-modules-cookbook/8database)
* [Classes](https://xoops.gitbook.io/xoops-modules-cookbook/core-classes/core)  
* [ModuleAdmin Framework](https://github.com/XoopsDocs/xoops-modules-cookbook/tree/9f27c9a1684fbde0620ee786441ea9cfe26df286/en/book/moduleadmin/moduleadmin.md)
* [Common Classes](https://xoops.gitbook.io/xoops-modules-cookbook/common-classes-traits/classes)  
* [Traits](https://xoops.gitbook.io/xoops-modules-cookbook/common-classes-traits/traits)  
* [Form Classes](https://xoops.gitbook.io/xoops-modules-cookbook/form-classes/forms)
* [Migration to Namespaces](https://xoops.gitbook.io/xoops-modules-cookbook/migration/namespaces-autoload)  
* [Module Configuration](https://xoops.gitbook.io/xoops-modules-cookbook/configuration/configuration)
* [Templates](https://xoops.gitbook.io/xoops-modules-cookbook/7templates)  
* [Credits](https://xoops.gitbook.io/xoops-modules-cookbook/about/9credits)
* [About XOOPS CMS](https://xoops.gitbook.io/xoops-modules-cookbook/about/10aboutxoops)

### License:

\
Unless specified, this content is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).

All derivative works are to be attributed to XOOPS Project ([www.xoops.org](https://xoops.org))


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xoops.gitbook.io/xoops-modules-cookbook/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.