Update fields.md #1142
Update fields.md #1142
Conversation
❌ Deploy Preview for moodledevdocs failed.Built without sensitive environment variables
|
There was a problem hiding this comment.
Hi,
Thank you for taking the time to work on this documentation.
I'm afraid that, in its current form, it doesn't really add much to our documentation. A lot of the information mentions a specific version of Moodle, details general best-practice, and adds a lot of 'fluff'.
We try to keep our developer documentation as clear and concise as possible.
I would suggest you take a look at other documentation in this repository to see how we structure things. I'd suggest looking at some of our more complete pages as a starting point like, for example, the Hooks API.
Thanks again
|
|
||
| The [Database activity](https://docs.moodle.org/en/Database_module) included with Moodle includes support for several predefined [field types](./fields.md), including text, date, and URL. It is also possible to create new field types. For example, you might like to create: | ||
| # Database Fields for Moodle 4.4.3 |
There was a problem hiding this comment.
Please remove version details from docs.
| The [Database activity](https://docs.moodle.org/en/Database_module) included with Moodle includes support for several predefined [field types](./fields.md), including text, date, and URL. It is also possible to create new field types. For example, you might like to create: | ||
| # Database Fields for Moodle 4.4.3 | ||
|
|
||
| *This documentation is a work-in-progress. Feel free to contribute.* |
There was a problem hiding this comment.
Please remove.
This is already a draft document, though you've removed that in your efforts.
| --- | ||
| title: Database fields | ||
| tags: | ||
| - mod_data | ||
| - datafield | ||
| - plugintype | ||
| - subplugin | ||
| documentationDraft: true | ||
| --- |
There was a problem hiding this comment.
Please do not remove this. This is the page information, tags, title, and other metadata.
|
|
||
| ## Custom Field Types Examples | ||
|
|
||
| - **Discipline-specific field types**: |
There was a problem hiding this comment.
Please use sub-headings here.
Using Bold/Strong does not create semantic markup. Instead it creates content which is visually styled only.
|
|
||
| *This documentation is a work-in-progress. Feel free to contribute.* | ||
|
|
||
| The **Database activity** in Moodle allows users to create structured collections of data. It supports various predefined field types like **text**, **date**, and **URL**. Developers can extend Moodle by creating custom field types, which are beneficial for specialized uses like discipline-specific, institution-specific, or module-specific needs. |
There was a problem hiding this comment.
I don't think any of these things need to be bolded. THe individual types could use backticks.
| The **Database activity** in Moodle allows users to create structured collections of data. It supports various predefined field types like **text**, **date**, and **URL**. Developers can extend Moodle by creating custom field types, which are beneficial for specialized uses like discipline-specific, institution-specific, or module-specific needs. | |
| The **Database activity** in Moodle allows users to create structured collections of data. It supports various predefined field types like `text`, `date`, and `URL`. Developers can extend Moodle by creating custom field types, which are beneficial for specialized uses like discipline-specific, institution-specific, or module-specific needs. |
| Custom field plugins should be tested for compatibility across Moodle 4.4.3's supported environments, including: | ||
|
|
||
| - **PHP 8.1** | ||
| - **MariaDB 10.6.7** | ||
| - **MySQL 8.0** | ||
| - **PostgreSQL 13** | ||
| - **MSSQL 2017** | ||
| - **Oracle 19c** |
There was a problem hiding this comment.
Please remove. This information will very quickly go out-of-date. It is also true of all features of Moodle. We do not write this on every page.
|
|
||
| :::danger Class locations | ||
| Use Moodle's [unit testing framework](https://moodledev.io/docs/apis/core/testing/phpunit) for automated testing to ensure functionality across different environments. |
There was a problem hiding this comment.
Please do not use full links. See other examples in the documentation.
| --- | ||
|
|
||
| **Last Updated**: 2 October 2024 | ||
|
|
||
| --- |
There was a problem hiding this comment.
Remove. This is automatically tracked by our documentation systems and version control.
| ## Key Considerations for Moodle 4.4.3: | ||
|
|
||
| ::: | ||
| - Use **updated coding standards** to align with Moodle's guidelines for PHP 8.1. | ||
| - Implement **security features** to avoid vulnerabilities. | ||
| - Ensure **compatibility** across Moodle's supported environments. | ||
| - Follow **best practices** for form creation and plugin configuration management. | ||
|
|
||
| By following these guidelines, developers can ensure their custom field types are secure, modern, and compatible with future Moodle releases. |
There was a problem hiding this comment.
Remove - unnecessary and standard across all code.
| - Use Moodle's **Git version control** system. | ||
| - Maintain proper versioning for compatibility with Moodle's plugin directory and version upgrades. | ||
|
|
||
| Developers should submit and maintain their plugins in the [Moodle Plugin Directory](https://moodle.org/plugins). | ||
|
|
||
| --- |
There was a problem hiding this comment.
Remove. Standard across Moodle
|
Closing due to lack of information. |
No description provided.