-
Notifications
You must be signed in to change notification settings - Fork 4
Commands
Gerrit Uitslag edited this page Jan 24, 2023
·
11 revisions
All available commands for the Symphony framework could be listed using php app/console list
Available custom commands for the translation tool:
-
dokuwiki:add- Adds a repository -
dokuwiki:deleteRepo- Delete a repository -
dokuwiki:editRepo- Let edit some properties of repository. Supported: giturl, branch, state, email, englishReadonly -
dokuwiki:setup- Prepare software for first run -
dokuwiki:showStats- Show some statistics for maintenance -
dokuwiki:softReset- Reset lock, tmp folder, error count and last updated -
dokuwiki:updateDwApi- Update cache from dokuwiki api (daily cron job) -
dokuwiki:updateGit- Update local git repositories and send pending translations (regular cron job) -
dokuwiki:updateLanguages- Updates all language information from local repository. Needed if changing the stored translations objects (e.g. due changes in LanguageFileParser, LocalText)
Usage
php app/console dokuwiki:add [...your arguments...]
The translation tool runs two cron jobs, the other commands are for manual administration tasks.
See also
- Cronjob overview
- Administration tasks: https://www.dokuwiki.org/teams:translate-tool
For running a command in production you should add --env=prod to the command.
php app/console help dokuwiki:add
Usage:
dokuwiki:add [type] [name] [gitUrl] [branch] [popularity] [displayName] [email] [author] [englishreadonly]
Arguments:
type Repository type: core or plugin
name Name of the repository (lower case, no special chars or blanks)
gitUrl public git url
branch default branch
popularity popularity value (used to sort)
displayName name to display
email author email address
author author name
englishreadonly If readonly, English translations can not be submitted in the tool
php app/console help dokuwiki:deleteRepo
Usage:
dokuwiki:deleteRepo type name
Arguments:
type plugin or core
name repository name
php app/console help dokuwiki:editRepo
Usage:
dokuwiki:editRepo <type> <name> <property> <value>
Arguments:
type plugin, template or core
name repository name
property property name
value string or true/false
php app/console help dokuwiki:updateLanguages
Usage:
dokuwiki:updateLanguages
php app/console help dokuwiki:setup
Usage:
dokuwiki:setup
php app/console help dokuwiki:showStats
Usage:
dokuwiki:showStats
php app/console help dokuwiki:softReset
Usage:
dokuwiki:softReset type name
Arguments:
type plugin or core
name repository name
php app/console help dokuwiki:updateGit
Usage:
dokuwiki:updateGit
php app/console help dokuwiki:updateDwApi
Usage:
dokuwiki:updateDwApi
Process
- Translation process
- CronJob overview triggers some commands.
- Commands for regular tasks and occasional maintenance
Files
Maintenance/development
- Deploying to Production is done from GitHub
- Development setup
- Maintenance
- Alternative Git interaction when setting up development setup
- Test steps for checking working of the tool
Documentation
- Components of Symphony used for the Tool
- More detail about using Doctrine
- Description working of the Forms