doc:editor

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
doc:editor [2014/04/06 10:01] – general update sobakdoc:editor [2018/09/13 03:11] (current) – Wording some misspellings carusogabriel
Line 1: Line 1:
 ====== Getting started ====== ====== Getting started ======
-Currently all documentation pages at php.net have link to the online editor, which allow anyone (anonymous or not) to edit manual pages. Link is placed under language select. +Currently all documentation pages at php.net have a link to the online editor, which allow anyone (anonymous or not) to edit manual pages. The link is placed under language select. 
  
 The editor may also be accessed from here: https://edit.php.net/ The editor may also be accessed from here: https://edit.php.net/
Line 9: Line 9:
  
 ===== Anonymous users ===== ===== Anonymous users =====
-{{:doc:phdoe_login.png | }}+{{:doc:phdoe_login.png}}
  
-When the application starts, the default Login is "Anonymous", with a blank password. You may login-in with an empty Login / empty password too.+When the application starts, the default Login is "Anonymous", with a blank password. You may login-in anonymously via :
  
-An anonymous user can edit any page and save the work as patch. While saving, an email may be entered that'll then be notified when the patch is approved or deleted. And all users may view patches under the "Pending Patch" tab.+  * an empty Login / empty password 
 +  * your [[https://www.facebook.com|Facebook]] account 
 +  * your [[https://www.github.com|Github]] account 
 +  * your [[https://www.google.com|Google]] account 
 +  * your [[https://www.linkedin.com|Linkedin]] account 
 +  * your [[https://www.stackoverflow.com|Stackoverflow]] account 
 +  * your [[https://www.instagram.com|Instagram]] account 
 + 
 +With a Facebook/Github/Google/Lindekin/Stackoverflow/Instagram account, we can better identify the user who submitted a patch. 
 + 
 +An anonymous user can edit any page and save the work as a patch. While saving, an email may be entered that'll then be notified when the patch is approved or deleted. And all users may view patches under the "Pending Patch" tab.
  
 ===== SVN users ===== ===== SVN users =====
Line 24: Line 34:
  
 ====== All modules ====== ====== All modules ======
-All module are available for all languages except English, because translation related modules (like graphs displaying the translation percentage) don't make sense for English.+All modules are available for all languages except English, because translation related modules (like graphs displaying the translation percentage) don't make sense for English.
  
 ===== Files Needing Translation ===== ===== Files Needing Translation =====
Line 33: Line 43:
 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.
  
-**Don't** forget to add the Revcheck and Reviewed tags before saving your work. You can insert them via the file menu "MarkUp".+Revcheck and Reviewed tags will be added automatically by the editor, with the right version number, and your name as Maintainer.   
 +Although, You can insert them via the file menu "MarkUp".
  
 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).
Line 42: Line 53:
 {{ :doc:phdoe_need_update.png?500|}} {{ :doc:phdoe_need_update.png?500|}}
  
-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.
  
 <code><!-- EN-Revision: 288721 Maintainer: felipe Status: ready --></code> <code><!-- EN-Revision: 288721 Maintainer: felipe Status: ready --></code>
 +
 +**Don't forget** to update manually the EN-Revision number to the revision number in English from which you update the given file.
  
 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.
Line 53: Line 66:
    * 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 64: Line 77:
 {{ :doc:phdoe_file_error.png?500|}} {{ :doc:phdoe_file_error.png?500|}}
  
-This module present all files in error. +This module presents all files in error. 
-When the data is updated, there is a lot of checks done once each files. +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 display all error type into a new tab.+You can view all checks done by right-click on a file and chose the sub-menu "About error type". This action displays all error type into a new tab.
  
 One you double-click into a file of this module, a new tab is open, similar to a "need update" tab. One you double-click into a file of this module, a new tab is open, similar to a "need update" tab.
Line 72: 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 92: 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 100: Line 113:
 Your modification appears respectively in the 'Pending Commit' or the 'Pending Patch' module. Your modification appears respectively in the 'Pending Commit' or the 'Pending Patch' module.
  
-<code>The context menu allow you to open all files for the current extension. So, you can review all files for a given extension and be more consistent with your work.</code>+<code>The context menu allows you to open all files for the current extension. So, you can review all files for a given extension and be more consistent with your work.</code>
  
 ===== Not in EN ===== ===== Not in EN =====
Line 108: Line 121:
 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, a new tab will open and you can view the files contents. It cannot be edited here.+After double-clicking, a new tab will open and you can view the file's contents. It cannot be edited here.
  
 Right-click on it and choose "Remove this file" to add it to Pending Commit module. Right-click on it and choose "Remove this file" to add it to Pending Commit module.
Line 130: Line 143:
 This module lists all files which have been modified by you, or by other peoples (authenticated or not) for English files, and for the chosen language. This module lists all files which have been modified by you, or by other peoples (authenticated or not) for English files, and for the chosen language.
  
-All action (and sub-menus) depend on where the file have been modified.+All action (and sub-menus) depend on where the file has been modified.
  
 == File modified from "Need Translate" module == == File modified from "Need Translate" module ==
Line 173: Line 186:
 The context-menu is identical to the context-menu of a file modified from "Need Update" module. The context-menu is identical to the context-menu of a file modified from "Need Update" module.
  
-==== Commiting changes ====+==== Committing changes ====
 From all of this, there is a default sub-menu "**Commit...**" which allows you to: From all of this, there is a default sub-menu "**Commit...**" which allows you to:
  
doc/editor.1396778514.txt.gz · Last modified: 2017/09/22 13:28 (external edit)

Page Tools