Documentation portal

Objective

The documentation system of the current dbxapp installation combines two types of documentation without technically mixing them:

1. Editorial documentation in dbxContent Manuals, tutorials, architectural texts, operating instructions, screenshots and media are maintained with the normal dbxapp tools. The relevant German version remains the source for translations.
2. Source code reference generated in Doxygen Classes, namespaces, files, methods and code examples are generated from the versioned source without editorial duplication.

The CMS is the portal. Doxygen is used as a static, versioned area under reference/current/ involved. This preserves search, class links and source references of Doxygen. The reference is made via the module dbxDocs embedded in the portal and can also be opened directly.

All public documentation sites are canonically under https://doku.dbxapp.de/. The documentation subdomain separates the comprehensive knowledge portal from the product website. On dbxapp.de/documentation/ Only permanent 301 redirects to the respective corresponding page of the documentation subdomain remain.

List structure

Editorial pages and technical reference lie together in the documentation installation. continues to be developed in the relevant dbxapp source; the reference run reads this source stock and updates only doku.dbxapp.de/reference. The product website and documentation portal remain clearly separated.

Design and navigation contract

The design dbxdocs used:

• the left, foldable basic layout of the design Flowers;
• Colors, components, forms, reports and windows of the blue dbxapp design;
• own, language-dependent documentation navigation;
• Four separate entry points for users, administrators, developers and AI.

The left navigation is provided by these module templates:

• dbxMenu|dbx-docs-main in German;
• dbxMenu|dbx-docs-main_en for English;

The CMS folders are language-dependent and form real submenus. German and English have fully linked page and folder trees; lng uid Connects each of the content brothers. The standard language remains German, English is under /en/ with own canonical permalinks. Pages have in addition to the full title a short menu title.

Doxygen is generated separately from the same product source in German and English. The generated files are under reference/current and reference/en; Source code and technical identifiers are not changed.

Design call

The Basic URL https://doku.dbxapp.de/ opens the portal directly in the standard design dbxdocs. The design applies uniformly to portal, search and embedded reference. The link to the dbxapp website deliberately leads to the separate product installation; Sessions, users and content are not required between domains.

Previous URLs under dbxapp.de/documentation/ with HTTP 301 are moved to the same path doku.dbxapp.de/ guided. Even old flat documentation and Doxygen URLs permanently point to their exact canonical target; a blanket forwarding only to the homepage is not permitted.

Doxygen

In the documentation installation:

Doxyfile writes after:

The output is reproduced entirely from the current source stock. The subsequent index run also integrates classes, methods, files and namespaces into the module search. dbxDocs.

The Doxygen header bar has the link for direct call Portal Back to the dbxContent homepage. Inside the portal dbxDocs Double navigation and branding. Internal Doxygen cross references remain in the embedded reference window.

Publication

Before publication:

1. Run source tests and Doxygen tests. Subsequently, the module dbxSelfTest Start at least the quick test, before a publication the complete test.
2. doxygen doxyfils End without error.
3. portal, at least one tutorial image and reference/current/ Check for status 200 via HTTP.
4. Check CMS submenus and the embedded areas of classes, namespaces, files and examples.
5. files/dbxError.log test; An existing, not empty file means system status Error.
6. Only then publish the tested dbxapp installation.

The Doxygen output is reproducible and is not processed manually. Editorial changes are made exclusively in dbxContent. Source code comments are changed locally and automatically transferred to the reference on the next Doxygen run.

Targeted versioned editorial pages are made of dbx/modules/dbxDocs/content/ Provisioned. The repeatable reconciliation reads:

The run only updates explicitly revised pages, supplements missing pages and then invalidates the content cache. Existing, unmarked CMS editorial team will be without --force Not overwritten.

Contribute and contribute corrections

Clues start with a specific page, the observed problem and – if possible – a reproducible example. Editorial corrections are maintained in dbxContent; Changes to PHP, JavaScript, CSS, DD or FD are made in the dbxapp development source and undergo the associated tests.

1. Record affected URL, target group and expected behavior.
2. Make changes to the canonical source, not to cache or Doxygen outputs.
3. Perform documentation self-test as well as affected product regression tests.
4. First publish the tested status and then create a new sitemap or reference.

In this way, small references remain just as comprehensible as extensive contributions. The Documentation and system self-test check the mandatory acceptance criteria.

Acceptance criteria

• left navigation visible and operated by keyboard;
• navigation can be folded in and out;
• blue dbxapp appearance without flowers-specific design;
• German and English CMS navigation loads completely;
• all tutorial media are delivered via dbxContent;
• Doxygen below reference/current/ accessible and embedded in the portal;
• The portal homepage is canonically below /, editorial subpages under /Documentation /;
• previous flat and former product domain documentation URLs deliver accurate 301 targets;
• Available installation and self-test instructions in the area of operation & security;
• portal backlink in Doxygen works;
• no unprocessed template placeholders;
• no PHP syntax errors and no new entry in dbxError.log’.