Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: gbif/ipt
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 0f2fd464d85f2b99a5927560363334542876c7d4
Choose a base ref
..
head repository: gbif/ipt
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: b6d1a9e6c0e23a047cf5eb4cf22be29a99631f2c
Choose a head ref
Showing 463 changed files with 36,684 additions and 9,802 deletions.
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
https://builds.gbif.org/job/ipt/lastBuild/console[image:https://builds.gbif.org/job/ipt/badge/icon[Build status]]
https://builds.gbif.org/job/ipt/lastBuild/console[image:https://builds.gbif.org/job/ipt3/badge/icon[Build status]]
https://crowdin.com/project/gbif-ipt[image:https://badges.crowdin.net/gbif-ipt/localized.svg[Crowdin]]

= GBIF Integrated Publishing Toolkit (IPT)
4 changes: 2 additions & 2 deletions docs/en/antora.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: ipt
title: Integrated Publishing Toolkit
version: 2.5
display_version: 2.5–2.7
version: "3.0"
display_version: "3.0-RC1"
start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/en/modules/ROOT/assets/images/ipt2/home/IPTHome.png
1 change: 0 additions & 1 deletion docs/en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -2,7 +2,6 @@
* xref:introduction.adoc[]
* xref:getting-started.adoc[]
** xref:requirements.adoc[]
** xref:data-hosting-centres.adoc[]
** xref:installation.adoc[]
*** xref:tomcat-installation-linux.adoc[]
*** xref:tomcat-installation-windows.adoc[]
57 changes: 52 additions & 5 deletions docs/en/modules/ROOT/pages/administration.adoc
Original file line number Diff line number Diff line change
@@ -12,6 +12,7 @@ This page allows a user having the Admin role to make and change settings for th
image::ipt2/administration/IPTAdminConfigIPT.png[]

* *IPT data directory* - This shows the directory on the server where all the IPT's configuration, resources and log files are stored.
* *Default language* - This shows the default IPT language. English by default.
* *IPT administrator email* - This is the email shown on the login page to users who have forgotten their password. If it is not set, the first administrator user's email is used.
* [[public-url]] *Public URL* - This is the URL that points to the root of this IPT installation. The URL is set automatically during the installation of the IPT. The Public URL must be accessible via the Internet in order for the IPT to function fully. Configuring the IPT Public URL to use localhost, for example, will not allow the instance of the IPT to be registered with GBIF, will not allow the IPT to be associated with an organization and will not allow the resources to be publicly accessible.
+
@@ -50,21 +51,53 @@ A new user can be created by clicking on the button labelled "Create" below the
image::ipt2/administration/IPTAdminUserCreateUser.png[]

* *Email* - The current email address of the user is used as an identifier to log in within the IPT and can not be changed.
* *Note*: If the user requires a change of email address, the recommended procedure is to create a new user account with the new email address, then delete the user account having the antiquated email address.
+
--
[NOTE]
====
If the user requires a change of email address, the recommended procedure is to create a new user account with the new email address, then delete the user account having the antiquated email address.
====

--
* *First name* - The first name of the user.
* *Last name* - The last name of the user.
* *Role* - The role the user will have with respect to this installation of the IPT. Admin users can make changes to all aspects of the instance of the IPT. Users having the role "Manager without registration rights" are able to create, edit, remove, and manage resources they have created or have been invited to manage within the IPT instance. Users having the role "Manager with registration rights" have the additional capability to register resources with the GBIF network. Other users can log in to the IPT and view resources, but cannot make any changes.
* *Password* - The password for the user must consist of at least four characters and should be made secure and safe from loss, as it is not recoverable from the IPT application.
* *Note*: If a user's password is lost, it can be reset to an automatically generated new value by a user having the Admin role. It is the responsibility of the Admin user to communicate this new password to the user for whom it was reset. The user can then change the password to the desired value by entering it in the IPT Account page accessible through the "Account" link in the header in the upper right corner of every page after logging in.
+
--
[NOTE]
====
If a user's password is lost, it can be reset to an automatically generated new value by a user having the Admin role. It is the responsibility of the Admin user to communicate this new password to the user for whom it was reset. The user can then change the password to the desired value by entering it in the IPT Account page accessible through the "Account" link in the header in the upper right corner of every page after logging in.
====

--
* *Verify password* - An exact copy of the password as entered in the Password text box to confirm that it was entered as intended.

After creation, an email with credential can be sent to the user:

