Here we present topics to work on for the user documentation:
- Overview pages.
- Schema.org structured data.
- Custom Fields.
- A tutorial about content management with Joomla.
- How-to guides with mod_articles
- Tutorial: Add a module to the Dashboard
- Template overrides.
- Joomla 5 articles in the wiki, not yet in this user manual
- Useful Magazine Articles
Overview pages
A principle in documentation is to always give an overview when you have nested menu-items. See https://diataxis.fr/complex-hierarchies/ for an explanation (there thet talk about "landing pages" or "content pages", but the idea is the same). When you look at our current user manual, you see a lot of "headers" that expand to show the menu-items under it. But those current headers themselves don't refer to a page. This should be pages that give an overview of what is in them at the moment.
In our current user manual we should have an overview page for "User Manual", "Getting Started", "Articles" etc. showing what you can find in the underlaying articles. This is also a great way to become acquainted with the current user manual, for you have to look what is in the undelying pages.
Please keep in mind that we are restructuring the content. So the current headings may change. One of the changes will be a clustering of pages around the following themes:
- Content Management with Joomla (creating, updating and publishing articles, categories, menu-items, etc)
- Maintaining a Joomla site (updates, backups, user management, etc)
- Building a Joomla site (installing Joomla, templates & design, extensions, etc)
Schema.org structured data
This is missing at the moment in the user manual. In Joomla since version 5.1.
What we need most:
- a tutorial explaining the basics of structured data and the schema.org implementation in Joomla
- guides how to configure the existing plugins
- a tutorial how to make a new schema-plugin (this is halfway the user manual and the developer manual)
Background material:
- in the wiki: https://docs.joomla.org/J5.x:Schema_orghttps://docs.joomla.org/J5.x:Schema_org and following pages (many empty)
- external blogs: https://romankoff.com/eng/blog/joomla/schema-markup-joomla , https://kevinsguides.com/guides/webdev/joomla/content/joom-schema/ and video https://www.youtube.com/watch?v=3FdI2Icn_4I
- this article by Tassos mentiones schema.org in the broader frame of SEO: https://www.tassos.gr/blog/tutorials/joomla-seo. Tassos also has a good Schema and structured data extension. More structured data extensions can be found on the JED.
- magazine: https://magazine.joomla.org/all-issues/september/rich-snippets-in-joomla-5 (2023) and much older (2014): https://magazine.joomla.org/all-issues/august-2014/rich-snippets-structured-data-microdata-rdfa-isnt-so-simple
- also see forum: https://forum.joomla.org/viewtopic.php?t=1006362
- all background information about schema.org on.... https://schema.org/
Custom Fields
Needed:
- a tutorial explaning how to use custom fields; now: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
- Of all the articles currently under "fields" there are 4 general articles (fields and field groups, field parameters, multilingual sites, and template overrides). They are on the same level with the 15 types of custom fields and one article about a special custom field: subform. Can you come up with a better structure instead of putting all those articles on the same level? if you need a deeper layer, don't forget the overview page.
- a how-to guide about how to repeat custom fields (using a subform).
- example of using nested subforms in custom fields (new since 5.2).
- a reference (overview) of all custom fields + short description.
- tutorial about template overrides. see https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides
See the series about custom fields by Marc Dechèvre in the Magazine:
- JCM March 2018, episode 1: How far can we go with Joomla! and Custom Fields?
- JCM May 2018 episode 2: how to manage your Custom Fields
- JCM October 2018 episode 3: all the parameters one can wish for
- JCM April 2020 episode 4: a step by step tutorial
- JCM July 2021 episode 5: List of Resources (no need to list them here again, but this is avery useful reference)
- JCM August 2021 episode 6: Make more with extensions
- JCM October 2021 episode 7.1: one Custom Field to rule them all
- JCM November 2021 episode 7.2: without limits
Is there anything in those articles that should be in the documentation?
Tutorials about content management
- a series of tutorials that shows beginners how articles, menus and categories play together in Joomla.
- in the current user manual those topics are scattered under several headings (getting started, articles, menus). We especially need some articles that show the relation between the several parts. For instance you can set some general values in the articles options, but you can also set those values in the options-tab of an article or of a menu-item. In addition, you can also adjust the settings in the settings of a category.
- we are restructuring the content of the manual: now it is mainly an alphabetical listing, but we want to put things that belong together more together. All those things about articles, menu's and categories will be under one heading of Content management.
How-to guides with mod_articles
- Accordion Override for Articles Module
- How to create an Advent Calendar using the new Articles Module in Joomla 5.2
Also: update https://docs-core.sandbox.joomla.org/user-manual/modules/modules-site-modules for mod_articles.
Tutorial: Add a module to the Dashboard
Template overrides and alternate view templates
- Joomla Improved Override Management
- Template Overrides - Recycle and reuse
- Managing Template Overrides in Joomla (2024-12)
- Here is a good blogpost from Viviana (in German) about template overrides for frontend editing: https://www.dr-menzel-it.de/blog/override-challenge-beitrag-einreichen-im-frontend. This should definitely be in the documentation!
Joomla 5 articles in the wiki, not yet in this user manual
As far as not yet mentioned above.
- https://docs.joomla.org/J5.x:Add_a_class_selector_to_the_create_link_dialog (TinyMCE Editor)
- Auto Select Last Uploaded File (media manager)
- Conditional Field Display Customizing Forms Based on Global Settings
- Content Category Save to Menu (Category->Menu)
- Enhancing Password Security with Symbolic Characters (Login, Password) - is the article about User Password Security complete?
- How to Delete Access Levels with Table References should be added to https://docs-core.sandbox.joomla.org/user-manual/users/users-access-control. We need a good tutorial about setting up ACL (with example data); wasn't there a tutorial in the past by Sander Potjer?
- How to Search for Articles Checked Out by Users (Content Management)
- Improving SEO with Strict Routing and SEF URLs (SEO)
- Managing Mail Template Layout (Mail Templates, subject must be added) - was further enhanced after this article (?).
- Putting Managing Multiple Homepages in One Menu in https://docs-core.sandbox.joomla.org/user-manual/languages/languages-setup-a-multilingual-site - is the example in the blog sample data still valid? Should this article be splitted?
- Setting Up Your Local Environment. There now are comparible articles under "Getting Started" and "Testing". Will probably be a seperate topic about setting up a local environment.
- Whats New Guided Tour Introduction to New Features should be added to https://docs-core.sandbox.joomla.org/user-manual/help/help-guided-tours
Useful Magazine Articles
Some of these can be used as base for a documentation article.
Move to Developers Manual To-do List
- How to Use Event Classes for Plugin Development
- Selecting data using JDatabase
- Inserting Updating and Removing data using JDatabase