xref: /webtrees/app/Module/CkeditorModule.php (revision 5206405d15dd895c306e1f66583e11d1691e57fa)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\I18N;
21
22/**
23 * Class CkeditorModule
24 */
25class CkeditorModule extends AbstractModule
26{
27    // Location of our installation of CK editor.
28    public const CKEDITOR_PATH = 'public/ckeditor-4.11.2-custom/';
29
30    /**
31     * How should this module be labelled on tabs, menus, etc.?
32     *
33     * @return string
34     */
35    public function title(): string
36    {
37        /* I18N: Name of a module. CKEditor is a trademark. Do not translate it? http://ckeditor.com */
38        return I18N::translate('CKEditor™');
39    }
40
41    /**
42     * A sentence describing what this module does.
43     *
44     * @return string
45     */
46    public function description(): string
47    {
48        /* I18N: Description of the “CKEditor” module. WYSIWYG = “what you see is what you get” */
49        return I18N::translate('Allow other modules to edit text using a “WYSIWYG” editor, instead of using HTML codes.');
50    }
51}
52