docs: sync 54 repos
This commit is contained in:
@@ -4,6 +4,7 @@ Joomla Web Services plugin exposing DPCalendar events, calendars, and locations
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI) |
|
||||
|
||||
@@ -13,7 +14,7 @@ Joomla Web Services plugin exposing DPCalendar events, calendars, and locations
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [INSTALLATION](INSTALLATION) | - Joomla 5.x or 6.x |
|
||||
|
||||
---
|
||||
|
||||
@@ -21,7 +22,7 @@ Joomla Web Services plugin exposing DPCalendar events, calendars, and locations
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDPCalendarAPI](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDPCalendarAPI](https://git.mokoconsulting.tech/MokoConsulting/MokoDPCalendarAPI) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr module used to bridge multiple advertising services (Google Ads, Meta
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliAdInsights) |
|
||||
|
||||
@@ -13,25 +14,30 @@ A Dolibarr module used to bridge multiple advertising services (Google Ads, Meta
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [quickstart service](quickstart-service.-.-) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring the MokoDoliAdInsights modu... |
|
||||
| [quickstart service](quickstart-service.-.-) | This is a condensed guide for experienced developers. For detailed explanations, see [adding-service... |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [architecture](architecture) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the **MokoDoliAdInsights** module documentation. This module integrates multiple advertis... |
|
||||
| [architecture](architecture) | This document explains the technical architecture of the MokoDoliAdInsights module and how it achiev... |
|
||||
| [changelog](changelog) | All notable changes to the MokoDoliAdInsights module will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [adding services](adding-services.-.-) | ← [Home](Home) |
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [adding services](adding-services.-.-) | This guide walks you through adding support for a new advertising platform to |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -39,7 +45,7 @@ A Dolibarr module used to bridge multiple advertising services (Google Ads, Meta
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliAdInsights](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliAdInsights) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliAdInsights](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliAdInsights) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This guide walks you through adding support for a new advertising platform to
|
||||
## Overview
|
||||
|
||||
MokoDoliAdInsights uses a service-based plugin architecture. Adding a new
|
||||
platform requires **no changes to the factory or the admin setup page** —
|
||||
platform requires **no changes to the factory or the admin setup page** --
|
||||
`AdSystemFactory` discovers services automatically by scanning the
|
||||
`src/services/` directory at runtime.
|
||||
|
||||
@@ -23,7 +23,7 @@ are all populated automatically.
|
||||
|
||||
---
|
||||
|
||||
## Step 1 — Create the Service Directory and Class
|
||||
## Step 1 -- Create the Service Directory and Class
|
||||
|
||||
```bash
|
||||
cd src/services/
|
||||
@@ -39,8 +39,8 @@ require_once __DIR__.'/../BaseAdService.class.php';
|
||||
class YourPlatformService extends BaseAdService
|
||||
{
|
||||
/**
|
||||
* SERVICE_ID — unique lowercase identifier, no spaces.
|
||||
* SERVICE_NAME — human-readable display name shown in dropdowns.
|
||||
* SERVICE_ID -- unique lowercase identifier, no spaces.
|
||||
* SERVICE_NAME -- human-readable display name shown in dropdowns.
|
||||
*
|
||||
* These two constants trigger auto-discovery. No other file needs editing.
|
||||
*/
|
||||
@@ -114,7 +114,7 @@ class YourPlatformService extends BaseAdService
|
||||
|
||||
/**
|
||||
* Defines the credential fields shown in the admin configuration form.
|
||||
* These are rendered automatically by admin/setup.php — no edits needed there.
|
||||
* These are rendered automatically by admin/setup.php -- no edits needed there.
|
||||
*
|
||||
* 'secure' => true causes the value to be encrypted in the database.
|
||||
* 'placeholder' shown in the input field as a hint.
|
||||
@@ -165,7 +165,7 @@ class YourPlatformService extends BaseAdService
|
||||
|
||||
---
|
||||
|
||||
## Step 2 — Add Translations
|
||||
## Step 2 -- Add Translations
|
||||
|
||||
Edit `src/langs/en_US/mokodoliadinsights.lang` and add:
|
||||
|
||||
@@ -186,7 +186,7 @@ so adding translations is recommended but not strictly required.
|
||||
|
||||
---
|
||||
|
||||
## Step 3 — *(Optional)* Create a README
|
||||
## Step 3 -- *(Optional)* Create a README
|
||||
|
||||
Document platform-specific setup in
|
||||
`src/services/yourplatform/README.md`:
|
||||
|
||||
@@ -10,18 +10,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
## [Unreleased]
|
||||
|
||||
### Changed
|
||||
- **Module picto**: Updated module icon to Font Awesome `rectangle-ad` (classic/solid) — `fa-rectangle-ad` — across the module descriptor, Report object, and all admin/page headers.
|
||||
- **Module picto**: Updated module icon to Font Awesome `rectangle-ad` (classic/solid) -- `fa-rectangle-ad` -- across the module descriptor, Report object, and all admin/page headers.
|
||||
|
||||
### Added
|
||||
- **Google Ads, Facebook Ads, Microsoft Ads services**: Migrated to `BaseAdService` subclasses in `src/services/` (previously legacy clients in `src/class/`). Each service now exposes `getConfigurationFields()`, `getAvailableMetrics()`, `getCapabilities()`, and full PHPDoc.
|
||||
- **Per-service admin tabs**: Every ad platform has its own configuration tab in the Dolibarr admin panel, rendered by the new `admin/service.php` page. Tabs are populated automatically from `AdSystemFactory::getAvailableSystems()` — no file edits needed when adding a new service.
|
||||
- **Per-service admin tabs**: Every ad platform has its own configuration tab in the Dolibarr admin panel, rendered by the new `admin/service.php` page. Tabs are populated automatically from `AdSystemFactory::getAvailableSystems()` -- no file edits needed when adding a new service.
|
||||
- **`admin/service.php`**: Generic per-service credential configuration page. Validates the `?service=` parameter against the factory whitelist, renders `getConfigurationFields()` via `FormSetup`, and shows a configured/not-configured status indicator.
|
||||
- **Video Advertising Services**: Two new ad platform integrations for video campaigns
|
||||
- **YouTube Ads** (`youtubeads`): Integrates with Google Ads API v17 for YouTube video campaigns. Exposes video-specific metrics: video views, view rate, average CPE, engagements, and video completion quartiles (Q1/Q2/Q3/full).
|
||||
- **TikTok Ads** (`tiktokads`): Integrates with TikTok for Business Marketing API v1.3. Exposes TikTok video metrics: video play actions, 2-second views, 6-second views, completion quartiles, and average video play duration per user.
|
||||
- Both services declare `video_metrics` and `video_completion_tracking` capabilities.
|
||||
- **Real Claude AI Analysis**: `ClaudeAnalyzer::analyzeData()` now makes live HTTP requests to the Anthropic Messages API (`api.anthropic.com/v1/messages`) instead of returning static mock data.
|
||||
- **Auto-Discovery Service Architecture**: Adding a new ad platform service no longer requires editing any existing file. `AdSystemFactory` is pure auto-discovery — no hardcoded registrations.
|
||||
- **Auto-Discovery Service Architecture**: Adding a new ad platform service no longer requires editing any existing file. `AdSystemFactory` is pure auto-discovery -- no hardcoded registrations.
|
||||
- **Translation keys**: `ServiceSettingsPage`, `ServiceConfigured`, `ServiceNotConfigured` added.
|
||||
|
||||
### Changed
|
||||
@@ -30,10 +30,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- **`lib/mokodoliadinsights.lib.php`**: `mokodoliadinsightsAdminPrepareHead()` dynamically adds one tab per service from `AdSystemFactory::getAvailableSystems()`.
|
||||
|
||||
### Removed
|
||||
- `src/class/googleadsclient.class.php` — replaced by `src/services/google/GoogleAdsService.class.php`
|
||||
- `src/class/facebookadsclient.class.php` — replaced by `src/services/facebook/FacebookAdsService.class.php`
|
||||
- `src/class/microsoftadsclient.class.php` — replaced by `src/services/microsoft/MicrosoftAdsService.class.php`
|
||||
- `src/class/adsystemclientinterface.class.php` — superseded by `src/services/AdServiceInterface.class.php`
|
||||
- `src/class/googleadsclient.class.php` -- replaced by `src/services/google/GoogleAdsService.class.php`
|
||||
- `src/class/facebookadsclient.class.php` -- replaced by `src/services/facebook/FacebookAdsService.class.php`
|
||||
- `src/class/microsoftadsclient.class.php` -- replaced by `src/services/microsoft/MicrosoftAdsService.class.php`
|
||||
- `src/class/adsystemclientinterface.class.php` -- superseded by `src/services/AdServiceInterface.class.php`
|
||||
|
||||
### Planned
|
||||
- Multi-platform concurrent reporting (view multiple ad systems simultaneously)
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliAdInsights/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr module used to send proofs of art to clients for approval.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliArt) |
|
||||
|
||||
@@ -13,22 +14,27 @@ A Dolibarr module used to send proofs of art to clients for approval.
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring your Dolibarr module. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the moko-platform Dolibarr Template documentation. This guide will help you navigate all ... |
|
||||
| [changelog](changelog) | All notable changes to this project template will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -36,7 +42,7 @@ A Dolibarr module used to send proofs of art to clients for approval.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliArt](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliArt) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliArt](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliArt) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliArt/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr authentication suite
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliAuth) |
|
||||
|
||||
@@ -13,7 +14,7 @@ A Dolibarr authentication suite
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -21,7 +22,7 @@ A Dolibarr authentication suite
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliAuth](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliAuth) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliAuth](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliAuth) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliAuth/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A childcare management software built on Dolibarr.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliCare) |
|
||||
|
||||
@@ -13,29 +14,39 @@ A childcare management software built on Dolibarr.
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [quick start](quick-start.-.-) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring the MokoDoliCare Childcare ... |
|
||||
| [quick start](quick-start.-.-) | Get up and running with MokoDoliCare in 10 minutes. This guide walks you through the essential steps... |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the MokoDoliCare Childcare Management Module documentation. This comprehensive guide will... |
|
||||
| [changelog](changelog) | All notable changes to MokoDoliCare (Childcare Management Module) will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
| [roadmap](roadmap) | **Strategic Product Roadmap and Feature Timeline** |
|
||||
|
||||
## Operations
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [troubleshooting](troubleshooting) | Comprehensive troubleshooting guide for MokoDoliCare Childcare Management Module. This guide covers ... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [admin guide](admin-guide.-.-) | ← [Home](Home) |
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [family management](family-management.-.-) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [remote checkin](remote-checkin.-.-) | ← [Home](Home) |
|
||||
| [roadmap](roadmap) | ← [Home](Home) |
|
||||
| [troubleshooting](troubleshooting) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [user guide](user-guide.-.-) | ← [Home](Home) |
|
||||
| [admin guide](admin-guide.-.-) | Complete guide for system administrators managing MokoDoliCare childcare module installation, config... |
|
||||
| [family management](family-management.-.-) | The MokoDoliCare module uses Dolibarr's Third Party (Societe) system to manage families. Each child ... |
|
||||
| [remote checkin](remote-checkin.-.-) | The Remote Check-In feature enables parents/guardians to independently sign their children in and ou... |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
| [user guide](user-guide.-.-) | Complete guide to using MokoDoliCare for childcare facility management. This guide covers all featur... |
|
||||
|
||||
---
|
||||
|
||||
@@ -43,7 +54,7 @@ A childcare management software built on Dolibarr.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliCare](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliCare) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliCare](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliCare) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -28,7 +28,7 @@ Welcome to the MokoDoliCare Childcare Management Module documentation. This comp
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
### 🚀 For New Users
|
||||
### For New Users
|
||||
|
||||
If you're new to MokoDoliCare, **start here**:
|
||||
|
||||
@@ -53,7 +53,7 @@ If you're new to MokoDoliCare, **start here**:
|
||||
- Daily operational workflows
|
||||
- Tips and best practices
|
||||
|
||||
### 👥 For Daily Users
|
||||
### For Daily Users
|
||||
|
||||
Essential guides for staff and teachers:
|
||||
|
||||
@@ -74,7 +74,7 @@ Essential guides for staff and teachers:
|
||||
- Error messages
|
||||
- Quick fixes
|
||||
|
||||
### 🔧 For System Administrators
|
||||
### For System Administrators
|
||||
|
||||
Complete system management documentation:
|
||||
|
||||
@@ -100,7 +100,7 @@ Complete system management documentation:
|
||||
- Performance optimization
|
||||
- Diagnostic tools
|
||||
|
||||
### 💻 For Developers
|
||||
### For Developers
|
||||
|
||||
If you're developing or customizing the module:
|
||||
|
||||
@@ -128,7 +128,7 @@ If you're developing or customizing the module:
|
||||
- Pull request process
|
||||
- Code review standards
|
||||
|
||||
### 📚 Reference Materials
|
||||
### Reference Materials
|
||||
|
||||
- **[Changelog](changelog.md)** - Version history and planned features
|
||||
- **[Product Roadmap](roadmap.md)** - Strategic vision and feature timeline
|
||||
|
||||
@@ -8,7 +8,7 @@ This document outlines the strategic direction and planned features for the Moko
|
||||
|
||||
---
|
||||
|
||||
## 📍 Current Status
|
||||
## Current Status
|
||||
|
||||
**Version**: 1.1.0 (Released: March 2026)
|
||||
|
||||
@@ -26,7 +26,7 @@ This document outlines the strategic direction and planned features for the Moko
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Product Vision
|
||||
## Product Vision
|
||||
|
||||
**Mission**: Empower childcare facilities with enterprise-grade management tools that save time, improve safety, and enhance parent communication - all within the trusted Dolibarr platform.
|
||||
|
||||
@@ -40,7 +40,7 @@ This document outlines the strategic direction and planned features for the Moko
|
||||
|
||||
---
|
||||
|
||||
## 🗓️ Release Timeline
|
||||
## Release Timeline
|
||||
|
||||
### Version 1.2.0 - Enhanced Communication (Q2 2026)
|
||||
**Theme**: Connecting parents and staff through better communication tools
|
||||
@@ -315,7 +315,7 @@ This document outlines the strategic direction and planned features for the Moko
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Future Considerations (Post-3.0)
|
||||
## Future Considerations (Post-3.0)
|
||||
|
||||
These features are on our long-term radar but not yet scheduled:
|
||||
|
||||
@@ -366,7 +366,7 @@ These features are on our long-term radar but not yet scheduled:
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Feature Priority Matrix
|
||||
## Feature Priority Matrix
|
||||
|
||||
### High Priority (Must Have)
|
||||
- Email notifications (v1.2.0)
|
||||
@@ -391,7 +391,7 @@ These features are on our long-term radar but not yet scheduled:
|
||||
|
||||
---
|
||||
|
||||
## 📊 Success Metrics
|
||||
## Success Metrics
|
||||
|
||||
We'll measure success through:
|
||||
|
||||
@@ -421,7 +421,7 @@ We'll measure success through:
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Community Input
|
||||
## Community Input
|
||||
|
||||
We welcome community feedback on this roadmap!
|
||||
|
||||
@@ -438,7 +438,7 @@ We welcome community feedback on this roadmap!
|
||||
|
||||
---
|
||||
|
||||
## 📋 Development Process
|
||||
## Development Process
|
||||
|
||||
### Release Cadence
|
||||
- **Major releases** (x.0.0): Quarterly with significant new features
|
||||
@@ -460,7 +460,7 @@ We welcome community feedback on this roadmap!
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Roadmap Updates
|
||||
## Roadmap Updates
|
||||
|
||||
This roadmap is a living document and will be updated:
|
||||
- **Quarterly**: Major roadmap reviews and updates
|
||||
@@ -473,7 +473,7 @@ This roadmap is a living document and will be updated:
|
||||
|
||||
---
|
||||
|
||||
## 📞 Questions or Suggestions?
|
||||
## Questions or Suggestions?
|
||||
|
||||
Have ideas for features not on this roadmap? Want to discuss priorities?
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliCare/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -95,14 +95,14 @@ make check
|
||||
|
||||
# Expected output:
|
||||
# Checking PHP syntax...
|
||||
# ✓ PHP syntax check completed
|
||||
# PHP syntax check completed
|
||||
|
||||
# Validate module structure
|
||||
make validate
|
||||
|
||||
# Expected output:
|
||||
# Validating module structure...
|
||||
# ✓ Module structure validated
|
||||
# Module structure validated
|
||||
```
|
||||
|
||||
---
|
||||
@@ -205,7 +205,7 @@ make check
|
||||
|
||||
# Expected output:
|
||||
# Checking PHP syntax...
|
||||
# ✓ PHP syntax check completed
|
||||
# PHP syntax check completed
|
||||
```
|
||||
|
||||
**C. Sync Changes to Server**
|
||||
@@ -223,7 +223,7 @@ make dev-sync
|
||||
# mokodolichimp.php
|
||||
# class/mailchimpclient.class.php
|
||||
#
|
||||
# ✓ Files synced successfully
|
||||
# Files synced successfully
|
||||
# Synced from: /home/user/projects/MokoDoliChimp/src/
|
||||
# Synced to: /var/www/html/dolibarr/htdocs/custom/mokodolichimp
|
||||
```
|
||||
@@ -300,7 +300,7 @@ sudo make dev-install DOLIBARR_PATH=/path/to/local/dolibarr
|
||||
|
||||
# Expected output:
|
||||
# Creating development symlink...
|
||||
# ✓ Development symlink created
|
||||
# Development symlink created
|
||||
# Note: Changes in this directory will be immediately reflected in Dolibarr
|
||||
```
|
||||
|
||||
@@ -365,7 +365,7 @@ make clean
|
||||
|
||||
# Expected output:
|
||||
# Cleaning build artifacts...
|
||||
# ✓ Clean completed
|
||||
# Clean completed
|
||||
```
|
||||
|
||||
### Viewing All Available Commands
|
||||
|
||||
@@ -2,16 +2,17 @@
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliChimp) |
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [DEVELOPMENT_GUIDE](DEVELOPMENT_GUIDE) | ← [Home](Home) |
|
||||
| [DEVELOPMENT_GUIDE](DEVELOPMENT_GUIDE) | This comprehensive guide covers the complete development workflow for MokoDoliChimp, with detailed s... |
|
||||
|
||||
---
|
||||
|
||||
@@ -19,7 +20,7 @@
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliChimp](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliChimp) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliChimp](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliChimp) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -4,6 +4,7 @@ A connector for Dolibarr and Claude
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliClaude) |
|
||||
|
||||
@@ -13,22 +14,27 @@ A connector for Dolibarr and Claude
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring your Dolibarr module. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the moko-platform Dolibarr Template documentation. This guide will help you navigate all ... |
|
||||
| [changelog](changelog) | All notable changes to this project template will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -36,7 +42,7 @@ A connector for Dolibarr and Claude
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliClaude](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliClaude) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliClaude](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliClaude) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliClaude/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliCredits) |
|
||||
|
||||
@@ -11,22 +12,27 @@
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring your Dolibarr module. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the moko-platform Dolibarr Template documentation. This guide will help you navigate all ... |
|
||||
| [changelog](changelog) | All notable changes to this project template will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -34,7 +40,7 @@
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliCredits](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliCredits) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliCredits](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliCredits) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliCredits/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A module to design label documents for Dymo LabelWriter
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliDymo) |
|
||||
|
||||
@@ -13,22 +14,22 @@ A module to design label documents for Dymo LabelWriter
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | - **Dolibarr ERP/CRM**: Version 19.0 or higher |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [dymo label format](dymo-label-format.-.-) | ← [Home](Home) |
|
||||
| [README](README) | - [Installation Guide](installation.md) — Setup and configuration |
|
||||
| [changelog](changelog) | All notable changes to MokoDoliDymo will be documented in this file. |
|
||||
| [dymo label format](dymo-label-format.-.-) | This document describes the DYMO Desktop Label XML format (`.dymo` / `.label` files) used by DYMO Co... |
|
||||
| [module id policy](module-id-policy.-.-) | **Module ID: 185072** — registered in the [Moko Consulting module registry](https://github.com/mokoc... |
|
||||
|
||||
## Documentation
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [development](development) | This guide covers developing and extending MokoDoliDymo. |
|
||||
|
||||
---
|
||||
|
||||
@@ -36,7 +37,7 @@ A module to design label documents for Dymo LabelWriter
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliDymo](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliDymo) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliDymo](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliDymo) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Installation Guide](installation.md) — Setup and configuration
|
||||
- [Development Guide](development.md) — Architecture, coding standards, extending the module
|
||||
- [Changelog](changelog.md) — Version history
|
||||
- [Installation Guide](installation.md) -- Setup and configuration
|
||||
- [Development Guide](development.md) -- Architecture, coding standards, extending the module
|
||||
- [Changelog](changelog.md) -- Version history
|
||||
|
||||
## For Users
|
||||
|
||||
@@ -20,7 +20,7 @@ This module follows [moko-platform](https://github.com/mokoconsulting-tech/moko-
|
||||
|
||||
## Resources
|
||||
|
||||
- [moko-platform](https://github.com/mokoconsulting-tech/moko-platform) — Governance and coding standards
|
||||
- [moko-platform](https://github.com/mokoconsulting-tech/moko-platform) -- Governance and coding standards
|
||||
- [MokoDoliDymo Repository](https://github.com/mokoconsulting-tech/MokoDoliDymo)
|
||||
- [Dolibarr Developer Docs](https://wiki.dolibarr.org/index.php/Developer_documentation)
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ mokodolidymo/
|
||||
|
||||
The module descriptor at `core/modules/modMokoDoliDymo.class.php` defines:
|
||||
|
||||
- **Module ID**: `185072` — permanently registered, never change
|
||||
- **Module ID**: `185072` -- permanently registered, never change
|
||||
- **Rights class**: `mokodolidymo`
|
||||
- **Permissions**: `label.read`, `label.write`, `label.delete`, `label.print`
|
||||
- **Version**: Must match `README.md`
|
||||
|
||||
@@ -35,7 +35,7 @@ The main label definition container.
|
||||
| `DYMORect` | Label printable area rectangle |
|
||||
| `DynamicLayoutManager > LabelObjects` | Container for all label elements |
|
||||
|
||||
### DYMORect / ObjectLayout — Coordinates
|
||||
### DYMORect / ObjectLayout -- Coordinates
|
||||
|
||||
All coordinates and sizes are in **inches**. Each object has an `ObjectLayout` block:
|
||||
|
||||
|
||||
@@ -42,10 +42,10 @@ After activation, assign permissions to users:
|
||||
1. Go to **Home > Users & Groups**
|
||||
2. Select the user or group
|
||||
3. Under **Permissions**, find **MokoDoliDymo** and enable:
|
||||
- **Read label templates** — view existing labels
|
||||
- **Create/Update label templates** — design and edit labels
|
||||
- **Delete label templates** — remove labels
|
||||
- **Print labels** — send labels to the printer
|
||||
- **Read label templates** -- view existing labels
|
||||
- **Create/Update label templates** -- design and edit labels
|
||||
- **Delete label templates** -- remove labels
|
||||
- **Print labels** -- send labels to the printer
|
||||
|
||||
### 5. Configure Module Settings
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
## MokoDoliDymo Module ID
|
||||
|
||||
**Module ID: 185072** — registered in the [Moko Consulting module registry](https://github.com/mokoconsulting-tech/moko-platform/blob/main/docs/development/crm/module-registry.md).
|
||||
**Module ID: 185072** -- registered in the [Moko Consulting module registry](https://github.com/mokoconsulting-tech/moko-platform/blob/main/docs/development/crm/module-registry.md).
|
||||
|
||||
This ID is **permanent and immutable**. It is stored in `$this->numero` in the module descriptor and must never be changed after deployment. Changing it would break all existing Dolibarr installations using this module.
|
||||
|
||||
|
||||
@@ -56,25 +56,25 @@ The repository follows both Dolibarr standards and modern PHP practices:
|
||||
|
||||
## Features Implemented
|
||||
|
||||
### ✅ Repository Structure
|
||||
### Repository Structure
|
||||
- Complete Dolibarr-compliant directory structure
|
||||
- Modern `src/` directory with PSR-4 namespacing
|
||||
- Security hardening with blank index files in all directories
|
||||
- Proper .htaccess configuration
|
||||
|
||||
### ✅ Module Descriptor
|
||||
### Module Descriptor
|
||||
- Module ID: 185057
|
||||
- Complete metadata and configuration
|
||||
- Permission structure
|
||||
- Menu integration ready
|
||||
|
||||
### ✅ Admin Interface
|
||||
### Admin Interface
|
||||
- Setup page for configuration
|
||||
- Tools page for utilities
|
||||
- About page for information
|
||||
- Tabbed navigation system
|
||||
|
||||
### ✅ Google Services Foundation
|
||||
### Google Services Foundation
|
||||
|
||||
#### Authentication (src/Auth/)
|
||||
- GoogleAuthenticator class for OAuth 2.0
|
||||
@@ -95,26 +95,26 @@ The repository follows both Dolibarr standards and modern PHP practices:
|
||||
- Retention policies
|
||||
- Backup listing and management
|
||||
|
||||
### ✅ Development Tools
|
||||
### Development Tools
|
||||
- Build script (syntax check, PHPCS, PHPStan)
|
||||
- Test runner (PHPUnit)
|
||||
- Development server launcher
|
||||
- Validation scripts for code quality
|
||||
|
||||
### ✅ Documentation
|
||||
### Documentation
|
||||
- Comprehensive README with features and usage
|
||||
- CHANGELOG with version history
|
||||
- CONTRIBUTING guidelines
|
||||
- CODE_OF_CONDUCT
|
||||
- This DEVELOPMENT guide
|
||||
|
||||
### ✅ Testing Infrastructure
|
||||
### Testing Infrastructure
|
||||
- PHPUnit configuration
|
||||
- Test bootstrap
|
||||
- Example test class
|
||||
- Test scripts
|
||||
|
||||
### ✅ Code Quality Tools
|
||||
### Code Quality Tools
|
||||
- PHP CodeSniffer (PSR-12)
|
||||
- PHPStan (Level 5)
|
||||
- EditorConfig
|
||||
|
||||
@@ -4,18 +4,29 @@ A Dolibarr module to extend the interface to Google Workspace.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliG) |
|
||||
|
||||
---
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [CHANGELOG](CHANGELOG) | - Initial module structure following [moko-platform](https://github.com/mokoconsulting-tech/MokoCodi... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [DEVELOPMENT](DEVELOPMENT) | MokoDoliG is a comprehensive Google Workspace integration module for Dolibarr, providing: |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [CHANGELOG](CHANGELOG) | ← [Home](Home) |
|
||||
| [DEVELOPMENT](DEVELOPMENT) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -23,7 +34,7 @@ A Dolibarr module to extend the interface to Google Workspace.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliG](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliG) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliG](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliG) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliG/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr module to bridge to Github
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliGithub) |
|
||||
|
||||
@@ -13,22 +14,27 @@ A Dolibarr module to bridge to Github
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring your Dolibarr module. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the moko-platform Dolibarr Template documentation. This guide will help you navigate all ... |
|
||||
| [changelog](changelog) | All notable changes to this project template will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -36,7 +42,7 @@ A Dolibarr module to bridge to Github
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliGithub](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliGithub) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliGithub](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliGithub) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliGithub/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliHRM) |
|
||||
|
||||
@@ -11,22 +12,22 @@
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [INSTALLATION](INSTALLATION) | Before installing MokoDoliHRM, ensure you have: |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [API](API) | ← [Home](Home) |
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [API](API) | Located in: `src/class/employee.class.php` |
|
||||
| [README](README) | MokoDoliHRM is a comprehensive Human Resources Management module for Dolibarr ERP/CRM that provides ... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [FAQ](FAQ) | ← [Home](Home) |
|
||||
| [USER_GUIDE](USER_GUIDE) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [FAQ](FAQ) | **A:** MokoDoliHRM is a comprehensive Human Resources Management module for Dolibarr ERP/CRM that pr... |
|
||||
| [USER_GUIDE](USER_GUIDE) | 1. [Introduction](#introduction) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -34,7 +35,7 @@
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliHRM](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliHRM) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliHRM](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliHRM) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliHRM/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ The DoliMods is the repository of the Dolibarr ERP CRM modules, developed by the
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliMods) |
|
||||
|
||||
@@ -13,13 +14,13 @@ The DoliMods is the repository of the Dolibarr ERP CRM modules, developed by the
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [INSTALLATION](INSTALLATION) | This document provides comprehensive installation and setup instructions for **[PROJECT_NAME]**. |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -27,7 +28,7 @@ The DoliMods is the repository of the Dolibarr ERP CRM modules, developed by the
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliMods](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliMods) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliMods](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliMods) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliMods/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ Domain‑based multi‑tenant orchestration for Dolibarr using one codebase and
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliMulti) |
|
||||
|
||||
@@ -13,23 +14,23 @@ Domain‑based multi‑tenant orchestration for Dolibarr using one codebase and
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [INSTALLATION](INSTALLATION) | This guide walks you through installing and configuring MokoDoliMulti for domain-based multi-tenant ... |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [api API](api-API.-.-) | ← [Home](Home) |
|
||||
| [architecture ARCHITECTURE](architecture-ARCHITECTURE.-.-) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the MokoDoliMulti documentation. This directory contains comprehensive guides, references... |
|
||||
| [api API](api-API.-.-) | **Namespace**: `MokoDoliMulti\Core` |
|
||||
| [architecture ARCHITECTURE](architecture-ARCHITECTURE.-.-) | MokoDoliMulti provides domain-based multi-tenant orchestration for Dolibarr, enabling multiple organ... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [PROJECT_SUMMARY](PROJECT_SUMMARY) | ← [Home](Home) |
|
||||
| [USAGE](USAGE) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [PROJECT_SUMMARY](PROJECT_SUMMARY) | MokoDoliMulti is a complete domain-based multi-tenant orchestration system for Dolibarr, enabling mu... |
|
||||
| [USAGE](USAGE) | This document provides practical examples of using MokoDoliMulti in various scenarios. |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -37,7 +38,7 @@ Domain‑based multi‑tenant orchestration for Dolibarr using one codebase and
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliMulti](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliMulti) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliMulti](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliMulti) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliMulti/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr module enabling offline mode and PWA.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliOffline) |
|
||||
|
||||
@@ -13,20 +14,20 @@ A Dolibarr module enabling offline mode and PWA.
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing MokoDoliOffline in your Dolibarr instance. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the MokoDoliOffline documentation. This module enables offline mode and Progressive Web A... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [user guide](user-guide.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
| [user guide](user-guide.-.-) | This guide explains how to use MokoDoliOffline's features as an end user. |
|
||||
|
||||
---
|
||||
|
||||
@@ -34,7 +35,7 @@ A Dolibarr module enabling offline mode and PWA.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliOffline](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliOffline) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliOffline](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliOffline) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliOffline/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr module to bridge to Phone.com service
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliPhoneCom) |
|
||||
|
||||
@@ -13,22 +14,27 @@ A Dolibarr module to bridge to Phone.com service
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring your Dolibarr module. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [README](README) | Welcome to the moko-platform Dolibarr Template documentation. This guide will help you navigate all ... |
|
||||
| [changelog](changelog) | All notable changes to this project template will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [changelog](changelog) | ← [Home](Home) |
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [module id policy](module-id-policy.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -36,7 +42,7 @@ A Dolibarr module to bridge to Phone.com service
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliPhoneCom](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliPhoneCom) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliPhoneCom](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliPhoneCom) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliPhoneCom/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -1,18 +1,49 @@
|
||||
# MokoDoliProjTemplate
|
||||
|
||||
Project templates for Dolibarr
|
||||
A Dolibarr module designed to provide project templates.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [README](README
|
||||
)
|
||||
- [changelog](changelog
|
||||
)
|
||||
- [development](development
|
||||
)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | This guide provides step-by-step instructions for installing and configuring the **MokoProjTemplate*... |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | Welcome to the MokoProjTemplate module documentation. Use the links below to navigate all available ... |
|
||||
| [changelog](changelog) | All notable changes to the **MokoProjTemplate** Dolibarr module are documented here. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed by |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide describes the internal structure of the MokoProjTemplate module and how to extend or cust... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
)
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
@@ -1,14 +1,14 @@
|
||||
← [Home](Home)
|
||||
|
||||
# Documentation Index — MokoProjTemplate
|
||||
# Documentation Index -- MokoProjTemplate
|
||||
|
||||
Welcome to the MokoProjTemplate module documentation. Use the links below to navigate all available resources.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Installation Guide](installation.md) — Get the module running in your Dolibarr instance
|
||||
- [Development Guide](development.md) — Module internals, class structure, and extension points
|
||||
- [Changelog](changelog.md) — Version history and release notes
|
||||
- [Installation Guide](installation.md) -- Get the module running in your Dolibarr instance
|
||||
- [Development Guide](development.md) -- Module internals, class structure, and extension points
|
||||
- [Changelog](changelog.md) -- Version history and release notes
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
@@ -35,8 +35,8 @@ Welcome to the MokoProjTemplate module documentation. Use the links below to nav
|
||||
|
||||
### Reference
|
||||
|
||||
- **[Changelog](changelog.md)** — Version history
|
||||
- **[README](README)** — Project overview and quick start
|
||||
- **[Changelog](changelog.md)** -- Version history
|
||||
- **[README](README)** -- Project overview and quick start
|
||||
|
||||
## Getting Help
|
||||
|
||||
@@ -75,3 +75,11 @@ See the [Contributing Guidelines](CONTRIBUTING).
|
||||
**Next Steps**:
|
||||
- New? Start with [Installation Guide](installation.md)
|
||||
- Developing? Check out [Development Guide](development.md)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
← [Home](Home)
|
||||
|
||||
# Changelog — MokoProjTemplate
|
||||
# Changelog -- MokoProjTemplate
|
||||
|
||||
All notable changes to the **MokoProjTemplate** Dolibarr module are documented here.
|
||||
|
||||
@@ -27,7 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Module display name updated from `Moko Dolibarr Project Templates` to `Moko Project Templates` for a cleaner, less redundant presentation in the Dolibarr UI
|
||||
- Module version set to `development` to hold for active development; will be bumped to a release version when ready
|
||||
- **Module family** changed from `"projects"` to `"mokoconsulting"` to comply with moko-platform requirements; `familyinfo` array added so the module is grouped under the Moko Consulting family in the Dolibarr module manager.
|
||||
- **`editor_squarred_logo`** updated from `'favicon_256.png@mokocrm'` to `'object_favicon_256.png@mokoprojtemplate'` — now references the locally bundled copy of the Moko Consulting brand icon (with the required `object_` prefix) instead of depending on the separate `mokocrm` module.
|
||||
- **`editor_squarred_logo`** updated from `'favicon_256.png@mokocrm'` to `'object_favicon_256.png@mokoprojtemplate'` -- now references the locally bundled copy of the Moko Consulting brand icon (with the required `object_` prefix) instead of depending on the separate `mokocrm` module.
|
||||
- **`docs/module-id-policy.md`** rewritten to reflect the actual Moko Consulting module ID reservation process via moko-platform, replacing the generic scaffold content.
|
||||
|
||||
## [1.0.0] - 2026-03-03
|
||||
@@ -40,35 +40,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Permissions: `projtemplate` read / write / delete
|
||||
- Left-menu entries under Projects: **Project Templates**, **New Project Template**, **List of Project Templates**
|
||||
- **Database schema**
|
||||
- `llx_mokoprojtemplate` — project templates table
|
||||
- `llx_mokoprojtemplate_det` — template task lines table with FK cascade
|
||||
- `llx_mokoprojtemplate` -- project templates table
|
||||
- `llx_mokoprojtemplate_det` -- template task lines table with FK cascade
|
||||
- **`ProjTemplate` class** (`class/projtemplate.class.php`)
|
||||
- `create()`, `fetch()`, `fetchLines()`, `update()`, `delete()`, `fetchAll()`
|
||||
- `applyToProject()` — creates a new Dolibarr project with pre-populated tasks
|
||||
- `getLibStatut()` / `LibStatut()` — status label helpers
|
||||
- `applyToProject()` -- creates a new Dolibarr project with pre-populated tasks
|
||||
- `getLibStatut()` / `LibStatut()` -- status label helpers
|
||||
- **`ProjTemplateDet` class** (`class/projtemplatedet.class.php`)
|
||||
- `create()`, `update()`, `delete()` for individual task lines
|
||||
- **Library** (`lib/mokoprojtemplate.lib.php`)
|
||||
- `mokoProjTemplateAdminPrepareHead()` — admin tab headers
|
||||
- `projtemplatePrepareHead()` — card page tab headers
|
||||
- `mokoProjTemplateAdminPrepareHead()` -- admin tab headers
|
||||
- `projtemplatePrepareHead()` -- card page tab headers
|
||||
- **Translation file** (`langs/en_US/mokoprojtemplate.lang`)
|
||||
- Full English translations for all UI strings
|
||||
- **Pages**
|
||||
- `index.php` — module home with recent templates widget
|
||||
- `projtemplate_list.php` — sortable, paginated list of templates
|
||||
- `projtemplate_card.php` — create / view / edit a template with inline task line management
|
||||
- `index.php` -- module home with recent templates widget
|
||||
- `projtemplate_list.php` -- sortable, paginated list of templates
|
||||
- `projtemplate_card.php` -- create / view / edit a template with inline task line management
|
||||
- **Admin pages**
|
||||
- `admin/setup.php` — module settings page
|
||||
- `admin/about.php` — about page showing module descriptor info
|
||||
- `admin/setup.php` -- module settings page
|
||||
- `admin/about.php` -- about page showing module descriptor info
|
||||
- **Documentation**
|
||||
- `README.md` — project overview, features, installation quick-start
|
||||
- `src/README.md` — module-specific readme for Dolibarr Dolistore style
|
||||
- `docs/README.md` — documentation index
|
||||
- `docs/installation.md` — full installation guide
|
||||
- `docs/development.md` — developer reference (schema, classes, extension guide)
|
||||
- `docs/changelog.md` — this file
|
||||
- `README.md` -- project overview, features, installation quick-start
|
||||
- `src/README.md` -- module-specific readme for Dolibarr Dolistore style
|
||||
- `docs/README.md` -- documentation index
|
||||
- `docs/installation.md` -- full installation guide
|
||||
- `docs/development.md` -- developer reference (schema, classes, extension guide)
|
||||
- `docs/changelog.md` -- this file
|
||||
|
||||
---
|
||||
|
||||
[Unreleased]: https://github.com/mokoconsulting-tech/MokoDoliProjTemplate/compare/v1.0.0...HEAD
|
||||
[1.0.0]: https://github.com/mokoconsulting-tech/MokoDoliProjTemplate/releases/tag/v1.0.0
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
← [Home](Home)
|
||||
|
||||
# Development Guide — MokoProjTemplate
|
||||
# Development Guide -- MokoProjTemplate
|
||||
|
||||
This guide describes the internal structure of the MokoProjTemplate module and how to extend or customise it.
|
||||
|
||||
@@ -33,7 +33,7 @@ mokoprojtemplate/
|
||||
|
||||
## Database Schema
|
||||
|
||||
### `llx_mokoprojtemplate` — Project Templates
|
||||
### `llx_mokoprojtemplate` -- Project Templates
|
||||
|
||||
| Column | Type | Description |
|
||||
|--------|------|-------------|
|
||||
@@ -48,7 +48,7 @@ mokoprojtemplate/
|
||||
| `date_creation` | datetime | Creation timestamp |
|
||||
| `tms` | timestamp | Last modification timestamp |
|
||||
|
||||
### `llx_mokoprojtemplate_det` — Template Task Lines
|
||||
### `llx_mokoprojtemplate_det` -- Template Task Lines
|
||||
|
||||
| Column | Type | Description |
|
||||
|--------|------|-------------|
|
||||
@@ -103,7 +103,7 @@ Located in `class/projtemplatedet.class.php`.
|
||||
The module descriptor is `core/modules/modMokoProjTemplate.class.php`.
|
||||
|
||||
```php
|
||||
$this->numero = 185064; // Official module ID — DO NOT CHANGE
|
||||
$this->numero = 185064; // Official module ID -- DO NOT CHANGE
|
||||
$this->rights_class = 'mokoprojtemplate';
|
||||
$this->family = 'mokoconsulting'; // All Moko Consulting modules use this family
|
||||
$this->familyinfo = array(
|
||||
@@ -123,7 +123,7 @@ $this->editor_squarred_logo = 'object_favicon_256.png@mokoprojtemplate';
|
||||
|
||||
The module ID **185064** is officially reserved in the
|
||||
[moko-platform module registry](https://github.com/mokoconsulting-tech/moko-platform/blob/main/docs/development/crm/module-registry.md).
|
||||
The file `src/DOLIBARR_MODULE_ID.txt` records this reservation — **do not change the ID**.
|
||||
The file `src/DOLIBARR_MODULE_ID.txt` records this reservation -- **do not change the ID**.
|
||||
|
||||
### Permissions
|
||||
|
||||
@@ -191,16 +191,16 @@ Exports require the `projtemplate` / `read` permission.
|
||||
|
||||
### Example: Add a "colour" field to templates
|
||||
|
||||
1. **SQL migration** — create `src/sql/update_mokoprojtemplate_colour.sql`:
|
||||
1. **SQL migration** -- create `src/sql/update_mokoprojtemplate_colour.sql`:
|
||||
```sql
|
||||
ALTER TABLE llx_mokoprojtemplate ADD COLUMN colour varchar(7) DEFAULT NULL;
|
||||
```
|
||||
|
||||
2. **Update the class** — add a `public $colour = '';` property to `ProjTemplate` and include the column in `create()`, `fetch()`, and `update()`.
|
||||
2. **Update the class** -- add a `public $colour = '';` property to `ProjTemplate` and include the column in `create()`, `fetch()`, and `update()`.
|
||||
|
||||
3. **Update the card page** — add an input field in `projtemplate_card.php`.
|
||||
3. **Update the card page** -- add an input field in `projtemplate_card.php`.
|
||||
|
||||
4. **Update the language file** — add `TemplateColour = Colour` to `langs/en_US/mokoprojtemplate.lang`.
|
||||
4. **Update the language file** -- add `TemplateColour = Colour` to `langs/en_US/mokoprojtemplate.lang`.
|
||||
|
||||
## Testing
|
||||
|
||||
@@ -235,3 +235,11 @@ See the [Dolibarr Module ID Registry](https://wiki.dolibarr.org/index.php/List_o
|
||||
- [Dolibarr Developer Docs](https://wiki.dolibarr.org/index.php/Developer_documentation)
|
||||
- [Module Development Guide](https://wiki.dolibarr.org/index.php/Module_development)
|
||||
- [Dolibarr API Reference](https://www.dolibarr.org/doc/html/)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
← [Home](Home)
|
||||
|
||||
# Installation Guide — MokoProjTemplate
|
||||
# Installation Guide -- MokoProjTemplate
|
||||
|
||||
This guide provides step-by-step instructions for installing and configuring the **MokoProjTemplate** Dolibarr module.
|
||||
|
||||
@@ -55,17 +55,17 @@ find /path/to/dolibarr/htdocs/custom/mokoprojtemplate -type f -exec chmod 644 {}
|
||||
4. Click **Activate**
|
||||
|
||||
Dolibarr will automatically run the SQL scripts to create the required database tables:
|
||||
- `llx_mokoprojtemplate` — stores project templates
|
||||
- `llx_mokoprojtemplate_det` — stores task lines for each template
|
||||
- `llx_mokoprojtemplate` -- stores project templates
|
||||
- `llx_mokoprojtemplate_det` -- stores task lines for each template
|
||||
|
||||
### 5. Assign Permissions
|
||||
|
||||
1. Navigate to **Home → Setup → Users & Groups**
|
||||
2. Edit the relevant user or group
|
||||
3. Under the **MokoProjTemplate** section, enable:
|
||||
- **Read project templates** — view templates and task lists
|
||||
- **Create or update project templates** — add/edit templates and task lines
|
||||
- **Delete project templates** — remove templates
|
||||
- **Read project templates** -- view templates and task lists
|
||||
- **Create or update project templates** -- add/edit templates and task lines
|
||||
- **Delete project templates** -- remove templates
|
||||
|
||||
### 6. Access the Module
|
||||
|
||||
@@ -134,3 +134,11 @@ mysql -u username -p database_name < src/sql/llx_mokoprojtemplate_det.key.sql
|
||||
|
||||
- Read the [Development Guide](development.md) to extend or customise the module
|
||||
- Check the [Changelog](changelog.md) for version history
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -75,3 +75,11 @@ This groups all Moko modules together in the Dolibarr module manager.
|
||||
- [moko-platform CRM Development Standards](https://github.com/mokoconsulting-tech/moko-platform/blob/main/docs/policy/crm/development-standards.md)
|
||||
- [Dolibarr Module Development](https://wiki.dolibarr.org/index.php/Module_development)
|
||||
- [Dolibarr Module ID List](https://wiki.dolibarr.org/index.php/List_of_modules_id)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliProjTemplate/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
@@ -54,3 +54,11 @@ The `repo_health.yml` workflow verifies on every commit:
|
||||
---
|
||||
|
||||
*Managed by [moko-platform](https://git.mokoconsulting.tech/MokoConsulting/moko-platform). See [docs/workflows/update-server.md](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/blob/main/docs/workflows/update-server.md) for the full specification.*
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliProjTemplate](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliProjTemplate) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -4,6 +4,7 @@ A Dolibarr module for monitoring and managing remote deployments, software relea
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliRelease) |
|
||||
|
||||
@@ -13,31 +14,36 @@ A Dolibarr module for monitoring and managing remote deployments, software relea
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [configuration](configuration) | ← [Home](Home) |
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [quick start](quick-start.-.-) | ← [Home](Home) |
|
||||
| [configuration](configuration) | Complete configuration reference for MokoDoliRelease module. |
|
||||
| [installation](installation) | Complete installation instructions for MokoDoliDeploy module. |
|
||||
| [quick start](quick-start.-.-) | Get up and running with MokoDoliRelease in minutes. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [api reference](api-reference.-.-) | ← [Home](Home) |
|
||||
| [architecture](architecture) | ← [Home](Home) |
|
||||
| [README](README) | Comprehensive documentation for the MokoDoliRelease module - a Dolibarr module for managing releases... |
|
||||
| [ROADMAP](ROADMAP) | This document outlines the planned features and improvements for MokoDoliRelease. |
|
||||
| [api reference](api-reference.-.-) | Complete API documentation for MokoDoliDeploy module. |
|
||||
| [architecture](architecture) | System architecture and design documentation for MokoDoliDeploy. |
|
||||
|
||||
## Operations
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [enterprise deployment](enterprise-deployment.-.-) | Comprehensive guide for deploying MokoDoliDeploy at enterprise scale. |
|
||||
| [runbook](runbook) | Comprehensive operational procedures for MokoDoliDeploy platform. |
|
||||
| [troubleshooting](troubleshooting) | Common issues and solutions for MokoDoliDeploy module. |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [ROADMAP](ROADMAP) | ← [Home](Home) |
|
||||
| [XML_UPDATE_STREAMS](XML_UPDATE_STREAMS) | ← [Home](Home) |
|
||||
| [enterprise deployment](enterprise-deployment.-.-) | ← [Home](Home) |
|
||||
| [faq](faq) | ← [Home](Home) |
|
||||
| [governance](governance) | ← [Home](Home) |
|
||||
| [runbook](runbook) | ← [Home](Home) |
|
||||
| [sla management](sla-management.-.-) | ← [Home](Home) |
|
||||
| [troubleshooting](troubleshooting) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [XML_UPDATE_STREAMS](XML_UPDATE_STREAMS) | This document explains how to use the update stream system for managing extension updates across mul... |
|
||||
| [faq](faq) | Common questions about MokoDoliDeploy module. |
|
||||
| [governance](governance) | Enterprise governance framework for MokoDoliDeploy deployment and operations. |
|
||||
| [sla management](sla-management.-.-) | Service Level Agreement management and monitoring for MokoDoliDeploy. |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -45,7 +51,7 @@ A Dolibarr module for monitoring and managing remote deployments, software relea
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliRelease](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliRelease) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliRelease](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliRelease) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliRelease/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ MokoDoliSign is a Dolibarr module that adds secure electronic signature function
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliSign) |
|
||||
|
||||
@@ -13,29 +14,29 @@ MokoDoliSign is a Dolibarr module that adds secure electronic signature function
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALL](INSTALL) | ← [Home](Home) |
|
||||
| [MIGRATION_GUIDE](MIGRATION_GUIDE) | ← [Home](Home) |
|
||||
| [QUICK_START](QUICK_START) | ← [Home](Home) |
|
||||
| [BUILD](BUILD) | This document describes the build and CI tools available for MokoDoliSign development. |
|
||||
| [INSTALL](INSTALL) | 1. **Copy module to Dolibarr** |
|
||||
| [MIGRATION_GUIDE](MIGRATION_GUIDE) | **Version**: 0.1.0+ |
|
||||
| [QUICK_START](QUICK_START) | Get up and running with MokoDoliSign in minutes. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [API](API) | ← [Home](Home) |
|
||||
| [README](README) | ← [Home](Home) |
|
||||
| [STRUCTURE](STRUCTURE) | ← [Home](Home) |
|
||||
| [API](API) | MokoDoliSign provides both REST-like AJAX endpoints and PHP class APIs for integration. |
|
||||
| [README](README) | 1. [Overview](#overview) |
|
||||
| [ROADMAP](ROADMAP) | **Last Updated:** January 2026 |
|
||||
| [STRUCTURE](STRUCTURE) | This document describes the organization of the MokoDoliSign repository. |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [ADMIN_GUIDE](ADMIN_GUIDE) | ← [Home](Home) |
|
||||
| [BUILD](BUILD) | ← [Home](Home) |
|
||||
| [IMPLEMENTATION_SUMMARY](IMPLEMENTATION_SUMMARY) | ← [Home](Home) |
|
||||
| [MODULE_ID](MODULE_ID) | ← [Home](Home) |
|
||||
| [ROADMAP](ROADMAP) | ← [Home](Home) |
|
||||
| [USER_GUIDE](USER_GUIDE) | ← [Home](Home) |
|
||||
| [update server](update-server.-.-) | ← [Home](Home) |
|
||||
| [ADMIN_GUIDE](ADMIN_GUIDE) | 1. [Installation & Setup](#installation--setup) |
|
||||
| [IMPLEMENTATION_SUMMARY](IMPLEMENTATION_SUMMARY) | Successfully implemented a complete Dolibarr extension for managing electronic signatures and agreem... |
|
||||
| [MODULE_ID](MODULE_ID) | This document provides comprehensive information about the MokoDoliSign module ID, including its pur... |
|
||||
| [USER_GUIDE](USER_GUIDE) | This guide will help you create, send, and manage electronic signature requests. |
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
@@ -43,7 +44,7 @@ MokoDoliSign is a Dolibarr module that adds secure electronic signature function
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliSign](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliSign) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliSign](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliSign) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/MokoDoliSign/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A deployable module to install training data into Dolibarr and reset on command.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliTraining) |
|
||||
|
||||
@@ -13,23 +14,28 @@ A deployable module to install training data into Dolibarr and reset on command.
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [guide installation](guide-installation.-.-) | ← [Home](Home) |
|
||||
| [guide installation](guide-installation.-.-) | - MokoCRM module active |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [api manifest](api-manifest.-.-) | ← [Home](Home) |
|
||||
| [api module class](api-module-class.-.-) | ← [Home](Home) |
|
||||
| [api manifest](api-manifest.-.-) | **File:** `src/sql/manifest.json` |
|
||||
| [api module class](api-module-class.-.-) | **File:** `src/core/modules/modMokoDoliTraining.class.php` |
|
||||
|
||||
## Operations
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [guide backup recovery](guide-backup-recovery.-.-) | MokoDoliTraining maintains two categories of backup file. |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [guide backup recovery](guide-backup-recovery.-.-) | ← [Home](Home) |
|
||||
| [guide seed reset](guide-seed-reset.-.-) | ← [Home](Home) |
|
||||
| [policy enforcement levels](policy-enforcement-levels.-.-) | ← [Home](Home) |
|
||||
| [policy file header standards](policy-file-header-standards.-.-) | ← [Home](Home) |
|
||||
| [guide seed reset](guide-seed-reset.-.-) | Go to **Setup > MokoDoliTraining** and click **Seed Training Data**. |
|
||||
| [policy enforcement levels](policy-enforcement-levels.-.-) | moko-platform uses six enforcement tiers. Apply these when reviewing or generating any file in this ... |
|
||||
| [policy file header standards](policy-file-header-standards.-.-) | Every file in this repository must open with a copyright header. Two tiers apply. |
|
||||
|
||||
---
|
||||
|
||||
@@ -37,7 +43,7 @@ A deployable module to install training data into Dolibarr and reset on command.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoDoliTraining](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliTraining) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoDoliTraining](https://git.mokoconsulting.tech/MokoConsulting/MokoDoliTraining) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
← [Home](Home)
|
||||
|
||||
## `manifest.json` — Schema and Usage
|
||||
## `manifest.json` -- Schema and Usage
|
||||
|
||||
**File:** `src/sql/manifest.json`
|
||||
|
||||
@@ -8,9 +8,9 @@
|
||||
|
||||
`manifest.json` is the authoritative record of every row inserted by `mokotraining.sql`. It is used by:
|
||||
|
||||
- `mokotraining_reset.sql` — to target exact rowids in DELETE statements
|
||||
- `modMokoDoliTraining::getManifest()` — to expose the index to the admin UI
|
||||
- The admin page manifest table — so facilitators can audit what is loaded
|
||||
- `mokotraining_reset.sql` -- to target exact rowids in DELETE statements
|
||||
- `modMokoDoliTraining::getManifest()` -- to expose the index to the admin UI
|
||||
- The admin page manifest table -- so facilitators can audit what is loaded
|
||||
|
||||
### Schema
|
||||
|
||||
@@ -70,7 +70,7 @@ Then update `mokotraining_reset.sql` to include any new rowids, and document the
|
||||
|
||||
| Date | Author | Change | Notes |
|
||||
|---|---|---|---|
|
||||
| 2026-03-13 | jmiller | Initial draft | — |
|
||||
| 2026-03-13 | jmiller | Initial draft | -- |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
← [Home](Home)
|
||||
|
||||
## `modMokoDoliTraining` — API Reference
|
||||
## `modMokoDoliTraining` -- API Reference
|
||||
|
||||
**File:** `src/core/modules/modMokoDoliTraining.class.php`
|
||||
**Extends:** `DolibarrModules`
|
||||
@@ -44,7 +44,7 @@ Returns the absolute filesystem path to `src/sql/mokotraining_reset.sql`.
|
||||
|
||||
#### `getManifestSummary(): array`
|
||||
|
||||
Returns `['tables' => int, 'rows' => int]` — a count of tracked tables and total tracked rows.
|
||||
Returns `['tables' => int, 'rows' => int]` -- a count of tracked tables and total tracked rows.
|
||||
|
||||
### Instance methods
|
||||
|
||||
@@ -54,7 +54,7 @@ Called by Dolibarr when the module is enabled. Loads tables via `_load_tables()`
|
||||
|
||||
#### `remove(string $options = ''): int`
|
||||
|
||||
Called by Dolibarr when the module is disabled. Always returns `1`. Training data is not auto-deleted on disable — use the Reset action from the admin page.
|
||||
Called by Dolibarr when the module is disabled. Always returns `1`. Training data is not auto-deleted on disable -- use the Reset action from the admin page.
|
||||
|
||||
## Metadata
|
||||
|
||||
@@ -76,7 +76,7 @@ Called by Dolibarr when the module is disabled. Always returns `1`. Training dat
|
||||
|
||||
| Date | Author | Change | Notes |
|
||||
|---|---|---|---|
|
||||
| 2026-03-13 | jmiller | Initial draft | — |
|
||||
| 2026-03-13 | jmiller | Initial draft | -- |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ After enabling, navigate to **Setup > MokoDoliTraining**. The admin page should
|
||||
|
||||
| Date | Author | Change | Notes |
|
||||
|---|---|---|---|
|
||||
| 2026-03-13 | jmiller | Initial draft | — |
|
||||
| 2026-03-13 | jmiller | Initial draft | -- |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
Go to **Setup > MokoDoliTraining** and click **Seed Training Data**.
|
||||
|
||||
The seed operation executes `src/sql/mokotraining.sql` against the active database. Every statement uses `ON DUPLICATE KEY UPDATE`, so running the seed more than once is safe — existing rows are refreshed, not duplicated.
|
||||
The seed operation executes `src/sql/mokotraining.sql` against the active database. Every statement uses `ON DUPLICATE KEY UPDATE`, so running the seed more than once is safe -- existing rows are refreshed, not duplicated.
|
||||
|
||||
On success, the page reports the number of statements executed and sets the `MOKODOLITRAINING_SEEDED` constant to `1` and records the timestamp in `MOKODOLITRAINING_SEED_DATE`.
|
||||
|
||||
@@ -54,7 +54,7 @@ mysql -u root -p dolibarr < src/sql/mokotraining_reset.sql
|
||||
|
||||
| Date | Author | Change | Notes |
|
||||
|---|---|---|---|
|
||||
| 2026-03-13 | jmiller | Initial draft | — |
|
||||
| 2026-03-13 | jmiller | Initial draft | -- |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -6,31 +6,31 @@ moko-platform uses six enforcement tiers. Apply these when reviewing or generati
|
||||
|
||||
| Level | Name | Behaviour |
|
||||
|---|---|---|
|
||||
| 6 | NOT_ALLOWED | Blocked — never permitted in any file |
|
||||
| 5 | NOT_SUGGESTED | Discouraged — warn if present, do not introduce |
|
||||
| 4 | FORCED | Must always be present — never remove or omit |
|
||||
| 3 | REQUIRED | Must exist — treat absence as an error |
|
||||
| 2 | SUGGESTED | Should exist — warn if absent |
|
||||
| 6 | NOT_ALLOWED | Blocked -- never permitted in any file |
|
||||
| 5 | NOT_SUGGESTED | Discouraged -- warn if present, do not introduce |
|
||||
| 4 | FORCED | Must always be present -- never remove or omit |
|
||||
| 3 | REQUIRED | Must exist -- treat absence as an error |
|
||||
| 2 | SUGGESTED | Should exist -- warn if absent |
|
||||
| 1 | OPTIONAL | Include when useful |
|
||||
|
||||
### Applied to this repository
|
||||
|
||||
| Rule | Level |
|
||||
|---|---|
|
||||
| Copyright line + SPDX identifier | 4 — FORCED |
|
||||
| FILE INFORMATION block (all fields) | 3 — REQUIRED |
|
||||
| `## Metadata` table in every `.md` | 3 — REQUIRED |
|
||||
| `## Revision History` table in every `.md` | 3 — REQUIRED |
|
||||
| GPL warranty text in Full-tier files | 3 — REQUIRED |
|
||||
| `ON DUPLICATE KEY UPDATE` on all INSERTs | 3 — REQUIRED |
|
||||
| Rowids within reserved training ranges | 3 — REQUIRED |
|
||||
| Em dashes (`--` in prose) | 6 — NOT_ALLOWED |
|
||||
| Bare `except:` / `catch` blocks | 6 — NOT_ALLOWED |
|
||||
| SQL string concatenation | 6 — NOT_ALLOWED |
|
||||
| Real client data in demo files | 6 — NOT_ALLOWED |
|
||||
| Hardcoded credentials or tokens | 6 — NOT_ALLOWED |
|
||||
| Google-style docstrings (Python) | 2 — SUGGESTED |
|
||||
| Type hints (Python) | 3 — REQUIRED |
|
||||
| Copyright line + SPDX identifier | 4 -- FORCED |
|
||||
| FILE INFORMATION block (all fields) | 3 -- REQUIRED |
|
||||
| `## Metadata` table in every `.md` | 3 -- REQUIRED |
|
||||
| `## Revision History` table in every `.md` | 3 -- REQUIRED |
|
||||
| GPL warranty text in Full-tier files | 3 -- REQUIRED |
|
||||
| `ON DUPLICATE KEY UPDATE` on all INSERTs | 3 -- REQUIRED |
|
||||
| Rowids within reserved training ranges | 3 -- REQUIRED |
|
||||
| Em dashes (`--` in prose) | 6 -- NOT_ALLOWED |
|
||||
| Bare `except:` / `catch` blocks | 6 -- NOT_ALLOWED |
|
||||
| SQL string concatenation | 6 -- NOT_ALLOWED |
|
||||
| Real client data in demo files | 6 -- NOT_ALLOWED |
|
||||
| Hardcoded credentials or tokens | 6 -- NOT_ALLOWED |
|
||||
| Google-style docstrings (Python) | 2 -- SUGGESTED |
|
||||
| Type hints (Python) | 3 -- REQUIRED |
|
||||
|
||||
## Metadata
|
||||
|
||||
@@ -38,7 +38,7 @@ moko-platform uses six enforcement tiers. Apply these when reviewing or generati
|
||||
|---|---|
|
||||
| Document Type | Policy |
|
||||
| Domain | moko-platform |
|
||||
| Applies To | MokoDoliTraining — all files |
|
||||
| Applies To | MokoDoliTraining -- all files |
|
||||
| Jurisdiction | Internal |
|
||||
| Owner | Moko Consulting |
|
||||
| Repo | https://github.com/mokoconsulting-tech/MokoDoliTraining |
|
||||
@@ -52,17 +52,17 @@ moko-platform uses six enforcement tiers. Apply these when reviewing or generati
|
||||
|
||||
| Date | Author | Change | Notes |
|
||||
|---|---|---|---|
|
||||
| 2026-03-13 | jmiller | Initial draft | — |
|
||||
| 2026-03-13 | jmiller | Initial draft | -- |
|
||||
|
||||
### Backup system
|
||||
|
||||
| Rule | Level |
|
||||
|---|---|
|
||||
| Rollback backup must exist before any seed operation | 3 — REQUIRED |
|
||||
| Snapshot backup must be created immediately after seed | 3 — REQUIRED |
|
||||
| Backup files stored in `src/backup/` with .htaccess + index.php | 3 — REQUIRED |
|
||||
| Backup files must never contain real client data | 6 — NOT_ALLOWED |
|
||||
| Backup SQL must use `ON DUPLICATE KEY UPDATE` (not bare INSERT) | 4 — FORCED |
|
||||
| Rollback backup must exist before any seed operation | 3 -- REQUIRED |
|
||||
| Snapshot backup must be created immediately after seed | 3 -- REQUIRED |
|
||||
| Backup files stored in `src/backup/` with .htaccess + index.php | 3 -- REQUIRED |
|
||||
| Backup files must never contain real client data | 6 -- NOT_ALLOWED |
|
||||
| Backup SQL must use `ON DUPLICATE KEY UPDATE` (not bare INSERT) | 4 -- FORCED |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ Optional fields: `NOTE`, `AUTHOR`, `DEPRECATED`.
|
||||
### Enforcement
|
||||
|
||||
See `docs/policy/enforcement-levels.md`. FILE INFORMATION block fields are REQUIRED (level 3).
|
||||
SPDX identifier and copyright line are FORCED (level 4) — never remove.
|
||||
SPDX identifier and copyright line are FORCED (level 4) -- never remove.
|
||||
|
||||
## Metadata
|
||||
|
||||
@@ -70,7 +70,7 @@ SPDX identifier and copyright line are FORCED (level 4) — never remove.
|
||||
|---|---|
|
||||
| Document Type | Policy |
|
||||
| Domain | moko-platform |
|
||||
| Applies To | MokoDoliTraining — all files |
|
||||
| Applies To | MokoDoliTraining -- all files |
|
||||
| Jurisdiction | Internal |
|
||||
| Owner | Moko Consulting |
|
||||
| Repo | https://github.com/mokoconsulting-tech/MokoDoliTraining |
|
||||
@@ -84,7 +84,7 @@ SPDX identifier and copyright line are FORCED (level 4) — never remove.
|
||||
|
||||
| Date | Author | Change | Notes |
|
||||
|---|---|---|---|
|
||||
| 2026-03-13 | jmiller | Initial draft | — |
|
||||
| 2026-03-13 | jmiller | Initial draft | -- |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ JoomGallery and DPCalendar integration — link photo galleries to calendar even
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoGalleryCalendar) |
|
||||
|
||||
@@ -13,21 +14,26 @@ JoomGallery and DPCalendar integration — link photo galleries to calendar even
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [configuration](configuration) | ← [Home](Home) |
|
||||
| [installation](installation) | ← [Home](Home) |
|
||||
| [configuration](configuration) | All settings are in **System > Manage > Plugins > MokoJGDPC**. |
|
||||
| [installation](installation) | Both DPCalendar and JoomGallery must be installed and enabled before installing MokoJGDPC. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [architecture](architecture) | ← [Home](Home) |
|
||||
| [architecture](architecture) | ├── mokojgdpc.xml # Joomla manifest (config fields, metadata, update server) |
|
||||
|
||||
## Documentation
|
||||
## Operations
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | ← [Home](Home) |
|
||||
| [troubleshooting](troubleshooting) | ← [Home](Home) |
|
||||
| [troubleshooting](troubleshooting) | Categories are only created when the event's start date arrives. Check `#__mokojgdpc_map` for a row ... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | git clone https://git.mokoconsulting.tech/MokoConsulting/MokoJGDPC.git |
|
||||
|
||||
---
|
||||
|
||||
@@ -35,7 +41,7 @@ JoomGallery and DPCalendar integration — link photo galleries to calendar even
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoGalleryCalendar](https://git.mokoconsulting.tech/MokoConsulting/MokoGalleryCalendar) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoGalleryCalendar](https://git.mokoconsulting.tech/MokoConsulting/MokoGalleryCalendar) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -27,8 +27,8 @@ src/
|
||||
`MokoConsulting\Plugin\System\MokoJGDPC\Extension\MokoJGDPC`
|
||||
|
||||
Extends `CMSPlugin`, implements `SubscriberInterface`, uses:
|
||||
- `DatabaseAwareTrait` — database access via `$this->getDatabase()`
|
||||
- `TaskPluginTrait` — Joomla Task Scheduler integration
|
||||
- `DatabaseAwareTrait` -- database access via `$this->getDatabase()`
|
||||
- `TaskPluginTrait` -- Joomla Task Scheduler integration
|
||||
|
||||
### Subscribed Events
|
||||
|
||||
@@ -106,12 +106,12 @@ DPCalendar event deleted
|
||||
| Column | Type | Nullable | Default | Index | Description |
|
||||
|--------|------|----------|---------|-------|-------------|
|
||||
| `id` | INT UNSIGNED | No | AUTO_INCREMENT | PRIMARY | Row ID |
|
||||
| `event_id` | INT UNSIGNED | No | — | UNIQUE (`idx_event`) | DPCalendar event ID |
|
||||
| `event_id` | INT UNSIGNED | No | -- | UNIQUE (`idx_event`) | DPCalendar event ID |
|
||||
| `category_id` | INT UNSIGNED | No | `0` | `idx_category`, `idx_pending` | JoomGallery category ID. `0` = pending |
|
||||
| `event_date` | DATE | Yes | NULL | `idx_pending` (composite) | Event start date. Category created when this date arrives |
|
||||
| `created` | DATETIME | No | CURRENT_TIMESTAMP | — | Row creation time |
|
||||
| `created` | DATETIME | No | CURRENT_TIMESTAMP | -- | Row creation time |
|
||||
|
||||
**`idx_pending`** is a composite index on `(category_id, event_date)` — optimizes the daily pending query.
|
||||
**`idx_pending`** is a composite index on `(category_id, event_date)` -- optimizes the daily pending query.
|
||||
|
||||
## Nested Set Operations
|
||||
|
||||
|
||||
@@ -45,9 +45,9 @@ When enabled, saving a DPCalendar event with a changed title also renames the li
|
||||
The Joomla viewing access level assigned to newly created gallery categories. This controls who can see the category in JoomGallery.
|
||||
|
||||
Standard Joomla access levels:
|
||||
- **Public** (1) — visible to everyone
|
||||
- **Registered** (2) — logged-in users only
|
||||
- **Special** (3) — users in the Special access group
|
||||
- **Public** (1) -- visible to everyone
|
||||
- **Registered** (2) -- logged-in users only
|
||||
- **Special** (3) -- users in the Special access group
|
||||
|
||||
Custom access levels defined in **Users > Access Levels** also appear here.
|
||||
|
||||
@@ -64,10 +64,10 @@ A JoomGallery category ID whose ACL permission rules are copied to every newly c
|
||||
1. Create a category in JoomGallery (e.g., "Event Gallery Permissions Template")
|
||||
2. Open it and go to the **Permissions** tab
|
||||
3. Configure the actions for each user group:
|
||||
- `core.create` — who can upload images
|
||||
- `core.edit` — who can edit image metadata
|
||||
- `core.delete` — who can delete images
|
||||
- `core.edit.state` — who can publish/unpublish images
|
||||
- `core.create` -- who can upload images
|
||||
- `core.edit` -- who can edit image metadata
|
||||
- `core.delete` -- who can delete images
|
||||
- `core.edit.state` -- who can publish/unpublish images
|
||||
4. Save the category and note its ID
|
||||
5. Enter that ID in the **Permissions Template Category** field
|
||||
|
||||
|
||||
@@ -97,7 +97,7 @@ Releases are triggered via the `release.yml` workflow (workflow_dispatch). Dev r
|
||||
|
||||
1. Update the `CREATE TABLE` statement in `script.php::createTable()`
|
||||
2. Add an `ALTER TABLE` in `script.php::migrateSchema()` for upgrades
|
||||
3. The migration checks `$db->getTableColumns()` — only runs if the column doesn't exist yet
|
||||
3. The migration checks `$db->getTableColumns()` -- only runs if the column doesn't exist yet
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
### Event is in the future
|
||||
|
||||
Categories are only created when the event's start date arrives. Check `#__mokojgdpc_map` for a row with `category_id = 0` — that means it's pending and waiting for the date.
|
||||
Categories are only created when the event's start date arrives. Check `#__mokojgdpc_map` for a row with `category_id = 0` -- that means it's pending and waiting for the date.
|
||||
|
||||
### Scheduled task not running
|
||||
|
||||
@@ -66,10 +66,10 @@ All plugin log messages use the category `plg_system_mokojgdpc`. To view them:
|
||||
3. Check `administrator/logs/joomla_*.log` for entries containing `MokoJGDPC:`
|
||||
|
||||
Log levels used:
|
||||
- **ERROR** — category creation failed, mapping insert failed
|
||||
- **WARNING** — parent not found, template not found, asset creation failed, deferred creation failed
|
||||
- **NOTICE** — template has no rules
|
||||
- **INFO** — seed results, deferred creation counts, migration applied
|
||||
- **ERROR** -- category creation failed, mapping insert failed
|
||||
- **WARNING** -- parent not found, template not found, asset creation failed, deferred creation failed
|
||||
- **NOTICE** -- template has no rules
|
||||
- **INFO** -- seed results, deferred creation counts, migration applied
|
||||
|
||||
## Database inspection
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A PortableApp that keeps ISOs of selected systems up to date.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoISOUpdatePortable) |
|
||||
|
||||
@@ -13,30 +14,40 @@ A PortableApp that keeps ISOs of selected systems up to date.
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [BUILD DIRECTORY](BUILD-DIRECTORY.-.-) | This directory contains the built artifacts of MokoISOUpdatePortable. |
|
||||
| [BUILD](BUILD) | > **Complete build instructions for developers, contributors, and CI/CD pipelines** |
|
||||
| [INSTALLATION](INSTALLATION) | This document provides comprehensive installation and setup instructions for **[PROJECT_NAME]**. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [ARCHITECTURE](ARCHITECTURE) | ← [Home](Home) |
|
||||
| [templates README template](templates-README-template.-.-) | ← [Home](Home) |
|
||||
| [ARCHITECTURE](ARCHITECTURE) | MokoISOUpdatePortable is a dual-platform ISO management system with both PowerShell and C# implement... |
|
||||
| [templates README template](templates-README-template.-.-) | A standard style for README files |
|
||||
|
||||
## Operations
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [SECURITY](SECURITY) | We actively support security updates for the following versions: |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [CONTRIBUTING](CONTRIBUTING) | We appreciate your interest in contributing to this project! This document provides guidelines for c... |
|
||||
| [RELEASE PROCESS](RELEASE-PROCESS.-.-) | This document defines the formal release process for MokoISOUpdatePortable, ensuring consistent, hig... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [BUILD DIRECTORY](BUILD-DIRECTORY.-.-) | ← [Home](Home) |
|
||||
| [BUILD](BUILD) | ← [Home](Home) |
|
||||
| [CODE_OF_CONDUCT](CODE_OF_CONDUCT) | ← [Home](Home) |
|
||||
| [CONTRIBUTING](CONTRIBUTING) | ← [Home](Home) |
|
||||
| [CSHARP](CSHARP) | ← [Home](Home) |
|
||||
| [GOVERNANCE](GOVERNANCE) | ← [Home](Home) |
|
||||
| [RELEASE PROCESS](RELEASE-PROCESS.-.-) | ← [Home](Home) |
|
||||
| [REPOSITORY INDEX](REPOSITORY-INDEX.-.-) | ← [Home](Home) |
|
||||
| [SCRIPTS](SCRIPTS) | ← [Home](Home) |
|
||||
| [SECURITY](SECURITY) | ← [Home](Home) |
|
||||
| [templates index](templates-index.-.-) | ← [Home](Home) |
|
||||
| [CODE_OF_CONDUCT](CODE_OF_CONDUCT) | In the interest of fostering an open and welcoming environment, we as contributors and maintainers p... |
|
||||
| [CSHARP](CSHARP) | This is a complete C# rewrite of the MokoISOUpdaterPortable application as a native Windows standalo... |
|
||||
| [GOVERNANCE](GOVERNANCE) | This document outlines the governance model, branch protection rules, and review requirements for th... |
|
||||
| [REPOSITORY INDEX](REPOSITORY-INDEX.-.-) | **A portable Windows application for automatically downloading and organizing Linux distribution ISO... |
|
||||
| [SCRIPTS](SCRIPTS) | This index provides navigation to documentation within this folder. |
|
||||
| [templates index](templates-index.-.-) | This index provides navigation to documentation within this folder. |
|
||||
|
||||
---
|
||||
|
||||
@@ -44,7 +55,7 @@ A PortableApp that keeps ISOs of selected systems up to date.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoISOUpdatePortable](https://git.mokoconsulting.tech/MokoConsulting/MokoISOUpdatePortable) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoISOUpdatePortable](https://git.mokoconsulting.tech/MokoConsulting/MokoISOUpdatePortable) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -304,34 +304,34 @@ git push origin develop
|
||||
```markdown
|
||||
## Version X.Y.Z - YYYY-MM-DD
|
||||
|
||||
### 🎉 Highlights
|
||||
### Highlights
|
||||
- Major feature 1
|
||||
- Major feature 2
|
||||
|
||||
### ✨ New Features
|
||||
### New Features
|
||||
- Feature descriptions
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
### Bug Fixes
|
||||
- Bug fix descriptions
|
||||
|
||||
### 🔒 Security
|
||||
### Security
|
||||
- Security fix descriptions
|
||||
|
||||
### 📚 Documentation
|
||||
### Documentation
|
||||
- Documentation updates
|
||||
|
||||
### ⚙️ Infrastructure
|
||||
### Infrastructure
|
||||
- CI/CD improvements
|
||||
|
||||
### 💔 Breaking Changes
|
||||
### Breaking Changes
|
||||
- Breaking change descriptions (if any)
|
||||
|
||||
### 📦 Download
|
||||
### Download
|
||||
- PowerShell: [link]
|
||||
- C# Standalone: [link]
|
||||
- Checksums: [link]
|
||||
|
||||
### 📝 Full Changelog
|
||||
### Full Changelog
|
||||
See [CHANGELOG.md](CHANGELOG.md)
|
||||
```
|
||||
|
||||
|
||||
@@ -1,23 +1,36 @@
|
||||
# MokoJoomHero
|
||||
|
||||
Hero/banner component for Joomla
|
||||
A Joomla Module designed to provide a random image from a folder with content on top as a Hero.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [FIREWALL CONFIGURATION](FIREWALL_CONFIGURATION)
|
||||
- [IMPLEMENTATION SUMMARY](IMPLEMENTATION_SUMMARY)
|
||||
- [QUICKSTART](QUICKSTART)
|
||||
- [update server](update-server)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [FIREWALL_CONFIGURATION](FIREWALL_CONFIGURATION) | This document provides guidance on configuring firewalls to allow the automated license download wor... |
|
||||
| [QUICKSTART](QUICKSTART) | This guide helps you get started with the manual GPL license sync workflow that downloads and mainta... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [IMPLEMENTATION_SUMMARY](IMPLEMENTATION_SUMMARY) | This implementation adds automated GPL-3.0 license download functionality with comprehensive firewal... |
|
||||
| [update server](update-server.-.-) | This document explains how `update.xml` is automatically managed for this Joomla extension following... |
|
||||
|
||||
---
|
||||
|
||||
**Category:** Joomla | **Platform:** [moko-platform wiki](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki)
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoJoomHero](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoJoomHero](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -53,8 +53,8 @@ All metadata is extracted from the extension's XML manifest (`src/*.xml`) at bui
|
||||
| `<name>` | `<name>` in manifest | Extension display name |
|
||||
| `<element>` | `<element>` in manifest | Must match installed extension identifier |
|
||||
| `<type>` | `type` attribute on `<extension>` | `component`, `module`, `plugin`, `library`, `package`, `template` |
|
||||
| `<client>` | `client` attribute on `<extension>` | `site` or `administrator` — **required for plugins and modules** |
|
||||
| `<folder>` | `group` attribute on `<extension>` | Plugin group (e.g., `system`, `content`) — **required for plugins** |
|
||||
| `<client>` | `client` attribute on `<extension>` | `site` or `administrator` -- **required for plugins and modules** |
|
||||
| `<folder>` | `group` attribute on `<extension>` | Plugin group (e.g., `system`, `content`) -- **required for plugins** |
|
||||
| `<targetplatform>` | `<targetplatform>` in manifest | Falls back to Joomla 5.x / 6.x if not specified |
|
||||
| `<php_minimum>` | `<php_minimum>` in manifest | Included only if present |
|
||||
|
||||
|
||||
@@ -74,7 +74,6 @@ The `tmpl=component` setting strips the full site template, showing only the art
|
||||
|
||||
---
|
||||
|
||||
*Built with [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,20 +1,36 @@
|
||||
# MokoJoomTOS
|
||||
|
||||
Terms of Service component for Joomla
|
||||
A component to present a sites Term of Service and privacy policy even through offline.
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [update server](update-server)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [Configuration](Configuration) | MokoJoomTOS has a minimal configuration surface -- just one parameter controls which page remains ac... |
|
||||
| [Installation](Installation) | Step-by-step guide to installing the MokoJoomTOS offline access plugin for Joomla. |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [How It Works](How-It-Works.-) | MokoJoomTOS is a Joomla system plugin that intercepts requests during offline mode and selectively a... |
|
||||
| [update server](update-server.-.-) | This document explains how `update.xml` is automatically managed for this Joomla extension following... |
|
||||
|
||||
---
|
||||
|
||||
**Category:** Joomla | **Platform:** [moko-platform wiki](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki)
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoJoomTOS](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoJoomTOS](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -147,7 +147,6 @@ Each step checks for existing resources before creating, making the installer id
|
||||
|
||||
---
|
||||
|
||||
*Built with [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -89,7 +89,6 @@ Note: Uninstalling the plugin does not remove the article or menu item it create
|
||||
|
||||
---
|
||||
|
||||
*Built with [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -53,8 +53,8 @@ All metadata is extracted from the extension's XML manifest (`src/*.xml`) at bui
|
||||
| `<name>` | `<name>` in manifest | Extension display name |
|
||||
| `<element>` | `<element>` in manifest | Must match installed extension identifier |
|
||||
| `<type>` | `type` attribute on `<extension>` | `component`, `module`, `plugin`, `library`, `package`, `template` |
|
||||
| `<client>` | `client` attribute on `<extension>` | `site` or `administrator` — **required for plugins and modules** |
|
||||
| `<folder>` | `group` attribute on `<extension>` | Plugin group (e.g., `system`, `content`) — **required for plugins** |
|
||||
| `<client>` | `client` attribute on `<extension>` | `site` or `administrator` -- **required for plugins and modules** |
|
||||
| `<folder>` | `group` attribute on `<extension>` | Plugin group (e.g., `system`, `content`) -- **required for plugins** |
|
||||
| `<targetplatform>` | `<targetplatform>` in manifest | Falls back to Joomla 5.x / 6.x if not specified |
|
||||
| `<php_minimum>` | `<php_minimum>` in manifest | Included only if present |
|
||||
|
||||
|
||||
@@ -1,22 +1,40 @@
|
||||
# MokoPerfectPublisher-Discord
|
||||
|
||||
Discord publishing plugin
|
||||
A Perfect Publisher plugin to post to Discord
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoPerfectPublisher-Discord) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [INSTALLATION](INSTALLATION)
|
||||
- [templates README template](templates-README-template)
|
||||
- [templates index](templates-index)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | This document provides comprehensive installation and setup instructions for **MokoPerfectPublisher-... |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [templates README template](templates-README-template.-.-) | A standard style for README files |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [templates index](templates-index.-.-) | This index provides navigation to documentation within this folder. |
|
||||
|
||||
---
|
||||
|
||||
**Category:** Joomla | **Platform:** [moko-platform wiki](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki)
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoPerfectPublisher-Discord](https://git.mokoconsulting.tech/MokoConsulting/MokoPerfectPublisher-Discord) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoPerfectPublisher-Discord](https://git.mokoconsulting.tech/MokoConsulting/MokoPerfectPublisher-Discord) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -4,6 +4,7 @@ Testign grond for Moko Consulting
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoTesting) |
|
||||
|
||||
@@ -13,7 +14,7 @@ Testign grond for Moko Consulting
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [INSTALLATION](INSTALLATION) | This document provides comprehensive installation and setup instructions for **[PROJECT_NAME]**. |
|
||||
|
||||
---
|
||||
|
||||
@@ -21,7 +22,7 @@ Testign grond for Moko Consulting
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoTesting](https://git.mokoconsulting.tech/MokoConsulting/MokoTesting) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoTesting](https://git.mokoconsulting.tech/MokoConsulting/MokoTesting) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -164,7 +164,6 @@ All errors use `JFactory::getApplication()->enqueueMessage()` to display user-fa
|
||||
|
||||
---
|
||||
|
||||
*Built with [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -120,7 +120,6 @@ For a typical setup displaying the 3 most recent announcements with dates:
|
||||
|
||||
---
|
||||
|
||||
*Built with [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,21 +1,42 @@
|
||||
# MokoWaaSAnnounce
|
||||
|
||||
Announcements plugin for Joomla
|
||||
A centralized system to make announcements via admin module for Joomla
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaSAnnounce) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [templates README template](templates-README-template)
|
||||
- [templates index](templates-index)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [Configuration](Configuration) | Configuration is split between the host component (announcement management) and the remote module (d... |
|
||||
| [Installation](Installation) | MokoWaaSAnnounce uses a two-part installation: the **component** on the host site and the **module**... |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [Architecture](Architecture) | MokoWaaSAnnounce uses a distributed client-server architecture where one host site manages announcem... |
|
||||
| [templates README template](templates-README-template.-.-) | A standard style for README files |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [templates index](templates-index.-.-) | This index provides navigation to documentation within this folder. |
|
||||
|
||||
---
|
||||
|
||||
**Category:** Joomla | **Platform:** [moko-platform wiki](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki)
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoWaaSAnnounce](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaSAnnounce) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoWaaSAnnounce](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaSAnnounce) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -139,7 +139,6 @@ Warning: Uninstalling the component deletes the `#__mokowaasannounce` database t
|
||||
|
||||
---
|
||||
|
||||
*Built with [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoStandards-API)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ A setup script for Windows
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | C |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoWinSetup) |
|
||||
|
||||
@@ -13,21 +14,21 @@ A setup script for Windows
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | ← [Home](Home) |
|
||||
| [setup guide](setup-guide.-.-) | ← [Home](Home) |
|
||||
| [INSTALLATION](INSTALLATION) | This document provides comprehensive installation and setup instructions for **[PROJECT_NAME]**. |
|
||||
| [setup guide](setup-guide.-.-) | Step-by-step instructions for running MokoWinSetup on a new Windows workstation. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [technical reference](technical-reference.-.-) | ← [Home](Home) |
|
||||
| [templates README template](templates-README-template.-.-) | ← [Home](Home) |
|
||||
| [technical reference](technical-reference.-.-) | Developer and IT reference for MokoWinSetup. |
|
||||
| [templates README template](templates-README-template.-.-) | A standard style for README files |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [templates index](templates-index.-.-) | ← [Home](Home) |
|
||||
| [templates index](templates-index.-.-) | This index provides navigation to documentation within this folder. |
|
||||
|
||||
---
|
||||
|
||||
@@ -35,7 +36,7 @@ A setup script for Windows
|
||||
|
||||
---
|
||||
|
||||
*Repo: [MokoWinSetup](https://git.mokoconsulting.tech/MokoConsulting/MokoWinSetup) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
*Repo: [MokoWinSetup](https://git.mokoconsulting.tech/MokoConsulting/MokoWinSetup) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
|
||||
@@ -18,7 +18,7 @@ Step-by-step instructions for running MokoWinSetup on a new Windows workstation.
|
||||
|
||||
### 1. Get the Files
|
||||
|
||||
Download or copy the `MokoWinSetup` folder to the machine. You can place it anywhere — the Desktop works fine.
|
||||
Download or copy the `MokoWinSetup` folder to the machine. You can place it anywhere -- the Desktop works fine.
|
||||
|
||||
### 2. Run the Launcher
|
||||
|
||||
@@ -36,7 +36,7 @@ The script will apply the registry change to hide the search bar. When prompted:
|
||||
Restart Explorer now to apply? (Y/N)
|
||||
```
|
||||
|
||||
Type `Y` and press Enter. Your taskbar will flicker briefly — this is normal.
|
||||
Type `Y` and press Enter. Your taskbar will flicker briefly -- this is normal.
|
||||
|
||||
### 4. Chrome Install
|
||||
|
||||
@@ -100,7 +100,7 @@ Chrome may have launched but not appeared in the foreground. Check your taskbar.
|
||||
Make sure you are running `Moko-WorkstationSetup.bat`, not the `.ps1` directly. The `.bat` sets the correct execution policy automatically.
|
||||
|
||||
**App shortcuts not appearing**
|
||||
Open the Start Menu and search "Moko" — the shortcuts are in `Start Menu\Programs\Moko Consulting`. If they don't appear, try logging out and back in to refresh the Start Menu index.
|
||||
Open the Start Menu and search "Moko" -- the shortcuts are in `Start Menu\Programs\Moko Consulting`. If they don't appear, try logging out and back in to refresh the Start Menu index.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -68,7 +68,7 @@ If the profile directory does not exist it is created and a minimal `Preferences
|
||||
}
|
||||
```
|
||||
|
||||
Chrome will overwrite and expand this file when it first launches into the profile. The stub is only written if `Preferences` does not already exist — running the script on a machine where Chrome has already been configured will skip this step.
|
||||
Chrome will overwrite and expand this file when it first launches into the profile. The stub is only written if `Preferences` does not already exist -- running the script on a machine where Chrome has already been configured will skip this step.
|
||||
|
||||
---
|
||||
|
||||
@@ -111,7 +111,7 @@ The installer file is downloaded to `%TEMP%\ChromeSetup.exe` and deleted after i
|
||||
|
||||
## Execution Policy
|
||||
|
||||
The `.bat` launcher passes `-ExecutionPolicy Bypass` to PowerShell. This applies only to the single script invocation — it does not permanently change the machine's execution policy.
|
||||
The `.bat` launcher passes `-ExecutionPolicy Bypass` to PowerShell. This applies only to the single script invocation -- it does not permanently change the machine's execution policy.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,18 +1,49 @@
|
||||
# Template-Dolibarr
|
||||
|
||||
Dolibarr module scaffold and platform definition
|
||||
A repo template for a Dolibarr module coding project according to MokoStandards
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | PHP |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [README](README
|
||||
)
|
||||
- [changelog](changelog
|
||||
)
|
||||
- [development](development
|
||||
)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [installation](installation) | This guide provides detailed instructions for installing and configuring your Dolibarr module. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [README](README) | Welcome to the moko-platform Dolibarr Template documentation. This guide will help you navigate all ... |
|
||||
| [changelog](changelog) | All notable changes to this project template will be documented in this file. |
|
||||
| [module id policy](module-id-policy.-.-) | This document explains the module ID assignment policy for Dolibarr modules developed using this tem... |
|
||||
|
||||
## Development
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [development](development) | This guide provides best practices and guidelines for developing Dolibarr modules using this templat... |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [update server](update-server.-.-) | This document explains how `update.txt` is automatically managed for this Dolibarr module. |
|
||||
|
||||
---
|
||||
|
||||
)
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
@@ -138,3 +138,11 @@ Good documentation helps everyone!
|
||||
- New to the template? Start with [Installation Guide](installation.md)
|
||||
- Ready to develop? Check out [Development Guide](development.md)
|
||||
- Need to request a module ID? Review [Module ID Policy](module-id-policy.md)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -60,3 +60,11 @@ Example entry:
|
||||
|
||||
[Unreleased]: https://github.com/mokoconsulting-tech/moko-platform-Template-Dolibarr/compare/v1.0.0...HEAD
|
||||
[1.0.0]: https://github.com/mokoconsulting-tech/moko-platform-Template-Dolibarr/releases/tag/v1.0.0
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -313,3 +313,11 @@ Before publishing your module:
|
||||
- Repository issues for template questions
|
||||
- [Dolibarr Forum](https://www.dolibarr.org/forum) for development help
|
||||
- [Dolibarr GitHub](https://github.com/Dolibarr/dolibarr) for core issues
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -163,3 +163,11 @@ For installation issues:
|
||||
- Create an issue in the repository
|
||||
- Check Dolibarr logs: `/documents/dolibarr.log`
|
||||
- Visit the [Dolibarr Forum](https://www.dolibarr.org/forum)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -250,3 +250,11 @@ For questions about module ID assignment:
|
||||
---
|
||||
|
||||
**Remember**: Using the correct module ID ensures your module integrates seamlessly with Dolibarr and avoids conflicts with other modules in the ecosystem.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -8,7 +8,7 @@ This document explains how `update.txt` is automatically managed for this Doliba
|
||||
|
||||
## How It Works
|
||||
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** -- no JSON, no XML, no trailing newline.
|
||||
|
||||
### Automatic Generation
|
||||
|
||||
@@ -26,7 +26,7 @@ The `url_last_version` in your module descriptor should point to:
|
||||
https://raw.githubusercontent.com/mokoconsulting-tech/moko-platform-Template-Dolibarr/main/update.txt
|
||||
```
|
||||
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** -- the workflows handle it.
|
||||
|
||||
### Branch Lifecycle
|
||||
|
||||
@@ -54,3 +54,11 @@ The `repo_health.yml` workflow verifies on every commit:
|
||||
---
|
||||
|
||||
*Managed by [moko-platform](https://git.mokoconsulting.tech/MokoConsulting/moko-platform). See [docs/workflows/update-server.md](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/blob/main/docs/workflows/update-server.md) for the full specification.*
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Dolibarr](https://git.mokoconsulting.tech/MokoConsulting/Template-Dolibarr) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,15 +1,41 @@
|
||||
# Template-Generic
|
||||
|
||||
Generic project scaffold
|
||||
A repo template for a generic coding project according to MokoStandards
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | Markdown |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/Template-Generic) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [INSTALLATION](INSTALLATION
|
||||
)
|
||||
- [templates README template](templates-README-template
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | This document provides comprehensive installation and setup instructions for **[PROJECT_NAME]**. |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [templates README template](templates-README-template.-.-) | A standard style for README files |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [templates index](templates-index.-.-) | This index provides navigation to documentation within this folder. |
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Generic](https://git.mokoconsulting.tech/MokoConsulting/Template-Generic) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
@@ -428,3 +428,11 @@ For installation support:
|
||||
|
||||
*Last Updated: [DATE]*
|
||||
*Version: [VERSION]*
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Generic](https://git.mokoconsulting.tech/MokoConsulting/Template-Generic) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -126,3 +126,11 @@ This project exists thanks to all the people who contribute.
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2025-11-23 | 0.1.0 | TBD | Initial stub |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Generic](https://git.mokoconsulting.tech/MokoConsulting/Template-Generic) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -20,3 +20,11 @@ This index provides navigation to documentation within this folder.
|
||||
| Change | Notes | Author |
|
||||
| --- | --- | --- |
|
||||
| Automated update | Generated by documentation index automation | rebuild_indexes.py |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-Generic](https://git.mokoconsulting.tech/MokoConsulting/Template-Generic) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -52,3 +52,11 @@ List all configured connections. No parameters.
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-05-07 | 0.0.1 | jmiller | Initial template API reference |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-MCP](https://git.mokoconsulting.tech/MokoConsulting/Template-MCP) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -12,31 +12,31 @@ AI Assistant <--> MCP (stdio) <--> ApiClient <--> REST API
|
||||
|
||||
## Components
|
||||
|
||||
### `src/index.ts` — Server Entry Point
|
||||
### `src/index.ts` -- Server Entry Point
|
||||
|
||||
Registers all MCP tools with `McpServer` from `@modelcontextprotocol/sdk`. Each tool maps to one or more API endpoints. Uses Zod schemas for input validation.
|
||||
|
||||
Includes shared helpers:
|
||||
- `formatResponse()` — normalizes error/success responses into MCP text content
|
||||
- `paginationQuery()` — builds pagination query params
|
||||
- `ConnectionParam` / `PaginationParams` — reusable Zod parameter spreads
|
||||
- `formatResponse()` -- normalizes error/success responses into MCP text content
|
||||
- `paginationQuery()` -- builds pagination query params
|
||||
- `ConnectionParam` / `PaginationParams` -- reusable Zod parameter spreads
|
||||
|
||||
### `src/client.ts` — HTTP Client
|
||||
### `src/client.ts` -- HTTP Client
|
||||
|
||||
The `ApiClient` class handles all HTTP communication:
|
||||
- Uses `node:https` / `node:http` (not `fetch`) for reliable self-signed cert support
|
||||
- Supports GET, POST, PUT, PATCH, DELETE
|
||||
- JSON serialization/deserialization with error handling
|
||||
|
||||
### `src/config.ts` — Configuration Loader
|
||||
### `src/config.ts` -- Configuration Loader
|
||||
|
||||
Loads connection details from `~/.<project>.json`. Supports multiple named connections with a configurable default.
|
||||
|
||||
### `src/types.ts` — Type Definitions
|
||||
### `src/types.ts` -- Type Definitions
|
||||
|
||||
TypeScript interfaces for `ApiConnection`, `ApiConfig`, and `ApiResponse`.
|
||||
|
||||
### `scripts/setup.mjs` — Interactive Setup
|
||||
### `scripts/setup.mjs` -- Interactive Setup
|
||||
|
||||
Node.js script using `readline/promises` for interactive config creation.
|
||||
|
||||
@@ -48,7 +48,7 @@ Node.js 24's built-in `fetch` does not honor self-signed certificate bypass. The
|
||||
|
||||
### Why multiple named connections?
|
||||
|
||||
Multi-instance support is a core use case — managing staging, production, and dev environments from a single MCP server.
|
||||
Multi-instance support is a core use case -- managing staging, production, and dev environments from a single MCP server.
|
||||
|
||||
## Data Flow
|
||||
|
||||
@@ -62,3 +62,11 @@ Multi-instance support is a core use case — managing staging, production, and
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-05-07 | 0.0.1 | jmiller | Initial architecture document |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-MCP](https://git.mokoconsulting.tech/MokoConsulting/Template-MCP) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,15 +1,36 @@
|
||||
# Template-MCP
|
||||
|
||||
MCP server scaffold
|
||||
Template repository for creating MokoStandards-compliant MCP API servers
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | TypeScript |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/Template-MCP) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [API](API
|
||||
)
|
||||
- [ARCHITECTURE](ARCHITECTURE
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | - **Node.js** 20.0.0 or later |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [API](API) | All tools accept an optional `connection` parameter to target a specific named connection. If omitte... |
|
||||
| [ARCHITECTURE](ARCHITECTURE) | {{PROJECT_NAME}} is a Model Context Protocol (MCP) server that bridges AI assistants with a REST API... |
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-MCP](https://git.mokoconsulting.tech/MokoConsulting/Template-MCP) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
@@ -20,10 +20,10 @@ npm run setup
|
||||
|
||||
The setup wizard will prompt for:
|
||||
|
||||
1. **Connection name** — a label for this instance (e.g. `production`, `staging`)
|
||||
2. **API URL** — the base URL of the instance
|
||||
3. **API key/token** — authentication credentials
|
||||
4. **TLS verification** — whether to skip certificate verification (for self-signed certs)
|
||||
1. **Connection name** -- a label for this instance (e.g. `production`, `staging`)
|
||||
2. **API URL** -- the base URL of the instance
|
||||
3. **API key/token** -- authentication credentials
|
||||
4. **TLS verification** -- whether to skip certificate verification (for self-signed certs)
|
||||
|
||||
Run `npm run setup` again to add more connections.
|
||||
|
||||
@@ -91,3 +91,11 @@ Run `npm run setup` to create the config file.
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-05-07 | 0.0.1 | jmiller | Initial installation guide |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [Template-MCP](https://git.mokoconsulting.tech/MokoConsulting/Template-MCP) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -13,17 +13,17 @@ AI Assistant <--> MCP (stdio) <--> DolibarrClient <--> Dolibarr REST API
|
||||
|
||||
## Components
|
||||
|
||||
### `src/index.ts` — Server Entry Point
|
||||
### `src/index.ts` -- Server Entry Point
|
||||
|
||||
Registers all MCP tools with the `McpServer` from `@modelcontextprotocol/sdk`. Each tool maps to one or more Dolibarr API endpoints. Uses Zod schemas for input validation.
|
||||
|
||||
Includes shared helpers:
|
||||
- `formatResponse()` — normalizes Dolibarr error responses and success payloads into MCP text content
|
||||
- `paginationQuery()` — builds `limit`, `page`, `sortfield`, `sortorder` query params
|
||||
- `buildSqlFilter()` — constructs Dolibarr's `sqlfilters` parameter from structured clauses (supports AND/OR joins, proper escaping)
|
||||
- `searchFilter()` — shortcut for `LIKE '%term%'` filters on a single field
|
||||
- `formatResponse()` -- normalizes Dolibarr error responses and success payloads into MCP text content
|
||||
- `paginationQuery()` -- builds `limit`, `page`, `sortfield`, `sortorder` query params
|
||||
- `buildSqlFilter()` -- constructs Dolibarr's `sqlfilters` parameter from structured clauses (supports AND/OR joins, proper escaping)
|
||||
- `searchFilter()` -- shortcut for `LIKE '%term%'` filters on a single field
|
||||
|
||||
### `src/client.ts` — HTTP Client
|
||||
### `src/client.ts` -- HTTP Client
|
||||
|
||||
The `DolibarrClient` class handles all HTTP communication with Dolibarr instances:
|
||||
|
||||
@@ -32,15 +32,15 @@ The `DolibarrClient` class handles all HTTP communication with Dolibarr instance
|
||||
- Sends `Accept: application/json` and `Content-Type: application/json`
|
||||
- Supports GET, POST, PUT, and DELETE methods
|
||||
|
||||
### `src/config.ts` — Configuration Loader
|
||||
### `src/config.ts` -- Configuration Loader
|
||||
|
||||
Loads connection details from `~/.dolibarr-api-mcp.json`. Supports multiple named connections with a configurable default. Respects the `DOLIBARR_API_MCP_CONFIG` environment variable for custom config paths.
|
||||
|
||||
### `src/types.ts` — Type Definitions
|
||||
### `src/types.ts` -- Type Definitions
|
||||
|
||||
TypeScript interfaces for `DolibarrConnection`, `DolibarrConfig`, and `ApiResponse`.
|
||||
|
||||
### `scripts/setup.mjs` — Interactive Setup
|
||||
### `scripts/setup.mjs` -- Interactive Setup
|
||||
|
||||
Node.js script using `readline/promises` that walks users through creating the config file. Supports adding multiple connections incrementally.
|
||||
|
||||
@@ -52,11 +52,11 @@ Node.js 24's built-in `fetch` (undici-based) does not honor `NODE_TLS_REJECT_UNA
|
||||
|
||||
### Why `DOLAPIKEY` instead of Bearer tokens?
|
||||
|
||||
Dolibarr's REST API authenticates via the `DOLAPIKEY` HTTP header, not OAuth or Bearer tokens. This is Dolibarr's native mechanism — each user has a per-user API key that inherits that user's permissions. There is no token expiration; keys persist until manually regenerated.
|
||||
Dolibarr's REST API authenticates via the `DOLAPIKEY` HTTP header, not OAuth or Bearer tokens. This is Dolibarr's native mechanism -- each user has a per-user API key that inherits that user's permissions. There is no token expiration; keys persist until manually regenerated.
|
||||
|
||||
### Why `PUT` instead of `PATCH`?
|
||||
|
||||
Dolibarr's API uses `PUT` for updates (full or partial), not `PATCH`. The API accepts partial payloads via PUT — only the fields you send are updated.
|
||||
Dolibarr's API uses `PUT` for updates (full or partial), not `PATCH`. The API accepts partial payloads via PUT -- only the fields you send are updated.
|
||||
|
||||
### Why `sqlfilters` with a builder?
|
||||
|
||||
@@ -67,7 +67,7 @@ Dolibarr's API supports a custom `sqlfilters` query parameter that allows server
|
||||
|
||||
### Why per-connection API keys?
|
||||
|
||||
Each Dolibarr instance requires its own API key scoped to a specific user. Multi-instance support is a core use case — managing staging, production, and dev ERP environments from a single MCP server.
|
||||
Each Dolibarr instance requires its own API key scoped to a specific user. Multi-instance support is a core use case -- managing staging, production, and dev ERP environments from a single MCP server.
|
||||
|
||||
## Data Flow
|
||||
|
||||
@@ -102,3 +102,11 @@ Each Dolibarr instance requires its own API key scoped to a specific user. Multi
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-05-07 | 0.0.1 | jmiller | Initial architecture document |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [dolibarr-api-mcp](https://git.mokoconsulting.tech/MokoConsulting/dolibarr-api-mcp) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,14 +1,35 @@
|
||||
# dolibarr-api-mcp
|
||||
|
||||
Dolibarr ERP/CRM API
|
||||
MCP server for Dolibarr ERP/CRM REST API operations
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| **Language** | TypeScript |
|
||||
| **License** | GPL-3.0-or-later |
|
||||
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/dolibarr-api-mcp) |
|
||||
|
||||
---
|
||||
|
||||
## Pages
|
||||
## Guides
|
||||
|
||||
- [ARCHITECTURE](ARCHITECTURE
|
||||
)
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [INSTALLATION](INSTALLATION) | - **Node.js** 20.0.0 or later |
|
||||
|
||||
## Reference
|
||||
|
||||
| Page | Description |
|
||||
|---|---|
|
||||
| [ARCHITECTURE](ARCHITECTURE) | dolibarr-api-mcp is a Model Context Protocol (MCP) server that bridges AI assistants (Claude Code, C... |
|
||||
|
||||
---
|
||||
|
||||
|
||||
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
|
||||
|
||||
---
|
||||
|
||||
*Repo: [dolibarr-api-mcp](https://git.mokoconsulting.tech/MokoConsulting/dolibarr-api-mcp) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
@@ -21,10 +21,10 @@ npm run setup
|
||||
|
||||
The setup wizard will prompt for:
|
||||
|
||||
1. **Connection name** — a label for this instance (e.g. `production`, `staging`)
|
||||
2. **Dolibarr URL** — the base URL of the instance (e.g. `https://erp.example.com`)
|
||||
3. **API key** — the Dolibarr API key for authentication
|
||||
4. **TLS verification** — whether to skip certificate verification (for self-signed certs)
|
||||
1. **Connection name** -- a label for this instance (e.g. `production`, `staging`)
|
||||
2. **Dolibarr URL** -- the base URL of the instance (e.g. `https://erp.example.com`)
|
||||
3. **API key** -- the Dolibarr API key for authentication
|
||||
4. **TLS verification** -- whether to skip certificate verification (for self-signed certs)
|
||||
|
||||
Run `npm run setup` again to add more connections.
|
||||
|
||||
@@ -52,7 +52,7 @@ The user's permissions determine what the API key can access. Use a dedicated AP
|
||||
|
||||
1. Go to **Home > Setup > Security > Tokens & API**
|
||||
2. Generate or configure the system API key
|
||||
3. This key has broader access — use with caution
|
||||
3. This key has broader access -- use with caution
|
||||
|
||||
## Register with Claude Code
|
||||
|
||||
@@ -126,7 +126,7 @@ npm start
|
||||
|
||||
If configured correctly, the server will start listening on stdio. If the config is missing or invalid, it will print an error with instructions.
|
||||
|
||||
You can also test the connection by asking Claude to run `dolibarr_status` — this calls the `/api/index.php/status` endpoint and returns the Dolibarr version.
|
||||
You can also test the connection by asking Claude to run `dolibarr_status` -- this calls the `/api/index.php/status` endpoint and returns the Dolibarr version.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@@ -156,3 +156,11 @@ The config file `~/.dolibarr-api-mcp.json` is missing or malformed. Run `npm run
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-05-07 | 0.0.1 | jmiller | Initial installation guide |
|
||||
|
||||
---
|
||||
|
||||
*Repo: [dolibarr-api-mcp](https://git.mokoconsulting.tech/MokoConsulting/dolibarr-api-mcp) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
[<- Back to Home](Home)
|
||||
|
||||
# DNS Management
|
||||
|
||||
## List records
|
||||
@@ -18,8 +20,16 @@ dreamhost_dns_add(record: "_dmarc.example.com", type: "TXT", value: "v=DMARC1; p
|
||||
dreamhost_dns_remove(record: "old.example.com", type: "A", value: "203.0.113.1")
|
||||
```
|
||||
|
||||
Must specify exact value — API matches on record+type+value tuple.
|
||||
Must specify exact value -- API matches on record+type+value tuple.
|
||||
|
||||
## Propagation
|
||||
|
||||
Changes take 15-60 minutes. Use `dig` or online tools to verify.
|
||||
|
||||
---
|
||||
|
||||
*Repo: [dreamhost-mcp](https://git.mokoconsulting.tech/MokoConsulting/dreamhost-mcp) . [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*
|
||||
|
||||
| Revision | Date | Author | Description |
|
||||
|---|---|---|---|
|
||||
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user