Skip to content

Commit

Permalink
Updated Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Jefferson49 committed Nov 16, 2023
1 parent d6cd22d commit e86e255
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 11 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ This README file contains the following main sections:What](
* [Show additional repository information in source citations](#show-additional-repository-information-in-source-citations)
* [Directly show media objects of source citations in individual facts](#directly-show-media-objects-of-source-citations-in-individual-facts)
* [Additionally show media objects of sources in individual and family facts](#additionally-show-media-objects-of-sources-in-individual-and-family-facts)
* [Show further facts of sources within source citations](#show-further-facts-of-sources-within-source-citations)
* [Copy-Paste mechanism for source citations in the individual and family view](#copy-paste-mechanism-for-source-citations-in-the-individual-and-family-view)
* [Show all images of media objects](#show-all-images-of-media-objects)
* [Preferences](#preferences)
Expand Down Expand Up @@ -372,7 +373,7 @@ Within webtrees, the Repository Hierarchy module can provide links to the relate
![Screenshot](resources/img/screenshot_AtoM_link_in_webtrees.jpg)

### Show additional repository information in source citations
The Repository Hierarchy modules provides a feature to show extended information within source citations. If one of the following GEDCOM tags is available and contains content, it is shown in the user interface:
The Repository Hierarchy module provides a feature to show extended information about repositories within source citations. If one of the following GEDCOM tags is available and contains content, it is shown in the user interface:
+ REPO (name of repository)
+ REPO:CALN (call number of the source in the repository)

Expand All @@ -385,7 +386,7 @@ Note: An additional setting exists to define whether repositories are automatica
Note:Additionally, it is possible to show links to AtoM (as an external archive management system) within the source citations. The details are described in the related [chapter](#create-links-between-webtrees-and-an-external-archive-management-system).

### Directly show media objects of source citations in individual and family facts
The Repository Hierarchy modules provides a feature to directly show media objects of source citations in individual and family facts (and not subordinated in the source citation).
The Repository Hierarchy module provides a feature to directly show media objects of source citations in individual and family facts (and not subordinated in the source citation).

**Screenshot of individual fact with directly shown media objects:**
![Screenshot](resources/img/screenshot_media_objects_directly_in_facts.jpg)
Expand All @@ -396,7 +397,7 @@ The Repository Hierarchy modules provides a feature to directly show media objec
In order to activate this feature, the setting "Directly show media objects of sources in facts and not subordinated within source citations" needs to be selected in the control panel.

### Additionally show media objects of sources in individual and family facts
The Repository Hierarchy modules provides a feature to show media objects of sources in individual and family facts. The media objects are shown in a division "Media objects of source" below the source. The division is collapsed by default and can be un-collapsed with a mouse click.
The Repository Hierarchy module provides a feature to show media objects of sources in individual and family facts. The media objects are shown in a division "Media objects of source" below the source. The division is collapsed by default and can be un-collapsed with a mouse click.

Please note that media objects of source citations have to be differentiated from media objects of sources. This chapter addresses media objects of **sources**. In the chapters above, Repository Hierarchy also offers features, which address media objects of **sources citations**.

Expand All @@ -405,6 +406,19 @@ Please note that media objects of source citations have to be differentiated fro

In order to activate this feature, the setting "Show all media objects of sources within a source citations" needs to be selected in the control panel.

### Show further facts of sources within source citations

The Repository Hierarchy module provides a feature to show further facts of sources (e.g. publication, notes, reference numbers, i.e. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) within source citations, since the standard webtrees installation only shows the title of a source with a link.

Additional notes:
+ Repository facts and media objects can be selected by separate settings; please refer to the related chapters.
+ The following facts are currently not show: SOUR:DATA, SOUR:CHAN

**Screenshot: Show further source facts within source citations**
![Screenshot](resources/img/show_further_source_facts_within_citation.jpg)

In order to activate this feature, the setting "Show further facts of sources (e.g. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) within source citations" needs to be selected in the control panel.

### Copy-Paste mechanism for source citations in the individual and family view
The Repository Hierarchy module provides a feature to copy/paste source citations. If this feature is activated in the module settings, a copy icon is shown on the right hand side of each source citation. By clicking on the icon, the source citation can be copied to an internal clipboard. If a source citation is available in the clipboard, a source icon is shown in the edit area of all facts/events, which allow to use source citations. By clicking on the source icon, the source citation can be copied from the clipboard to the fact/event.

Expand Down Expand Up @@ -447,6 +461,7 @@ The following preferences can be activated/deactivated by administrators in the
+ Show additional source facts (REPO, REPO:CALN) within source citations.
+ Automatically expand repositories in source citations. Applies only if "Show additional source facts" is activated.
+ Show all media objects of sources within a source citations.
+ Show further facts of sources (e.g. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) within source citations.
+ Directly show media objects of sources in facts and not sub-ordinated within source citations.
+ Enable copy/paste mechanism for source citations in the individual and family view.

Expand Down
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/lang/de.mo
Binary file not shown.
15 changes: 8 additions & 7 deletions resources/lang/de.po
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
msgid ""
msgstr ""
"Project-Id-Version: Repository Hierarchy\n"
"POT-Creation-Date: 2023-11-15 07:36+0100\n"
"POT-Creation-Date: 2023-11-16 06:45+0100\n"
"PO-Revision-Date: \n"
"Last-Translator: \n"
"Language-Team: \n"
Expand Down Expand Up @@ -537,13 +537,14 @@ msgid "Show all media objects of sources within a source citations."
msgstr "Alle Medienobjekte von Quellen innerhalb von Quellen-Zitaten anzeigen."

msgid ""
"Show further facts of sources (e.g. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) "
"within source citations. Note: Repository facts and media objects can be "
"selected by separate settings."
"Show further facts of sources (e.g. publication, notes, reference numbers, i."
"e. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) within source citations. Note: "
"Repository facts and media objects can be selected by separate settings."
msgstr ""
"Weitere Tatsachen von Quellen (e.g. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) "
"innerhalb von Quellen-Zitaten anzeigen. Hinweis: Tatsachen zu Archiven sowie "
"Medienobjekte können über separate Einstellungen ausgewählt werden."
"Weitere Tatsachen von Quellen (Veröffentlichung, Notizen, Referenznummer, d."
"h. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) innerhalb von Quellen-Zitaten "
"anzeigen. Hinweis: Tatsachen zu Archiven sowie Medienobjekte können über "
"separate Einstellungen ausgewählt werden."

msgid ""
"Directly show media objects of sources in facts and not subordinated within "
Expand Down
2 changes: 1 addition & 1 deletion resources/views/settings.phtml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ use Fisharebest\Webtrees\View;
<?= view('components/checkbox', ['label' => I18N::translate('Show all media objects of sources within a source citations.'), 'name' => RepositoryHierarchy::PREF_SHOW_SOURCE_MEDIA_IN_CITATIONS, 'checked' => $show_source_media_in_citations]) ?>
</div>
<div class="row">
<?= view('components/checkbox', ['label' => I18N::translate('Show further facts of sources (e.g. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) within source citations. Note: Repository facts and media objects can be selected by separate settings.'), 'name' => RepositoryHierarchy::PREF_SHOW_FURTHER_FACTS_IN_CITATIONS, 'checked' => $show_further_facts_in_citations]) ?>
<?= view('components/checkbox', ['label' => I18N::translate('Show further facts of sources (e.g. publication, notes, reference numbers, i.e. SOUR:PUBL, SOUR:NOTE, SOUR:REFN, ...) within source citations. Note: Repository facts and media objects can be selected by separate settings.'), 'name' => RepositoryHierarchy::PREF_SHOW_FURTHER_FACTS_IN_CITATIONS, 'checked' => $show_further_facts_in_citations]) ?>
</div> <div class="row">
<?= view('components/checkbox', ['label' => I18N::translate('Directly show media objects of sources in facts and not subordinated within source citations.'), 'name' => RepositoryHierarchy::PREF_SHOW_MEDIA_AFTER_CITATIONS, 'checked' => $show_media_after_citations]) ?>
</div>
Expand Down

0 comments on commit e86e255

Please sign in to comment.