image::ipt2/administration/IPTAdminUserCreateUserEmailCredentials.png[]

=== Modify an existing user
Information about users can be changed in the user details page after selecting the name of the user you wish to modify from the list of existing users. The user detail page shows all of the information about that user. The first name, last name, and role for the user can be changed by entering the new values and clicking on the button labelled "Save". Details of the information to be entered on this page can be found in the explanations in the "Create a new user" section, above.

image::ipt2/administration/IPTAdminUserEditUser.png[]

The Options dropdown contains to buttons:

* *Reset password* - If a user forgets a password, clicking on the button labelled "Reset Password" can generate a new one, after which a new password is given in an information message at the top of the page.
* *Note*: The IPT does not inform the affected user of this change, so it is the responsibility of the Admin who resets the password to inform the user of the new one.
* *Delete* - delete current user.
+
--
[NOTE]
====
The IPT does not inform the affected user of this change, so it is the responsibility of the Admin who resets the password to inform the user of the new one.
====

--

After password reset, an email with a new password can be sent to the user:

image::ipt2/administration/IPTAdminUserEmailResetPassword.png[]

=== Delete a user
Users accounts that are no longer necessary can be deleted using the user detail page accessed by selecting the name of the user you wish to delete from the list of existing users. On the bottom of the user detail page, click on the button labelled "Delete" to remove this user account. There are several conditions under which a user cannot be deleted:
@@ -109,11 +142,15 @@ Following are explanations of the specific information to select or enter:
=== Edit GBIF registration
After the IPT has been registered, this page allows a user to update the IPT registration information. The update will ensure the IPT and all its registered resources are in sync with the GBIF Registry. *Administrators should run an update each time the public URL of the IPT changes*. Administrators can also run an update in order to update the title, description, contact name, and contact email of the IPT instance. This page does not support changing the hosting organization. To do so, administrators must contact the GBIF Helpdesk (helpdesk@gbif.org) directly.

image::ipt2/administration/IPTAdminEditRegistration1.png[]
image::ipt2/administration/IPTAdminEditRegistration.png[]

Network view:

image::ipt2/administration/IPTAdminEditRegistrationNetwork.png[]

Edit organization's shared tokens view:

image::ipt2/administration/IPTAdminEditRegistration2.png[]
image::ipt2/administration/IPTAdminEditRegistrationTokens.png[]

== Configure Organizations
This page is unavailable until the IPT instance has been successfully registered in the GBIF Registry (see the information under the "Configure GBIF registration" heading of the "Administration Menu" section). Once registered, this page shows a list of organizations that can be associated with resources in this IPT instance. An IPT that hosts data for organizations other than the one to which it is associated must have the additional organizations configured before they can be used.
@@ -183,6 +220,16 @@ For any extension that has already been installed in the IPT, and is out-of-date

image::ipt2/administration/IPTAdminExtensionsUpdate.png[]

== Data Packages

This page allows a user having the Admin role to enable the instance of the IPT to import and share various pre-defined types of data from the GBIF Registry. Each type includes properties (fields) that support a specific purpose.

image::ipt2/administration/IPTAdminDataPackages.png[]

Details page:

image::ipt2/administration/IPTAdminDataPackagesDetail.png[]

== UI Management

The IPT logo and colour scheme can be managed from the UI Management page.
2 changes: 1 addition & 1 deletion docs/en/modules/ROOT/pages/applying-license.adoc
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

== Introduction

In accordance with the http://www.gbif.org/terms/licences[GBIF licensing policy], a dataset should be made available for use under CC0, CC-BY, or CC-BY-NC. GBIF's recommended best practice is to use the most recent version, which 4.0 for CC-BY and CC-BY-NC. This is in line with Creative Commons' recommendation that:
In accordance with the http://www.gbif.org/terms/licences[GBIF licensing policy], a dataset should be made available for use under CC0, CC-BY, or CC-BY-NC. GBIF's recommended best practice is to use the most recent version, which is 4.0 for CC-BY and CC-BY-NC. This is in line with Creative Commons' recommendation that:

[quote]
You should always use the latest version of the Creative Commons licenses in order to take advantage of the many improvements described on the https://wiki.creativecommons.org/wiki/License_Versions[license versions page]. In particular, 4.0 is meant to be better suited to international use, and use in many different contexts, including https://blog.creativecommons.org/2011/08/23/data-governance-our-idea-for-the-moore-foundation/[sharing data].
2 changes: 1 addition & 1 deletion docs/en/modules/ROOT/pages/checklist-data.adoc
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ Populate it and upload it to the IPT. Try to augment it with as many http://rs.t

