Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hartenthaler committed Jan 5, 2023
1 parent 3c567a0 commit 8676cfb
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 17 deletions.
21 changes: 9 additions & 12 deletions ImprintFooterModule.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,18 @@
/*
* tbd for next release
* ==============================================================
* Fehlermeldung: Der Parameter "tree" fehlt, wenn die verantwortliche Person leer ist
* Formatierung: Name und Adresse oben auf einer Linie
* alle Übersetzungen aktualisieren (u.a. "Adreßzusatz")
* Test der Übersetzung "other" = "divers"
* Test ohne einen sichtbaren Baum
* Test der Initialisierung bei Erstverwendung mit erstem Admin (Name und E-Mail)
* Test: alle Kombinationen von: Adreßzusatz = leer und Straße = leer und Ort = leer
* README.md: Screenshot des erzeugten Impressums
* README.md: Aktualisierung des Screenshots des Verwaltungsmenüs
*
* tbd later on
* ==============================================================
* alle offenen issues aus GitHub
* Validierung der Base_URL
* Fehlermeldung: Der Parameter "tree" fehlt, wenn die verantwortliche Person leer ist
* Vorbelegung der verantwortlichen Person aus den Angaben für den ersten Website-Administrator (Vor-, Nachname, E-Mail)
* Formatierung: Name und Adresse oben auf einer Linie
* Test der Initialisierung bei Erstverwendung mit erstem Admin (Name und E-Mail)
* Validierung der Base_URL aktivieren
* Warum is require_once nötig?
* E-Mail-Funktion: check if there is one @ inside emailAddress and no blanks; if address is not correct: use it as simple eMail
* Dokumentation in Deutsch für webtrees-Handbuch fertigstellen und README anpassen (Rückportierung)
Expand All @@ -64,7 +62,6 @@
use Fisharebest\Webtrees\Module\PrivacyPolicy;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Services\UserService;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Validator;
use Fisharebest\Webtrees\View;
use Psr\Http\Message\ResponseInterface;
Expand Down Expand Up @@ -372,8 +369,8 @@ public function getPageAction(ServerRequestInterface $request): ResponseInterfac

return $this->viewResponse($this->name() . '::page', [
'title' => $this->title(),
'tree' => Validator::attributes($request)->tree(),
//'tree' => Validator::attributes($request)->treeOptional(),
//'tree' => Validator::attributes($request)->tree(),
'tree' => Validator::attributes($request)->treeOptional(),
'imprintHead1' => I18N::translate('Responsible person'),
'imprintHead2' => I18N::translate('This website is operated by:'),
'responsibleName' => $this->responsibleName(),
Expand Down Expand Up @@ -644,14 +641,14 @@ private function getHostName(ServerRequestInterface $request): string
* @source https://gravatar.com/site/implement/images/php/
*/
private function getGravatar( string $email, string $s = '80', string $d = 'mp', string $r = 'g',
bool $img = true, array $atts = array() ) : string
bool $img = true, array $attributes = array() ) : string
{
$url = 'https://www.gravatar.com/avatar/';
$url .= md5( strtolower( trim( $email ) ) );
$url .= "?s=$s&d=$d&r=$r";
if ( $img ) {
$url = '<img src="' . $url . '"';
foreach ( $atts as $key => $val )
foreach ( $attributes as $key => $val )
$url .= ' ' . $key . '="' . $val . '"';
$url .= ' />';
}
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ The webtrees admin can choose if the following additional parts should be shown
<a name="screenshots"></a>
## Screenshots

Screenshot of control panel page
Screenshot of imprint (in German language)
<p align="center"><img src="resources/docs/imprint.png" alt="Screenshot of imprint" align="center" width="100%"></p>

Screenshot of control panel page (in German language)
<p align="center"><img src="resources/docs/imprint_control_panel.png" alt="Screenshot of control panel menu" align="center" width="80%"></p>

<a name="webtrees"></a>
Expand Down Expand Up @@ -85,7 +88,8 @@ This section documents installation instructions for this module.
4. Rename the folder to `hh_imprint`
5. Login to **webtrees** as administrator, go to <span class="pointer">Control Panel/Modules/Website/Footers</span>, and find the module. It will be called "Imprint". Check if it has a tick for "Enabled".
6. Click at the wrench symbol and add all desired information fields
7. Finally, click SAVE, to complete the installation.
7. Maybe you like to deactivate the module "contact information" (depending whether you have activated this in the imprint module).
8. Finally, click SAVE, to complete the installation.

<a name="upgrade"></a>
## Upgrade
Expand Down
Binary file added resources/docs/imprint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified resources/docs/imprint_control_panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion resources/lang/de.po
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ msgstr[0] "Der Website-Verwalter ist für die Benutzerverwaltung zuständig und
msgstr[1] "Die Website-Verwalter sind für die Benutzerverwaltung zuständig und definieren die Einstellungen für diese Website."

#: resources/views/settings.phtml:77
msgid "other"
msgid "other sex"
msgstr "divers"

#: resources/views/settings.phtml:215
Expand Down
Binary file modified resources/lang/nl.mo
Binary file not shown.
2 changes: 1 addition & 1 deletion resources/lang/nl.po
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ msgid "female"
msgstr "vrouw"

#: resources/views/settings.phtml:77
msgid "other"
msgid "other sex"
msgstr "overig"

#: resources/views/settings.phtml:87
Expand Down
2 changes: 1 addition & 1 deletion resources/views/settings.phtml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ use Fisharebest\Webtrees\Http\RequestHandlers\ControlPanel;
'options' => [
'M' => I18N::translate('male'),
'F' => I18N::translate('female'),
'X' => I18N::translate('other'),
'X' => I18N::translate('other sex'),
],
'selected' => $responsibleSex,
]) ?>
Expand Down

0 comments on commit 8676cfb

Please sign in to comment.