Santhosh has uploaded a new change for review. https://gerrit.wikimedia.org/r/106186
Change subject: Set up the extension with basic files and configurations ...................................................................... Set up the extension with basic files and configurations Change-Id: I47bd086c81a2e2a33172fdc005c67df2d7f406cc --- A AUTHORS.txt A CONTRIBUTING.md A ContentTranslation.php A LICENSE.txt A README.md A Resources.php A i18n/en.json A i18n/qqq.json 8 files changed, 576 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/ContentTranslation refs/changes/86/106186/1 diff --git a/AUTHORS.txt b/AUTHORS.txt new file mode 100644 index 0000000..1c91f88 --- /dev/null +++ b/AUTHORS.txt @@ -0,0 +1,3 @@ +Amir E. Aharoni <amir.ahar...@mail.huji.ac.il> +Santhosh Thottingal <santhosh.thottin...@gmail.com> +Siebrand Mazeland <s.mazel...@xs4all.nl> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..851a641 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,140 @@ +# Contributing to ContentTranslation + +Thank you for helping us develop ContentTranslation! + +This document describes how to report bugs, set up your development +environment, run tests, and build documentation. It also provides the coding +conventions we use in the project. + +## Bug reports + +Please report bugs to [bugzilla.wikimedia.org](https://bugzilla.wikimedia.org/enter_bug.cgi?product=ContentTranslation&component=General) +using the `ContentTranslation` product. Feel free to use the `General` +component if you don't know where else your bug might belong. Don't +worry about specifying version, severity, hardware, or OS. + +## Running tests + +To run the tests in a web browser, make sure your MediaWiki install is +[configured](https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing) to +allow running of tests. Set in `LocalSettings.php`: +```php +// https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing +$wgEnableJavaScriptTest = true; +``` + +Then open `http://URL_OF_MEDIAWIKI/index.php/Special:JavaScriptTest/qunit` +(for example, <http://localhost/w/index.php/Special:JavaScriptTest/qunit>). + +## Building documentation + +ContentTranslation uses [JSDuck](https://github.com/senchalabs/jsduck) to process +documentation comments embedded in the code. To build the documentation, you +will need `ruby`, `gem`, and `jsduck` installed. + +### Installing ruby and gem + +You're mostly on your own here, but we can give some hints for Mac OS X. + +##### Installing Gem in Mac OS X +Ruby ships with OSX but may be outdated. Use [Homebrew](http://mxcl.github.com/homebrew/): +```sh +$ brew install ruby +``` + +If you've never used `gem` before, don't forget to add the gem's bin to your +`PATH` ([howto](http://stackoverflow.com/a/14138490/319266)). + +### Installing jsduck + +Once you have gem, installing [JSDuck](https://github.com/senchalabs/jsduck) is easy: +```sh +$ gem install --user-install jsduck +``` + +### Running jsduck + +Creating the documentation is easy: +```sh +$ cd ContentTranslation +$ .docs/generate.sh +``` + +You may need to set `MW_INSTALL_PATH` in your environment to the location of +your mediawiki installation if ContentTranslation is not checked out directly in the +mediawiki extensions folder (for example, if you're using a symlink). + +The generated documentation is in the `docs/` subdirectory. View the +documentation at +`http://URL_OF_MEDIAWIKI/extensions/ContentTranslation/docs/` +(for example, <http://localhost/w/extensions/ContentTranslation/docs>). + +Note that `jsduck` doesn't support browsing vis the `file:` protocol. + +## ContentTranslation Code Guidelines + +We inherit the code structure (about whitespace, naming and comments) conventions +from MediaWiki. See [Manual:Coding conventions/JavaScript](https://www.mediawiki.org/wiki/Manual:Coding_conventions/JavaScript) +on mediawiki.org. + +Git commit messages should follow the conventions described in +<https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines>. + +### Documentation comments + +* End sentences in a full stop. +* Continue sentences belonging to an annotation on the next line, indented with an + additional space. +* Types in documentation comments should be separated by a pipe character. Use types + that are listed in the Types section of this document, otherwise use the identifier + (full path from the global scope) of the constructor function (e.g. `{ve.dm.BranchNode}`). + +### Annotations + +We use the following annotations. They should be used in the order as they are described +here, for consistency. See [JSDuck/Tags](https://github.com/senchalabs/jsduck/wiki/Tags) for more elaborate documentation. + +* @class Name (optional, guessed) +* @abstract +* @extends ClassName +* @mixins ClassName +* @constructor +* @private +* @static +* @method name (optional, guessed) +* @template +* @property name (optional, guessed) +* @until Text: Optional text. +* @source Text +* @context {Type} Optional text. +* @param {Type} name Optional text. +* @emits name +* @returns {Type} Optional text. +* @chainable +* @throws {Type} + +### Types + +Special values: +* undefined +* null +* this + +Primitive types: +* boolean +* number +* string + +Built-in classes: +* Array +* Date +* Function +* RegExp +* Object + +Browser classes: +* HTMLElement + +jQuery classes: +* jQuery +* jQuery.Event diff --git a/ContentTranslation.php b/ContentTranslation.php new file mode 100644 index 0000000..257869e --- /dev/null +++ b/ContentTranslation.php @@ -0,0 +1,42 @@ +<?php +/** + * ContentTranslation extension + * A tool that allows editors to translate articles from one language + * to another with the help of machine translation and other translation aids + * + * @file + * @ingroup Extensions + * @copyright 2014 ContentTranslation Team and others; see AUTHORS.txt + * @license GPL-2.0+; see LICENSE.txt + */ + +/** + * Version number used in extension credits and in other places where needed. + */ +define( 'CONTENTTRANSLATION_VERSION', '2014-01-08' ); + +/** + * Extension credits properties. + */ +$wgExtensionCredits['specialpage'][] = array( + 'path' => __FILE__, + 'name' => 'ContentTranslation', + 'version' => CONTENTTRANSLATION_VERSION, + 'author' => array( + 'Amir Aharoni', + 'David Chan', + 'Kartik Mistry', + 'Niklas Laxström', + 'Pau Giner', + 'Runa Bhattacharjee', + 'Santhosh Thottingal', + 'Siebrand Mazeland', + 'Sucheta Ghoshal', + ), + 'descriptionmsg' => 'ct-desc', + 'url' => 'https://www.mediawiki.org/wiki/Extension:ContentTranslation', +); + +require __DIR__ . '/Resources.php'; + +$wgMessagesDirs['ContentTranslation'] = __DIR__ . "/i18n/"; \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..019694a --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,342 @@ +== GNU GENERAL PUBLIC LICENSE == + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +=== Preamble === + +The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + +We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + +Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and +modification follow. + +== TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION == + +'''0.''' This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + +'''1.''' You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + +'''2.''' You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + '''a)''' You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + '''b)''' You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + '''c)''' If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +'''3.''' You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + '''a)''' Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + '''b)''' Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + '''c)''' Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + +'''4.''' You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + +'''5.''' You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +'''6.''' Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + +'''7.''' If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + +'''8.''' If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + +'''9.''' The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + +'''10.''' If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + +=== NO WARRANTY === + +'''11.''' BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + +'''12.''' IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + '''END OF TERMS AND CONDITIONS''' + +== How to Apply These Terms to Your New Programs == + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e8fa1a3 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# ContentTranslation + +The ContentTranslation is a tool that allows editors to translate +an article from one language to another with the help of machine +translation and other translation aids. + +For more details, see [Content translation][] +## Developing and installing + +For information on installing ContentTranslation on a local wiki, please +see https://www.mediawiki.org/wiki/Extension:ContentTranslation + +For information about running tests and contributing code to ContentTranslation, +see [CONTRIBUTING][]. Patch submissions are reviewed and managed with +[Gerrit][]. + +[Content translation]: http://www.mediawiki.org/wiki/Content_translation +[CONTRIBUTING]: CONTRIBUTING.md +[Gerrit]: https://www.mediawiki.org/wiki/Gerrit diff --git a/Resources.php b/Resources.php new file mode 100644 index 0000000..bdee580 --- /dev/null +++ b/Resources.php @@ -0,0 +1,12 @@ +<?php +/** + * JavaScript and CSS resource definitions. + * + * @file + * @license GPL-2.0+ + */ + +$resourcePaths = array( + 'localBasePath' => __DIR__, + 'remoteExtPath' => 'ContentTranslation/modules' +); \ No newline at end of file diff --git a/i18n/en.json b/i18n/en.json new file mode 100644 index 0000000..10fc49b --- /dev/null +++ b/i18n/en.json @@ -0,0 +1,9 @@ +{ + "@metadata": { + "authors": [ + "Santhosh.thottingal" + ] + }, + "ct": "ContentTranslation", + "ct-desc": "A tool that allows editors to translate articles from one language to another with the help of machine translation and other translation aids" +} \ No newline at end of file diff --git a/i18n/qqq.json b/i18n/qqq.json new file mode 100644 index 0000000..07942b8 --- /dev/null +++ b/i18n/qqq.json @@ -0,0 +1,9 @@ +{ + "@metadata": { + "authors": [ + "Santhosh.thottingal" + ] + }, + "ct": "ContentTranslation - The extension name", + "ct-desc": "{{desc|name=Translate|url=http://www.mediawiki.org/wiki/Extension:ContentTranslation}}"; +} \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/106186 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I47bd086c81a2e2a33172fdc005c67df2d7f406cc Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/ContentTranslation Gerrit-Branch: master Gerrit-Owner: Santhosh <santhosh.thottin...@gmail.com> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
