> For the complete documentation index, see [llms.txt](https://xoops.gitbook.io/modulebuilder-tutorial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xoops.gitbook.io/modulebuilder-tutorial/2administration/fields.md).

# Fields

## 1. Overview

![](/files/-M71kBoUuGgTN1kpCpkT)

*Figure 7: Fields (Admin side)*

Here you can see the tables, and you can edit the table settings, or you can edit the fields

![](/files/-M71kBoVA3555oQ6tP_2)

*Figure 8: Expanding fields View (Admin side)*

Before you go to edit the individual fields, you can click on the left icon - it will expand the table showing all the fields. You can then change the visibility of each field, i.e. if it will be visible in the list and in the form for Admin, as well as for the User

![](/files/-M71kBoW1Tq1M0WiOi1q)

*Figure 9: Fields details (Admin side)*

Here you can edit the details for each field.

## 2. Edit fields

![](/files/-M8JK4K7I3gwWAuROvdZ)

### General recommendations

It is recommended to create following fields:

* date field: for sorting items by date it is necessary to have a field, where date of creation/relevant date is stored
* submitter field: for sorting items by submitter it is necessary to have a field, where user of creation is stored
* field status: for using e.g. functions for broken items you need a 'Select Status'-field

It is recommended to use a table prefix plus singular words, e.g. 'cat\_logo' for logo image of the category.

### Fields

#### Field name

Enter a unique field name

#### Form Element

You can select between following form elements:

* Textbox
* Plain TextArea Field
* Selectable Editor (Dhtml)
* CheckBox
* Radio Yes/No
* Select Listbox
* Select User Field
* Color Picker Field
* Image List
* Select File Field
* Url File Field
* Upload Image Field
* Upload File Field
* Date Select Field
* Select Status Field
* Password Field
* Select Country List
* Select Language List
* Date/Time Select Field
* Select Combobox
* Radio

#### Type

Please define the field type, e.g. VARCHAR, INT, ...

Depending on your selection in form element a type will be automatically suggested

#### Value

Please define the size

Depending on your selection in form element a size will be automatically suggested

#### Attribute

Please define the field attributes

#### Null

Please define whether null is allowed or not

#### Default

Please define default value for new items

#### Key

Please define the key, if you want to add one

#### Parameters

* Field: Is parent => ???
* Admin: In Files => field will be added to admin files
* Admin: Visible in list => field will be visible in admin list
* Admin: Visible in form => field will be visible in admin form
* User: In Files => field will be added to user files
* User index: in header => field will be visible in header of index file
* User index: in body => field will be visible in body of index file
* User index: in footer => field will be visible in footer of index file
* User file: in header => field will be visible in header of table file
* User file: in body => field will be visible in body of table file
* User file: in footer => field will be visible in footer of table file
* Block: In Files => field will be visible in blocks
* Search: Index => field will be used in search function 
* Field: Required => field will be an obligatory field
* Table: Main Field => field will be the main field of this table (only one field can be main field)

Recommendations:

* You shouldn't add a field in header and/or body and/or footer in the same time
* If you select "User: In Files" you should display the field minimum one time in index or table file


---

# 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 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/modulebuilder-tutorial/2administration/fields.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.