Skip to content

Commit

Permalink
Updates README
Browse files Browse the repository at this point in the history
Issue: documentacao-e-tarefas/scielo#701

Signed-off-by: Jhon <[email protected]>
  • Loading branch information
JhonathanLepidus committed Sep 26, 2024
1 parent 67d3079 commit e85f413
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# Dados Demográficos
# Demographic Data

This plugin allows the collection of demographic data from authors via a questionnaire.

## Compatibility

The latest release of this plugin is compatible with the following PKP applications:

* OJS 3.4.0

Using PHP 8.1 or later.

## Plugin Download

To download the plugin, go to the [Releases page](https://github.com/lepidus/demographicData/releases) and download the tar.gz package of the latest release compatible with your website.

## Installation

1. Install the plugin dependencies.
2. Enter the administration area of ​​your application and navigate to `Settings`>` Website`> `Plugins`> `Upload a new plugin`.
3. Under __Upload file__ select the file __demographicData.tar.gz__.
4. Click __Save__ and the plugin will be installed on your website.

## Instructions for use
Once enabled, the demographic questionnaire is displayed in the users profile page. When accessing this page, the user will find a new tab, called "Demographic Data", where they can consent to answer the questionnaire or not.

For authors who are not registered in the system, an e-mail is sent when the submission is accepted, requesting them to fill in the demographic questionnaire. This e-mail is only sent to authors where there is no user with the same e-mail address in the system.

The e-mail sent offers two ways of filling in the data. The first requires an ORCID record to be authenticated, so that the data is associated with this record. The second uses the author's e-mail address and is recommended only for those who do not have an ORCID record.

Authors can view and delete their demographic data at any time. Subsequently, if they create an account in the system with the e-mail address or ORCID used, their data will be migrated to this new user.

## License

__This plugin is licensed under the GNU General Public License v3.0__

__Copyright (c) 2024 Lepidus Tecnologia__

0 comments on commit e85f413

Please sign in to comment.