=== Exemplar datasets

* Database of Vascular Plants of Canada (VASCAN): http://data.canadensys.net/ipt/archive.do?r=vascan[DwC-A] / http://data.canadensys.net/ipt/resource.do?r=vascan[IPT homepage]
* Database of Vascular Plants of Canada (VASCAN): https://doi.org/10.5886/zw3aqw[DOI] /http://data.canadensys.net/ipt/archive.do?r=vascan[DwC-A] / http://data.canadensys.net/ipt/resource.do?r=vascan[IPT homepage]

=== FAQ

12 changes: 4 additions & 8 deletions docs/en/modules/ROOT/pages/colophon.adoc
Original file line number Diff line number Diff line change
@@ -14,15 +14,15 @@ endif::[]

// English user manual citation
[quote]
Wieczorek J & Braak K ({localyear}) The GBIF Integrated Publishing Toolkit User Manual, version {page-component-version}. Copenhagen: GBIF Secretariat. https://ipt.gbif.org/manual/en/ipt/{page-component-version}/
Wieczorek J, Blissett M, Braak K & Podolskiy M ({localyear}) The GBIF Integrated Publishing Toolkit User Manual, version {page-component-version}. Copenhagen: GBIF Secretariat. https://ipt.gbif.org/manual/en/ipt/{page-component-version}/

// If not English
ifeval::["{language}" != "en"]
This TRANSLATORS_PUT_YOUR_LANGUAGE_HERE translation of the user manual is contributed by TRANSLATORS_CREDIT_YOURSELVES. The recommended citation for this translation into YOUR_LANGUAGE_HERE is as follows:

// Translated user manual citation
[quote]
Wieczorek J & Braak K ({localyear}) The GBIF Integrated Publishing Toolkit User Manual, version {page-component-version}. (TRANSLATORS_CREDIT_YOURSELVES, Trans.) Copenhagen: GBIF Secretariat. https://ipt.gbif.org/manual/{language}/ipt/{page-component-version}/
Wieczorek J, Blissett M, Braak K & Podolskiy M ({localyear}) The GBIF Integrated Publishing Toolkit User Manual, version {page-component-version}. (TRANSLATORS_CREDIT_YOURSELVES, Trans.) Copenhagen: GBIF Secretariat. https://ipt.gbif.org/manual/{language}/ipt/{page-component-version}/
// Endif
endif::[]

@@ -34,16 +34,12 @@ The GBIF Integrated Publishing Toolkit and this user manual are Copyright © 201

The GBIF Integrated Publishing Toolkit is open source software released under the Apache License Version 2.0. You may obtain a copy of this License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under this License is distributed on an "as is" basis, without warranties of conditions of any kind, either express or implied. See the License for the specific language governing rights and limitations under the License.

This user manual is released under the Creative Commons Attribution-Non-commercial-Share Alike 3.0 Unported License. You may obtain a copy of this license at http://creativecommons.org/licenses/by-nc-sa/3.0/. Though you should consult the actual license document for details, in general terms the license states that you are free to copy, distribute, transmit, remix and adapt the work, under the following conditions:

* you must cite the work in the manner specified on this page (but not in a way that suggests that GBIF or the GBIF Secretariat endorses you or your use of the work);
* you may not use this work for commercial purposes;
* if you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.
This user manual is released under the Creative Commons Attribution 4.0 International Licence. You may obtain a copy of this licence at https://creativecommons.org/licenses/by/4.0/.

== References

// GitHub and Google Code versions
Wieczorek J & Braak K (2016) The GBIF Integrated Publishing Toolkit User Manual, version 2.3.4. Copenhagen: GBIF Secretariat. https://github.com/gbif/ipt/wiki/IPTManualNotes.wiki
Wieczorek J & Braak K (2016) The GBIF Integrated Publishing Toolkit User Manual, version 2.3.6. Copenhagen: GBIF Secretariat. https://github.com/gbif/ipt/wiki/IPTUserManualv23.wiki

// https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/gbif-providertoolkit/GBIF_IPT_User_Manual_1.0.pdf
Réveillon A (2009) The GBIF Integrated Publishing Toolkit User Manual, version 1.0. Copenhagen: GBIF Secretariat. https://links.gbif.org/ipt_manual_1.0
Loading