# XMF Cookbook

## XMF Cookbook

- [Introduction](https://xoops.gitbook.io/xmf-cookbook/readme.md)
- [XMF Cookbook](https://xoops.gitbook.io/xmf-cookbook/xmf-cookbook.md)
- [Basic Ingredients](https://xoops.gitbook.io/xmf-cookbook/basic-ingredients.md)
- [Namespaces](https://xoops.gitbook.io/xmf-cookbook/basic-ingredients/namespaces.md)
- [Autoloading](https://xoops.gitbook.io/xmf-cookbook/basic-ingredients/autoloading.md)
- [Debugging](https://xoops.gitbook.io/xmf-cookbook/basic-ingredients/debugging.md)
- [Forward Compatibility](https://xoops.gitbook.io/xmf-cookbook/basic-ingredients/forward-compatibility.md)
- [Recipes](https://xoops.gitbook.io/xmf-cookbook/recipes.md)
- [Introducing Module Helpers](https://xoops.gitbook.io/xmf-cookbook/recipes/introducing-module-helpers.md)
- [Using the Permission Helper](https://xoops.gitbook.io/xmf-cookbook/recipes/using-the-permission-helper.md)
- [Checking Permissions](https://xoops.gitbook.io/xmf-cookbook/recipes/using-the-permission-helper/checking-permissions.md)
- [Managing Item Permissions](https://xoops.gitbook.io/xmf-cookbook/recipes/using-the-permission-helper/managing-item-permissions.md)
- [Using the Session Helper](https://xoops.gitbook.io/xmf-cookbook/recipes/using-the-session-helper.md)
- [Using JSON Web Tokens](https://xoops.gitbook.io/xmf-cookbook/recipes/using-json-web-tokens.md)
- [Altering Database Tables](https://xoops.gitbook.io/xmf-cookbook/recipes/altering-database-tables.md)
- [Migrating a Module's Database](https://xoops.gitbook.io/xmf-cookbook/recipes/migrating-a-modules-database.md)
- [Loading Initial Data](https://xoops.gitbook.io/xmf-cookbook/recipes/loading-initial-data.md)
- [Module Admin Pages](https://xoops.gitbook.io/xmf-cookbook/recipes/module-admin-pages.md)
- [Hide and Seek with Icons](https://xoops.gitbook.io/xmf-cookbook/recipes/module-admin-pages/hide-and-seek-with-icons.md)
- [Standard Admin Pages](https://xoops.gitbook.io/xmf-cookbook/recipes/module-admin-pages/standard-admin-pages.md)
- [Manage Metadata](https://xoops.gitbook.io/xmf-cookbook/recipes/manage-metadata.md)
- [Highlighting Content](https://xoops.gitbook.io/xmf-cookbook/recipes/highlighting-content.md)
- [Reference](https://xoops.gitbook.io/xmf-cookbook/reference.md)
- [Assert](https://xoops.gitbook.io/xmf-cookbook/reference/assert.md)
- [Assertions](https://xoops.gitbook.io/xmf-cookbook/reference/assert/assertions.md)
- [Database](https://xoops.gitbook.io/xmf-cookbook/reference/database.md)
- [Migrate](https://xoops.gitbook.io/xmf-cookbook/reference/database/migrate.md)
- [TableLoad](https://xoops.gitbook.io/xmf-cookbook/reference/database/tableload.md)
- [Tables](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables.md)
- [Getting Started](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/getting-started.md)
- [Table Operations](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/table-operations.md)
- [Working with Columns](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/working-with-columns.md)
- [Working with Indexes](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/working-with-indexes.md)
- [Changing Table Data](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/changing-table-data.md)
- [Interacting with the Work Queue](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/interacting-with-the-work-queue.md)
- [Error Info and Debugging](https://xoops.gitbook.io/xmf-cookbook/reference/database/tables/error-info-and-debugging.md)
- [Debug](https://xoops.gitbook.io/xmf-cookbook/reference/debug.md)
- [FilterInput](https://xoops.gitbook.io/xmf-cookbook/reference/filterinput.md)
- [Highlighter](https://xoops.gitbook.io/xmf-cookbook/reference/highlighter.md)
- [IPAddress](https://xoops.gitbook.io/xmf-cookbook/reference/ipaddress.md)
- [Jwt](https://xoops.gitbook.io/xmf-cookbook/reference/jwt.md)
- [JsonWebToken](https://xoops.gitbook.io/xmf-cookbook/reference/jwt/jsonwebtoken.md)
- [KeyFactory](https://xoops.gitbook.io/xmf-cookbook/reference/jwt/keyfactory.md)
- [TokenFactory](https://xoops.gitbook.io/xmf-cookbook/reference/jwt/tokenfactory.md)
- [TokenReader](https://xoops.gitbook.io/xmf-cookbook/reference/jwt/tokenreader.md)
- [Key](https://xoops.gitbook.io/xmf-cookbook/reference/key.md)
- [ArrayStorage](https://xoops.gitbook.io/xmf-cookbook/reference/key/arraystorage.md)
- [Basic](https://xoops.gitbook.io/xmf-cookbook/reference/key/basic.md)
- [FileStorage](https://xoops.gitbook.io/xmf-cookbook/reference/key/filestorage.md)
- [KeyAbstract](https://xoops.gitbook.io/xmf-cookbook/reference/key/keyabstract.md)
- [StorageInterface](https://xoops.gitbook.io/xmf-cookbook/reference/key/storageinterface.md)
- [Language](https://xoops.gitbook.io/xmf-cookbook/reference/language.md)
- [Metagen](https://xoops.gitbook.io/xmf-cookbook/reference/metagen.md)
- [Extracting Data](https://xoops.gitbook.io/xmf-cookbook/reference/metagen/extracting-data.md)
- [Applying Data](https://xoops.gitbook.io/xmf-cookbook/reference/metagen/applying-data.md)
- [Module](https://xoops.gitbook.io/xmf-cookbook/reference/module.md)
- [Admin](https://xoops.gitbook.io/xmf-cookbook/reference/module/admin.md)
- [Helper](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper.md)
- [Helper](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper-1.md)
- [AbstractHelper](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper-1/abstracthelper.md)
- [Cache](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper-1/cache.md)
- [GenericHelper](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper-1/generichelper.md)
- [Permission](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper-1/permission.md)
- [Session](https://xoops.gitbook.io/xmf-cookbook/reference/module/helper-1/session.md)
- [ProxyCheck](https://xoops.gitbook.io/xmf-cookbook/reference/proxycheck.md)
- [Random](https://xoops.gitbook.io/xmf-cookbook/reference/random.md)
- [Request](https://xoops.gitbook.io/xmf-cookbook/reference/request.md)
- [StopWords](https://xoops.gitbook.io/xmf-cookbook/reference/stopwords.md)
- [Uuid](https://xoops.gitbook.io/xmf-cookbook/reference/uuid.md)
- [Yaml](https://xoops.gitbook.io/xmf-cookbook/reference/yaml.md)
- [Credits](https://xoops.gitbook.io/xmf-cookbook/credits.md)
- [License:](https://xoops.gitbook.io/xmf-cookbook/license.md)
- [Table of Content](https://xoops.gitbook.io/xmf-cookbook/table-of-content.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://xoops.gitbook.io/xmf-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.