doc:editor
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:editor [2010/03/12 02:07] – partial english rewrite philip | doc:editor [2018/09/13 03:11] (current) – Wording some misspellings carusogabriel | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Getting started ====== | ====== Getting started ====== | ||
- | Eventually the documentation at php.net | + | Currently all documentation |
- | The editor may also be accessed from here: http:// | + | The editor may also be accessed from here: https:// |
- | ====== Who can edit a page ? ====== | + | ====== Who can edit a page? ====== |
* Anonymous users may create patches | * Anonymous users may create patches | ||
* People with SVN accounts may apply their and other peoples patches | * People with SVN accounts may apply their and other peoples patches | ||
+ | |||
===== Anonymous users ===== | ===== Anonymous users ===== | ||
+ | {{: | ||
- | {{: | + | When the application starts, the default Login is " |
- | When the application starts, the default Login is " | + | |
- | An anonymous user can edit any page and save the work as patch. While saving, an email may be entered that' | + | * an empty Login / empty password |
+ | * your [[https:// | ||
+ | * your [[https:// | ||
+ | * your [[https:// | ||
+ | * your [[https:// | ||
+ | * your [[https:// | ||
+ | * your [[https:// | ||
+ | |||
+ | With a Facebook/ | ||
+ | |||
+ | An anonymous user can edit any page and save the work as a patch. While saving, an email may be entered that' | ||
===== SVN users ===== | ===== SVN users ===== | ||
- | |||
People with SVN accounts (and appropriate karma) may login using said account. With it you can: | People with SVN accounts (and appropriate karma) may login using said account. With it you can: | ||
Line 22: | Line 32: | ||
* commit your changes | * commit your changes | ||
* commit other peoples pending patches | * commit other peoples pending patches | ||
- | |||
- | ====== Main Menu ====== | ||
- | |||
- | ===== Refresh all data ===== | ||
- | ===== Build Tools ===== | ||
- | ==== Check Build ==== | ||
- | ==== Last Failed Build ==== | ||
- | |||
- | ===== EN tools ===== | ||
- | ==== Script Check Entities ==== | ||
- | ===== View the last result ===== | ||
- | ===== Run this script ===== | ||
- | |||
- | ==== Script Check doc ==== | ||
- | |||
- | ===== Configure ===== | ||
- | ===== Erase my personal data ===== | ||
- | ===== Log out ===== | ||
- | ===== Report bugs ===== | ||
- | ===== Documentation ===== | ||
- | ===== About ===== | ||
====== All modules ====== | ====== All modules ====== | ||
- | All module | + | All modules |
===== Files Needing Translation ===== | ===== Files Needing Translation ===== | ||
{{ : | {{ : | ||
+ | |||
This module displays all the files that are available in the English documentation, | This module displays all the files that are available in the English documentation, | ||
Simply double-click on a file to open a new tab. The English file is displayed and you can start translating it directly. | Simply double-click on a file to open a new tab. The English file is displayed and you can start translating it directly. | ||
- | < | + | Revcheck and Reviewed tags will be added automatically by the editor, with the right version number, and your name as Maintainer. |
+ | Although, | ||
Once you have modified this file, you may save your work (for SVN authenticated users), or save it as a patch (for anonymous users). | Once you have modified this file, you may save your work (for SVN authenticated users), or save it as a patch (for anonymous users). | ||
Your modifications appear respectively in the " | Your modifications appear respectively in the " | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
===== Files Need Update ===== | ===== Files Need Update ===== | ||
{{ : | {{ : | ||
- | Based on the Revcheck tag, this module lists all files which have been modified in English but not yet synchronized in the chosen language. All files are sorted by folder and then filename. | + | |
+ | Based on the Revcheck tag, this module lists all files which have been modified in English but not yet synchronized in the chosen language. All files are sorted by folder and their filename. | ||
< | < | ||
+ | |||
+ | **Don' | ||
You may simply double-click on a file to start editing them into a new tab. | You may simply double-click on a file to start editing them into a new tab. | ||
You may also right-click on it to display context menu, which then offers several other options. | You may also right-click on it to display context menu, which then offers several other options. | ||
- | Once you start editing a file, the main panel display 4 sub-panel: | + | Once you start editing a file, the main panel display 4 sub-panels: |
* On the top, the diff presents all modification made to the English language. | * On the top, the diff presents all modification made to the English language. | ||
* On the right, you can display the SVN log for this file, both as the chosen language and English. | * On the right, you can display the SVN log for this file, both as the chosen language and English. | ||
- | * On the center you have 2 panels: | + | * On the center, you have 2 panels: |
* One for the LANG file | * One for the LANG file | ||
* One for the EN file | * One for the EN file | ||
Line 90: | Line 76: | ||
===== Error in current translation ===== | ===== Error in current translation ===== | ||
{{ : | {{ : | ||
- | This module | + | |
- | When the data is updated, there is a lot of checks done once each files. | + | This module |
- | You can view all checks done by right-click on a file and chose the sub-menu "About error type". This action | + | When the data is updated, there is a lot of checks done once each file. |
+ | You can view all checks done by right-click on a file and chose the sub-menu "About error type". This action | ||
One you double-click into a file of this module, a new tab is open, similar to a "need update" | One you double-click into a file of this module, a new tab is open, similar to a "need update" | ||
Line 98: | Line 85: | ||
* On the top, the error type for this file. | * On the top, the error type for this file. | ||
* On the right, you can display all SVN log for this file, into the chosen language, and into English. | * On the right, you can display all SVN log for this file, into the chosen language, and into English. | ||
- | * On the center you have 2 panels : | + | * On the center, you have 2 panels : |
* One for the lang file | * One for the lang file | ||
* One for the EN file | * One for the EN file | ||
Line 108: | Line 95: | ||
===== Files Need Reviewed ===== | ===== Files Need Reviewed ===== | ||
{{ : | {{ : | ||
+ | |||
This module displays all files which need to be reviewed (based on the reviewed tag). | This module displays all files which need to be reviewed (based on the reviewed tag). | ||
< | < | ||
Line 117: | Line 105: | ||
* On the right, you can display the SVN log for this file, both from the chosen language, and English. | * On the right, you can display the SVN log for this file, both from the chosen language, and English. | ||
- | * On the center you have 2 panels: | + | * On the center, you have 2 panels: |
* One for the LANG file | * One for the LANG file | ||
* One for the EN file | * One for the EN file | ||
Line 125: | Line 113: | ||
Your modification appears respectively in the ' | Your modification appears respectively in the ' | ||
- | < | + | < |
===== Not in EN ===== | ===== Not in EN ===== | ||
{{ : | {{ : | ||
+ | |||
This module lists all files which are in the chosen language, but not in EN. | This module lists all files which are in the chosen language, but not in EN. | ||
Usually, this happens when a file is deleted from EN tree but not yet synced in the chosen language. | Usually, this happens when a file is deleted from EN tree but not yet synced in the chosen language. | ||
- | After double-clicking, | + | After double-clicking, |
Right-click on it and choose " | Right-click on it and choose " | ||
- | < | + | An anonymous user can mark a file to be deleted, as this really only appends on commit. |
- | + | ||
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
===== All files ===== | ===== All files ===== | ||
{{ : | {{ : | ||
+ | |||
This module allows you to browse the entire repository for the English language, or the chosen language. | This module allows you to browse the entire repository for the English language, or the chosen language. | ||
- | This is useful when you want to edit some files witch are ignore | + | This is useful when you want to edit some files which are ignored |
- | So, you can edit any files, save it or make a patch, and add it to Pending Commit module. | + | So, you can edit any file, save it or make a patch, and then add it to the 'Pending Commit' |
- | The context menu allow you to start editing the file into a new tab, but also open the same file into the EN tree (if the file is a chosen language file) or into the chose language (if the file is an EN file). | + | The context menu allows |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
===== Pending for commit ===== | ===== Pending for commit ===== | ||
{{ : | {{ : | ||
- | This module list all files witch have been modified by you, or by others peoples (authenticate or not) for English files and for the chosen language. | ||
- | All action (and sub-menu) depends on where the file have been modified. | + | This module lists all files which have been modified |
- | == File modified | + | All action (and sub-menus) depend on where the file has been modified. |
- | A double-click on this type of file open it as it will be open from the "Need Translate" | + | == File modified from "Need Translate" |
+ | A double-click on this type of file opens it as if it's been opened | ||
- | The following | + | The following |
- | - Edit in a new tab : this is the default action. | + | - Edit in a new tab : this is the default action. |
- | - Clear this change : cancel this modification. | + | - Clear this change : cancels the modification. |
- Commit : Common commit menu (see below) | - Commit : Common commit menu (see below) | ||
== File modified from "Need Update" | == File modified from "Need Update" | ||
- | A double-click on this type of file open it as it will be open from the "Need Update" | + | A double-click on this type of file opens it as if it was opened |
- | The following | + | The following |
- | - Edit in a new tab : this is the default action. Same as a double-click directly on the file in the grid. | + | - Edit in a new tab : this is the default action. Same as a double-clicking |
- | - View diff : Open a tab and display | + | - View diff : Opens a tab and displays |
- | - Download the diff as a patch : Open the default download window for downloading the difference as a patch file. | + | - Download the diff as a patch : Opens the default download window for downloading the difference |
- | - Clear this change : cancel this modification. | + | - Clear this change : cancels the modification. |
- Commit : Common commit menu (see below) | - Commit : Common commit menu (see below) | ||
== File modified from "Error in current translation" | == File modified from "Error in current translation" | ||
- | A double-click on this type of file open it as it will be open from the "Error in current translation" | + | A double-click on this type of file opens it as if it was opened |
The context-menu is identical to the context-menu of a file modified from "Need Update" | The context-menu is identical to the context-menu of a file modified from "Need Update" | ||
== File modified from "Files Need Reviewed" | == File modified from "Files Need Reviewed" | ||
- | A double-click on this type of file open it as it will be open from the "Files Need Reviewed" | + | A double-click on this type of file opens it as if it was opened |
The context-menu is identical to the context-menu of a file modified from "Need Update" | The context-menu is identical to the context-menu of a file modified from "Need Update" | ||
== File modified from "Not in EN" module == | == File modified from "Not in EN" module == | ||
- | A double-click on this type of file open it as it will be open from the "Not in EN" module. | + | A double-click on this type of file opens it as if it was opened |
- | The following | + | The following |
- | - View in a new tab : this is the default action. Same as a double-click directly on the file in the grid. Display | + | - View in a new tab : this is the default action. Same as a double-clicking |
- Clear this deletion | - Clear this deletion | ||
- Commit : Common commit menu (see below) | - Commit : Common commit menu (see below) | ||
== File modified from "All files" module == | == File modified from "All files" module == | ||
- | A double-click on this type of file open it as it will be open from the "Files Need Reviewed" | + | A double-click on this type of file opens it as if it was opened |
The context-menu is identical to the context-menu of a file modified from "Need Update" | The context-menu is identical to the context-menu of a file modified from "Need Update" | ||
- | ==== ==== | + | ==== Committing changes |
- | From all of this, there is a default sub-menu " | + | From all of this, there is a default sub-menu " |
- | * Commit this file : this open the commit window with just one file ; this from witch we have right-clicked | + | * Commit this file: this opens the commit window with just one file; which is the file that was right-clicked |
- | * Commit all files modified by the current user : this open the commit window containing all files modified by the current user for the chosen language and for ENglish | + | * Commit all files modified by the current user: this opens the commit window containing all files modified by the current user for the chosen language, and for English |
- | * commit all files modified by everyone : this open the commit window containing all files modified for the chosen language and for ENglish | + | * commit all files modified by everyone: this opens the commit window containing all files modified for the chosen language and for English |
== The commit window == | == The commit window == | ||
{{ : | {{ : | ||
- | This window is compose | + | |
+ | This window is composed | ||
* The list of files you want to commit | * The list of files you want to commit | ||
- | Each file have a checkbox (checked by default) to allow you to exclude it for the current commit, or not. | + | Each file has a checkbox (checked by default) to allow you to exclude it for the current commit, or not. |
- | * The list of old commit | + | * The list of old commit |
Each time you commit, by default, your message is saved and you can use the element to re-use it. | Each time you commit, by default, your message is saved and you can use the element to re-use it. | ||
* The area to enter the log message for the current commit | * The area to enter the log message for the current commit | ||
- | Just hint the " | + | Select |
- | Once the commit is done, some part of the window | + | Once the commit is done, part of the window |
- | \\ | + | |
- | \\ | + | == Manage your old commit |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
- | == Manage your old commit | + | |
{{ : | {{ : | ||
- | In the commit window, you can see on the top - right, a little gear, allowing you to manage your old commit message. | ||
- | A click on it open a window where you can delete / modify your commit log messages. | ||
- | To delete a message, just right click on it and chose " | + | In the commit window, you can see on the top - right, a little gear, which allows you to manage your old commit messages. |
- | To modify a message, just double-click on it and modify it ! Just click outside of the field to save it automatically | + | A click on it opens a window where you can delete / modify your commit log messages. |
- | \\ | + | |
- | \\ | + | To delete a message, just right-click on it and choose |
- | \\ | + | To modify a message, just double-click on it and modify it. Then, click outside of the field to save it automatically. |
- | \\ | + | |
- | \\ | + | |
- | \\ | + | |
===== Pending Patch ===== | ===== Pending Patch ===== | ||
{{ : | {{ : | ||
- | This module list all pending patchs, ready to be committed for the chosen language and for the English language. | ||
- | As of " | + | This module lists all pending patches, which are ready to be committed for the chosen language and for the English language. |
+ | |||
+ | Just like " | ||
- | When you double-click on a patch, a new tab is open and is composed of 4 panels : | + | When you double-click on a patch, a new tab is opened |
- | * On the top, the diff from the original | + | * On the top, the diff of the original and modified |
- | * On the left, a panel to display VCS log message | + | * On the left, a panel to display VCS log messages |
- | * On the center, 2 panels : | + | * On the center, 2 panels: |
* On the left, the patched version of the file | * On the left, the patched version of the file | ||
* On the right, the original version of the file | * On the right, the original version of the file | ||
- | Directly | + | Directly |
- | * Accept this patch and save the file : The patch disappears from " | + | * Accept this patch and save the file: The patch disappears from the " |
- | * Reject the patch : The patch disappears from " | + | * Reject the patch: The patch disappears from the " |
- | When you accept or reject a patch, the user receive | + | When you accept or reject a patch, the user receives |
doc/editor.1268359632.txt.gz · Last modified: 2017/09/22 13:28 (external edit)