Code Monkey home page Code Monkey logo

manual's Introduction

Joomla! Programmers documentation

This repository should hold all Joomla! documentation needed to develop extensions.

The Documentation can be found at https://manual.joomla.org

Development

This website is built using Docusaurus 3, a modern static website generator.

Installation

$ npm install

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Preview for pull request

As part of the documentation validation we create a subdomain for previewing your pull request. The Link will be added to the "checks" section in the pull request as "preview". The url used is http://pr-[prnumber].manual.joomlacode.org

How to use

Unfinished sections

Please use the following placeholder for unfinished sections of a document.

:::note[TODO]
  This section is missing, please use the **Edit this Page** link at the bottom of this page to add this section.
:::

If the page is not completed yet and bigger parts are missing use

:::caution[TODO]
  This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
:::

Using admonitions

Full reference could be found at Docusaurus documentation. We don't use blank lines around content, and we add 2 spaces before the text messages.

:::note[Developer Note]
  Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::

:::tip
  Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::

:::info
  Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::

:::warning
  Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::

:::danger
  Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::

manual's People

Contributors

bembelimen avatar brianteeman avatar carlitorweb avatar ceford avatar chmst avatar dgrammatiko avatar drmenzelit avatar elfangor93 avatar fedik avatar hackwar avatar heelc29 avatar hleithner avatar joomla-dependency-bot avatar ladysolveig avatar laoneo avatar macjoom avatar manuelhu avatar nikosdion avatar obuisard avatar pe7er avatar rabahalishah avatar razzo1987 avatar rdeutz avatar renovate-bot avatar richard67 avatar robbiejackson avatar roland-d avatar snipersister avatar softforge avatar wilsonge avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

manual's Issues

New Pages

I have at least two pages/sections that I need to write.

  1. making the list view accessible
  2. adding table-columns.js to the list view

Do I just write them as standalone pages for someone to add in the appropriate place or ....?

PHP Requirements for Joomla 5

Reported from joomla/joomla-cms#42887

Is your feature request related to a problem? Please describe.

Fresh install of Joomla 5 on server throws Error 500 unless following PHP Moddule is selected:

nd_mysql

This is the case for Joomla 5 when using PHP 8.1 or 8.2

Describe the solution you'd like

Add nd_mysql to the list under More Information for Joomla! 5 at:

https://manual.joomla.org/docs/next/get-started/technical-requirements/

List currently reads:

Modules: json, simplexml, dom, gd, mysqlnd or pgsql

Should it read:

Modules: json, simplexml, dom, gd, nd_mysqli, mysqlnd or pgsql

Additional context

Only observed the above on server run my one UK hosting provider

[jdev] Developing an MVC component for Joomla4 is incomplete

Hi,
I'm not sure if this is the correct place but I was following this MVC tutorial https://docs.joomla.org/Special:MyLanguage/J4.x:Developing_an_MVC_Component but it is incomplete.
As of this page https://docs.joomla.org/J4.x:Developing_an_MVC_Component/Our_First_Backend_Page there is no text any more, and I don't know if the tutorial of Joomla3 is ok to follow for this part in case of inconsistencies.
Also asked at the joomla.org forum. No response yet.
For my next project I'd like to build it as a Component in Joomla instead of a php based website on its own.

Thanks.
Regards,
Jerry

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • Lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm
package.json
  • @cmfcmf/docusaurus-search-local ^1.1.0
  • @docusaurus/core 3.2.1
  • @docusaurus/plugin-sitemap ^3.2.1
  • @docusaurus/preset-classic 3.2.1
  • @docusaurus/theme-mermaid 3.2.1
  • @mdx-js/react ^3.0.0
  • clsx ^1.2.1
  • prism-react-renderer ^2.1.0
  • react ^18.2.0
  • react-dom ^18.2.0
  • react-icons ^4.12.0
  • @docusaurus/module-type-aliases 3.2.1
  • node >=18.0
  • @docusaurus/core ^3.1.0

Joomla Documentation Developer Portal needs to be updated

This issue refers to the following page in the Joomla documentation:
https://docs.joomla.org/Portal:Developers.
The portal page in the Joomla documentation does not yet contain any information specific to the J4 version and does not yet contain a reference to the https://manual.joomla.org website.

The last minor change to the page was made in Apr 2020.

I am asking for suggestions on what obsolete content should be removed and what new information needs to be added. (With a JDoc account, the wiki can also be edited directly).

Search box

I think this is an upstream issue but I couldn't find out where so I am just flagging it up for now as something to check

The search box generates code that includes the code
aria-labelledby="autocomplete-0-label"

There is no label of that name so this results in an invalid aria error

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.