commit ea5dbcb05ace52e6030d7d84389fb0c2929fbbf3 Author: D. Rimron-Soutter Date: Thu Nov 13 16:59:49 2025 +0000 Initial commit diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + 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 Lesser 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. + + GNU GENERAL PUBLIC LICENSE + 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. + + + Copyright (C) + + 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. + + , 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 Lesser General +Public License instead of this License. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..37712f9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,15 @@ +All the PHP, .css and .js are originally derived from +MediaWiki's vector theme, which is GPLv2: +http://gnu.org/licenses/gpl-2.0 + +Bootstrap is licensed under MIT License: +https://github.com/twbs/bootstrap/blob/master/LICENSE + +FontAwesome Code is licensed under MIT License: +http://opensource.org/licenses/mit-license.html + +FontAwesome Font is licensed under SIL OFL 1.1: +http://scripts.sil.org/OFL + +NextBestNetwork is GPLv2: +http://gnu.org/licenses/gpl-2.0 diff --git a/NextBestNetwork.i18n.magic.php b/NextBestNetwork.i18n.magic.php new file mode 100644 index 0000000..e3da87b --- /dev/null +++ b/NextBestNetwork.i18n.magic.php @@ -0,0 +1,32 @@ + array( 0, 'nextbestnetworkhide' ), + 'nextbestnetworknav' => array( 0, 'nextbestnetworknav' ), + 'nextbestnetworkhideexcept' => array( 0, 'nextbestnetworkhideexcept' ), + 'nextbestnetworkbodyclass' => array( 0, 'nextbestnetworkbodyclass' ), + 'nextbestnetworkrealname' => array( 0, 'nextbestnetworkrealname' ), + 'MAG_NUMBEREDHEADINGS' => array( 0, '__NUMBEREDHEADINGS__' ), +); diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc5aa8d --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# NextBestNetwork, a Bootstrap based skin for MediaWiki + +NextBestNetwork is a skin for **[MediaWiki](http://mediawiki.org/)** (1.35+) based on +**[Bootstrap](http://getbootstrap.com/)** (v4.6.2). It tries to implement as +much of Bootstrap's functionality as possible, allowing to use it very easily and with +very reduced markup, and features many configuration options. + +You can find an instance of NextBestNetwork in action and the extended documentation at the +project's website **[nextbestnetwork.kollabor.at](http://nextbestnetwork.kollabor.at/)** + + +## Get started + +1. Change to the "skins" subdirectory of your MediaWiki installation: + + ``` + cd skins + ``` + +2. Clone the repository: + + ``` + git clone https://github.com/thaider/NextBestNetwork NextBestNetwork + ``` + +3. Add the following to `LocalSettings.php`: + + ```php + wfLoadSkin( 'NextBestNetwork' ); + $wgDefaultSkin = "nextbestnetwork"; + ``` + +## Optional configuration + +Please refer to the project's website **[nextbestnetwork.kollabor.at](http://nextbestnetwork.kollabor.at/)** +for further information about configuration and customization options. + + +## Licensing, Copying, Usage + +NextBestNetwork is open source, and built on open source projects. + +Please check out the [LICENSE file](https://github.com/thaider/NextBestNetwork/blob/master/LICENSE) +for details. + +## Development + +Suggestions for improvements, ideally in the form of pull request, are always warmly welcome. + +In case you aren't able to implement some new feature that you would like to see in NextBestNetwork, +consider hiring one of these people: + +* Tobias Haider (NextBestNetwork's maintainer) +* ... + +If you're a developer and want to be put on this list, just drop me a note... diff --git a/i18n/en.json b/i18n/en.json new file mode 100644 index 0000000..bcde295 --- /dev/null +++ b/i18n/en.json @@ -0,0 +1,90 @@ +{ + "@metadata": { + "authors": [] + }, + "skinname-nextbestnetwork": "NextBestNetwork", + "nextbestnetwork-skin-desc": "A skin based on Bootstrap", + "userpage": "User Page", + "nextbestnetwork.css": "/* CSS placed here will affect users of the NextBestNetwork skin */", + "nextbestnetwork.js": "/* Any JavaScript here will be loaded for users using the NextBestNetwork skin */", + "nextbestnetwork-navbar-class": "navbar navbar-default navbar-fixed-top navbar-expand-lg fixed-top navbar-light bg-light", + "nextbestnetwork-navbar-brand": "{{SITENAME}}", + "nextbestnetwork-navbar-left": "FAQ", + "nextbestnetwork-navbar-left-wrapper": "li", + "nextbestnetwork-navbar-left-wrapperclass": "nav", + "nextbestnetwork-navbar-right": "TOOLBOX,PERSONAL,SEARCH", + "nextbestnetwork-navbar-right-wrapper": "li", + "nextbestnetwork-navbar-right-wrapperclass": "nav", + "nextbestnetwork-navbar-right-dropdownclass": "dropdown-menu-end", + "nextbestnetwork-subnav": "", + "nextbestnetwork-subnav-class": "navigation nav nav-pills pull-right justify-content-end", + "nextbestnetwork-subnav-wrapper": "li", + "nextbestnetwork-subnav-wrapperclass": "nav nav-item btn-group", + "nextbestnetwork-subnav-btnclass": "nav-link", + "nextbestnetwork-subnav-dropdownclass": "dropdown-menu-end", + "nextbestnetwork-sidebar-class": "sidebar-sticky", + "nextbestnetwork-sidebar-left": "", + "nextbestnetwork-sidebar-left-btnclass": "btn btn-primary", + "nextbestnetwork-sidebar-left-wrapperclass": "btn-group mb-1", + "nextbestnetwork-sidebar-right": "EDIT-EXT,TOC", + "nextbestnetwork-sidebar-right-btnclass": "btn btn-primary", + "nextbestnetwork-sidebar-right-wrapperclass": "btn-group mb-1", + "nextbestnetwork-sidebar-right-dropdownclass": "dropdown-menu-end", + "nextbestnetwork-footer": "FOOTER", + "nextbestnetwork-footer-custom": "LOGIN", + "nextbestnetwork-footer-class": "footer-sticky bg-light", + "nextbestnetwork-footer-btnclass": "", + "nextbestnetwork-footer-wrapperclass": "dropup", + "nextbestnetwork-footer-standard-btnclass": "", + "nextbestnetwork-footer-standard-wrapper": "li", + "nextbestnetwork-footer-standard-wrapperclass": "dropup", + "nextbestnetwork-toolbox": "", + "nextbestnetwork-login": "Login / Create Account", + "nextbestnetwork-container-class": "container-fluid", + "nextbestnetwork-editsection-text": "", + "nextbestnetwork-editsection-class": "tw-editsection-onhover", + "nextbestnetwork-editsection-icon": "", + "nextbestnetwork-toc-top": "to top", + "nextbestnetwork-personaltools-icon": "user", + "nextbestnetwork-personaltools-text": "$1", + "nextbestnetwork-edit": "Edit", + "nextbestnetwork-edit-icon": "pen", + "nextbestnetwork-edit-ext": "Edit $1", + "nextbestnetwork-edit-ext-nav": "", + "nextbestnetwork-edit-ext-icon": "pen", + "nextbestnetwork-namespace-talk-icon": "comments", + "nextbestnetwork-history-icon": "history", + "nextbestnetwork-no-entries": "no entries…", + "prefs-nextbestnetwork-advanced": "Advanced features", + "prefs-nextbestnetwork-advanced-desc": "Show advanced features", + "prefs-nextbestnetwork-advanced-help": "Some features that you might know from other MediaWiki installations have possibly been hidden by the administrator in order not to confuse the average user. Set this option to show them.", + "nextbestnetwork-config-hideall": "This variable can be used to hide elements from everybody. The {{#nextbestnetworkhide}} parser function will add to this array. Attention: Only hiding of elements that are also listed in $wgNextBestNetworkSkinHideable will actually be put into effect.", + "nextbestnetwork-config-hideable": "In order to prevent abuse, only elements listed in this array are allowed to be hidden by the {{#nextbestnetworkhide}} parser function. Add new elements with $wgNextBestNetworkSkinHideable[] = 'subnav';.", + "nextbestnetwork-config-hideanon": "Elements in this array will be hidden for users who are NOT logged in.", + "nextbestnetwork-config-hideloggedin": "Elements in this array will be hidden for users who ARE logged in.", + "nextbestnetwork-config-hidenonadvanced": "Elements in this array will only be shown to users who have chosen in their preferences to show “advanced features”.", + "nextbestnetwork-config-hideexcept": "Use this to hide an element for everybody except those belonging to any of the groups specified. Usage: $wgNextBestNetworkSkinHideExcept[ELEMENT] = [GROUPS];, e.g. $wgNextBestNetworkSkinHideExcept['sidebar-right'] = ['sysop']; to show the right sidebar only to sysops (i.e. administrators).", + "nextbestnetwork-config-footericons": "If set to false, the icons in the footer will be replaced by text aquivalents.", + "nextbestnetwork-config-pagerenderer": "Use this variable to change the default page layout. Replace the value with the name of a custom function - use NextBestNetworkTemplate::renderPage() in includes/NextBestNetworkTemplate.php as a template to build your own layout.", + "nextbestnetwork-config-navbarrenderer": "Use this variable to change the layout of the navbar. Replace the value with the name of a custom function - use NextBestNetworkTemplate::renderNavbar() in includes/NextBestNetworkTemplate.php as a template to build your own navbar layout.", + "nextbestnetwork-config-navigationalelements": "Add to this array to create customized buttons, the array's key is the keyword for the navigational element to be used in navbars, subnav, sidebar, or footer, the value is the name of a callback function. This function will be called with the skin object as argument and should return either an array of buttons or a string that can be parsed as buttons.", + "nextbestnetwork-config-specialelements": "Use this array to add completely arbitrary code into navbars, subnav, sidebar, or footer. The value again is a callback function you need to create. It will be called with two arguments, the skin object and the context as a string (navbar-left, navbar-right, subnav, sidebar, footer). The function should directly print the html you want to have.", + "nextbestnetwork-config-usebtnparser": "Whether or not to parse the -Tag.", + "nextbestnetwork-config-usescrollspy": "", + "nextbestnetwork-config-usetooltips": "Whether or not to use Bootstrap's tooltips for buttons using the data-bs-toggle=\"tooltip\" attribute.", + "nextbestnetwork-config-useiconwatch": "Watch and unwatch as an icon rather than a link.", + "nextbestnetwork-config-useexternallinkstyles": "", + "nextbestnetwork-config-customeditsectionlink": "Whether or not to use customized edit section links. If true you can specify an icon, the text and css classes for the edit links placed next to section headings.", + "nextbestnetwork-config-customcss": "Add Resource Modules to this array.", + "nextbestnetwork-config-customscriptmodule": "", + "nextbestnetwork-config-customstylemodule": "", + "nextbestnetwork-config-usecustomfiles": "", + "nextbestnetwork-config-imagepagetoctabs": "Set to true, if you want file pages to be rendered as togglable tabs.", + "nextbestnetwork-config-gridnone": "Offset and width for the main content if no sidebars are shown.", + "nextbestnetwork-config-gridleft": "Offsets and widths for the left sidebar and the main content.", + "nextbestnetwork-config-gridright": "Offsets and widths for the main content and the right sidebar.", + "nextbestnetwork-config-gridboth": "Offsets and widths for the left sidebar, the main content and the right sidebar.", + "nextbestnetwork-config-additionalbodyclasses": "Add your custom body classes. You can use the {{#nextbestnetworkbodyclasses}} parser function to add classes per page or via a template call. And you can also use the SkinNextBestNetworkAdditionalBodyClasses hook.", + "nextbestnetwork-config-userealnames": "When displaying links to user pages, use their real name if they provide one instead of the user name.", + "nextbestnetwork-config-userimageproperty": "Set this to the name of a semantic property linking to the page of a user's image" +} diff --git a/includes/Hooks.php b/includes/Hooks.php new file mode 100644 index 0000000..ac8609f --- /dev/null +++ b/includes/Hooks.php @@ -0,0 +1,1202 @@ +getSkin()->getSkinName() === 'nextbestnetwork'; + } + + + /** + * Expose NextBestNetworkSkinUseTooltips configuration variable + * + * @param array $vars + */ + public static function onResourceLoaderGetConfigVars( array &$vars ) { + $vars['wgNextBestNetworkSkinUseTooltips'] = $GLOBALS['wgNextBestNetworkSkinUseTooltips']; + } + + + /** + * Setting up parser functions + * + * @param Parser $parser Parser object being initialized + */ + public static function onParserFirstCallInit( Parser $parser ) { + $parser->setHook( 'TOC', 'NextBestNetworkHooks::TOC' ); + $parser->setHook( 'legend', 'NextBestNetworkHooks::legend' ); + $parser->setHook( 'footer', 'NextBestNetworkHooks::footer' ); + $parser->setHook( 'accordion', 'NextBestNetworkHooks::buildAccordion' ); + $parser->setHook( 'label', 'NextBestNetworkHooks::buildLabel' ); + + if ( $GLOBALS['wgNextBestNetworkSkinUseBtnParser'] === true ) { + $parser->setHook( 'btn', 'NextBestNetworkHooks::buildButtons' ); + } + + $parser->setFunctionHook( 'nextbestnetworkhide', 'NextBestNetworkHooks::setHiddenElements' ); + $parser->setFunctionHook( 'nextbestnetworknav', 'NextBestNetworkHooks::setCustomNavElement' ); + $parser->setFunctionHook( 'nextbestnetworkhideexcept', 'NextBestNetworkHooks::setHiddenElementsGroups' ); + $parser->setFunctionHook( 'nextbestnetworkbodyclass', 'NextBestNetworkHooks::addBodyclass' ); + $parser->setFunctionHook( 'nextbestnetworkrealname', 'NextBestNetworkHooks::renderRealname' ); + } + + + /** + * Adding modules + * + * @param OutputPage $out The OutputPage object. + * @param Skin $skin Skin object that will be used to generate the page + */ + public static function onBeforePageDisplay( OutputPage $out, Skin $skin ) { + if( $skin->getSkinName() == 'nextbestnetwork' ) { + $config = \MediaWiki\MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'nextbestnetwork' ); + + $styles = []; + + // load mediawiki styles + $styles[] = 'skins.nextbestnetwork.mediawiki.styles'; + + // load font awesome + $styles[] = 'skins.nextbestnetwork.awesome.styles'; + + // load externally defined style module + if( $config->get( 'NextBestNetworkSkinCustomStyleModule' ) ) { + $styles[] = $config->get( 'NextBestNetworkSkinCustomStyleModule' ); + + // or: load modules defined by nextbestnetwork + } else { + if( !$config->get( 'NextBestNetworkSkinUseCustomFiles' ) ) { + $styles[] = 'skins.nextbestnetwork.styles'; + } else { + $styles[] = 'skins.nextbestnetwork.custom.styles'; + } + } + + // load external link styles + if( $config->get( 'NextBestNetworkSkinUseExternallinkStyles' ) ) { + $styles[] = 'skins.nextbestnetwork.externallinks.styles'; + } + + // load additional modules + foreach( $GLOBALS['wgNextBestNetworkSkinCustomCSS'] as $customstyle ) { + $styles[] = $customstyle; + } + + $hookContainer = MediaWikiServices::getInstance()->getHookContainer(); + $hookContainer->run( 'SkinNextBestNetworkStyleModules', [ $skin, &$styles ] ); + + $out->addModuleStyles( $styles ); + } + } + + + /** + * GetPreferences hook + * + * Adds NextBestNetwork-releated items to the preferences + * + * @param User $user User whose preferences are being modified + * @param array $preferences Preferences description array, to be fed to an HTMLForm object + */ + public static function onGetPreferences( User $user, array &$preferences ) { + $preferences['nextbestnetwork-advanced'] = [ + 'type' => 'toggle', + 'label-message' => 'prefs-nextbestnetwork-advanced-desc', + 'section' => 'rendering/nextbestnetwork-advanced', + 'help-message' => 'prefs-nextbestnetwork-advanced-help' + ]; + } + + + /** + * Pages could be hidden for anonymous users or only be shown for specific groups + * so we put a user's group memberships into the page rendering hash + * + * @param string $confstr Reference to a hash key string which can be modified + * @param User $user User object that is requesting the page + * @param array $options Array of options used to generate the $confstr hash key + */ + static function onPageRenderingHash( &$confstr, User $user, array &$options ) { + $userGroupManager = MediaWikiServices::getInstance()->getUserGroupManager(); + $groups = $userGroupManager->getUserEffectiveGroups($user); + sort( $groups ); + $confstr .= "!groups=" . join(',', $groups ); + } + + + /** + * Add body classes + * + * @param OutputPage $out The OutputPage which called the hook, can be used to get the real title + * @param Skin $sk The Skin that called OutputPage::headElement + * @param array $bodyAttrs An array of attributes for the body tag passed to Html::openElement + */ + static function onOutputPageBodyAttributes( OutputPage $out, Skin $sk, array &$bodyAttrs ) { + if( $sk->getSkinName() == 'nextbestnetwork' ) { + $additionalBodyClasses = [ 'nextbestnetwork-animateLayout' ]; + + $user = $out->getUser(); + $userAdvanced = MediaWikiServices::getInstance()->getUserOptionsLookup()->getOption( $user, 'nextbestnetwork-advanced' ); + $additionalBodyClasses[] = $userAdvanced ? 'nextbestnetwork-advanced' : 'nextbestnetwork-non-advanced'; + $additionalBodyClasses[] = $user->isRegistered() ? 'nextbestnetwork-user-logged-in' : 'nextbestnetwork-user-anon'; + + $additionalBodyClasses = array_merge( $additionalBodyClasses, $GLOBALS['wgNextBestNetworkSkinAdditionalBodyClasses'] ); + + $hookContainer = MediaWikiServices::getInstance()->getHookContainer(); + $hookContainer->run( 'SkinNextBestNetworkAdditionalBodyClasses', [ $sk, &$additionalBodyClasses ] ); + + if( count( $additionalBodyClasses ) > 0 ) { + $bodyAttrs['class'] = $bodyAttrs['class'] . ' ' . preg_replace( "/[^a-zA-Z0-9_\s-]/", "", implode( " ", $additionalBodyClasses ) ); + } + } + } + + + /** + * Use real names instead of user names + * + * @param LinkRenderer $linkRenderer the LinkRenderer object + * @param LinkTarget $target the LinkTarget that the link is pointing to + * @param boolean $isKnown boolean indicating whether the page is known or not + * @param string|HtmlArmor $text the contents that the tag should have; either a plain, unescaped string or a HtmlArmor object. + * @param array $attribs the final HTML attributes of the tag, after processing, in associative array form. + * @param string $ret the value to return if your hook returns false. + */ + public static function onHtmlPageLinkRendererEnd( LinkRenderer $linkRenderer, LinkTarget $target, $isKnown, &$text, array &$attribs, &$ret ) { + if( $GLOBALS['wgNextBestNetworkSkinUseRealnames'] == true && $target->getNamespace() === 2 ) { + $userkey = $target->getDBKey(); + + // use real name if link text hadn't been set explicitly to be different from the page name + $title = Title::newFromText( HtmlArmor::getHtml( $text ) ); + if( + $title && + ( + $title->getPrefixedText() == $target->getPrefixedText() + || $title->getText() == $target->getText() + ) + ) { + $text = self::getRealname( $userkey ); + } + } + } + + + /** + * Use real names instead of user names in selflinks + * + * @param Title $nt the title object of the page + * @param string $html Link text + * @param string $trail Text after link + * @param string $prefix Text before link + * @param string $ret Self link text to be used if the hook returns false + */ + public static function onSelfLinkBegin( Title $nt, &$html, &$trail, &$prefix, &$ret ) { + if( $GLOBALS['wgNextBestNetworkSkinUseRealnames'] == true && $nt->getNamespace() === 2 ) { + $userkey = $nt->getDBKey(); + + // use real name if link text hadn't been set explicitly to be different from the page name + $title = Title::newFromText( HtmlArmor::getHtml( $html ) ); + if( + $title && + ( + $title->getPrefixedText() == $nt->getPrefixedText() + || $title->getText() == $nt->getText() + ) + ) { + $html = self::getRealname( $userkey ); + } + } + } + + + /** + * Customize edit section links + * + * @param Skin $skin Skin object rendering the UI + * @param Title $title Title object for the title being linked to + * @param string $section The designation of the section being pointed to, to be included in the link + * @param string $tooltip The default tooltip. + * @param array $links Array containing all link detail arrays. + * @param string $lang The language code to use for the link in the wfMessage function + * + * @todo: make this work with VisualEditor + */ + static function onSkinEditSectionLinks( Skin $skin, Title $title, $section, $tooltip, array &$links, $lang = false ) { + if( + $skin->getSkinName() == 'nextbestnetwork' + && $GLOBALS['wgNextBestNetworkSkinCustomEditSectionLink'] == true + ) { + if ( version_compare( MW_VERSION, '1.40', '<' ) ) { + $icon = wfMessage( 'nextbestnetwork-editsection-icon' )->inLanguage( $lang )->parse(); + $text = wfMessage( 'nextbestnetwork-editsection-text' )->inLanguage( $lang )->parse(); + $class = wfMessage( 'nextbestnetwork-editsection-class' )->inLanguage( $lang )->parse(); + $text = new HtmlArmor( $icon . ( ( $icon != '' ) ? ' ' : '' ) . $text ); + $links['editsection']['text'] = $text; + $links['editsection']['attribs']['class'] = $class; + } else { + $links['editsection']['link-html'] = wfMessage( 'nextbestnetwork-editsection-icon' )->inLanguage( $lang )->parse(); + $links['editsection']['text'] = wfMessage( 'nextbestnetwork-editsection-text' )->inLanguage( $lang )->parse(); + $links['editsection']['attribs']['class'] = wfMessage( 'nextbestnetwork-editsection-class' )->inLanguage( $lang )->parse(); + } + } + + return false; + } + + + /** + * Change TOC and page content of file pages to togglable tabs + * + * @param OutputPage $outputPage + */ + public static function onAfterFinalPageOutput( OutputPage $outputPage ) { + if( + $outputPage->getSkin()->getSkinName() == 'nextbestnetwork' + && $outputPage->getTitle()->getNamespace() == 6 + && $GLOBALS['wgNextBestNetworkSkinImagePageTOCTabs'] == true + ) { + $out = ob_get_clean(); + $out = str_replace( '
    ', ''; + } + echo ' +
    +
    '; + + echo $skin->makeSearchInput( [ + 'id' => 'searchInput', + 'class' => 'search-query form-control', + 'placeholder' => $skin->getMsg( 'search' )->text() + ] ); + + echo $skin->makeSearchButton( 'go', [ + 'id' => 'mw-searchButton', + 'class' => 'searchButton btn d-none' + ] ); + + echo ' +
    +
    '; + if( $context == 'navbar-left' ) { + echo '