diff --git a/dmp-backend/web/src/main/java/eu/eudat/controllers/UserGuideController.java b/dmp-backend/web/src/main/java/eu/eudat/controllers/UserGuideController.java index 6cb588eef..b7b07e474 100644 --- a/dmp-backend/web/src/main/java/eu/eudat/controllers/UserGuideController.java +++ b/dmp-backend/web/src/main/java/eu/eudat/controllers/UserGuideController.java @@ -50,13 +50,12 @@ public class UserGuideController { } InputStream is = new FileInputStream(fileName); - String[] filepath = fileName.split("\\.")[0].split("\\\\"); - String simplename = filepath[filepath.length - 1]; + Path path = Paths.get(fileName); HttpHeaders responseHeaders = new HttpHeaders(); responseHeaders.setContentLength(is.available()); responseHeaders.setContentType(MediaType.TEXT_HTML); - responseHeaders.set("Content-Disposition", "attachment;filename=" + simplename); + responseHeaders.set("Content-Disposition", "attachment;filename=" + path.getFileName().toString()); responseHeaders.set("Access-Control-Expose-Headers", "Content-Disposition"); responseHeaders.get("Access-Control-Expose-Headers").add("Content-Type"); @@ -71,7 +70,7 @@ public class UserGuideController { @RequestMapping(value = "current", method = RequestMethod.POST) public @ResponseBody ResponseEntity> updateGuide(@RequestBody UserGuide guide, @ClaimedAuthorities(claims = {ADMIN}) Principal principal) throws Exception { - String fileName = this.environment.getProperty("userguide.path") + guide.getName() + ".html"; + String fileName = this.environment.getProperty("userguide.path") + guide.getName(); OutputStream os = new FileOutputStream(fileName); os.write(guide.getHtml().getBytes()); os.close(); diff --git a/user-guide/UserGuide_pt.html b/user-guide/UserGuide_pt.html new file mode 100644 index 000000000..f9c00ecc7 --- /dev/null +++ b/user-guide/UserGuide_pt.html @@ -0,0 +1,2525 @@ + + + + + + + + + + + + + + + +
+
+
+ +
+
+
+
+

 

+
+
    +
  1. +

    Entities & Terminology

    +
    2. +
      +
    1. +

      Key entities

      +
      2. +

       

      +

      Data Management Plan (DMP) is a collection of dataset descriptions, associated with an activity (“project” or “grant”). A DMP may be versioned, is exportable to various forms, currently machine readable (xml, json) and human readable (pdf/openxml) and can be assigned a DOI and published in Zenodo.

      +

       

      +

      Dataset in Argos describes data according to a set of rules that is the dataset template.

      +

       

      +

      Dataset Template is the set of rules that describe what Datasets contain and how they are handled. Dataset Templates are modified by Admins and contain attributes/fields, behavioral rules (e.g. toggling visibility of fields) and validation rules. Dataset Templates are linked to DMPs so that users are provided with specific formats of descriptions.

      +

       

      +

      Project is a logical entity that defines the context where one or more Data Management Plans may be formed in.

      +

       

      +

      Grant is a logical entity that defines the context where one or more Data Management Plans may be formed in.

      +

       

      +

      Users are associated to DMPs and other entities (e.g. Datasets, Organizations) for authorization and may map to researchers.

      +

       

      +

      Import - Import function supports upload of .json files that are produced according to RDA specifications for machine-actionable DMPs

      +

       

      +

      +

       

      +

      + + + + + + +
      +

      Start New DMP is an easy way to start writing a DMP. It provides an editor that goes through the essential elements of a DMP and guides the process of its creation step by step.

      +

       

      +

      From “Homepage”

      +

      +

       

      +

      From Dashboard

      +

      +

      or

      +

      +

       

      +

      From “Add Dataset”

      +

      +
      +

       

      +

       

      +

      + + + + + + +
      +

      Add Dataset is an easy way to add new datasets to pre-existing DMPs.

      +

       

      +

      From Dashboard

      +

      +

       

      +

      From “My Datasets”

      +

      +

       

      +

      From “My DMPs”

      +

      +

       

      +

      From Dataset Editor

      +

      +
      +

       

      +
    2. +

      Secondary entities

      +
      3. +

       

      +

      Repository  - an electronic database or an information system where data are stored and maintained

      +

       

      +

      Data set - a collection of data which are bind together under a specific format

      +

       

      +

      Registry - a database of entities and descriptions

      +

       

      +

      Service - a software of specific operations and tasks that interacts with other software and hardware

      +

       

      +

      Researcher - an individual practicing research

      +

       

      +

      Funding organization - an organisation that funds research programmes and/ or researchers’ activities

      +

       

      +
    +
  2. +

    Navigation

    +
    3. +
      +
    1. +

      Homepage

      +
      2. +

       

      +

      The homepage can be found under argos.openaire.eu, also accessible from  the OpenAIRE Service catalogue and the EOSC.

      +

       

      +

      +

       

      +

      About - informs about the scope and main functions of the tool (How it works, ROADMAP, FAQs, Contributors)

      +

       

      +

      Resources - provides useful information about using Argos and includes dissemination material (Media Kit, User Guide, Co-branding)

      +

       

      +

      Contact - a contact form that facilitates communication with Argos team

      +

       

      +

      Sign in - enters the tool as a user

      +
    2. +

      Login

      +
      3. +

       

      +

      Different login options are available to choose from social media to research and scholarly communication channels.

      +

      +

       

      +

      Note! No user account is required.

      +

       

      +
    3. +

      User Account Menu

      +
      4. +

       

      +

      A dedicated, customisable space of the user’s personal profile.

      +

       

      +

      + + + + + + + +
      +

      +       		+

      My profile settings -  displays the profile page which contains details such as name, email, zenodo account details etc.

      +

       

      +

      Associated DMPs - a collection of users’ DMPs

      +

       

      +

      Log out - terminates the session, and redirects to the login page.

      +
      +

       

      +

       

      +
    4. +

      Main Menu

      +
      5. +

       

      +

      The main menu is located on the left side of the screen. Depending on how users view the tool, i.e. whether they have logged in or not, the main menu changes to include features that are available only in individuals’ dashboards.

      +

       

      +

      + + + + + + + +
      +

      Main menu - not logged in

      +

       

      +

      +

       

      +

      Home  - gets you back to the homepage / dashboard

      +

       

      +

      Public DMPs - a collection of DMPs publicly available in Argos

      +

       

      +

      Public Datasets - a collection of Datasets publicly available in Argos

      +

       

      +

      Co-Branding - a page to view the software and learn how to contribute

      +

       

      +

      Support - a contact form that facilitates communication with Argos team

      +

       

      +

      Send feedback - a feedback form to contribute thoughts and opinions about using Argos

      +

       

      +

      About - informs about the scope and main functions of the tool

      +

       

      +

      Terms of Service - provides the legal status for using of ARGOS

      +

       

      +

      Glossary - includes the terminology used in the tool and explains basic components

      +

       

      +

      User Guide - a guide for users to learn how to use Argos

      +

       

      +       		+

      Main menu - logged in

      +

       

      +

      +

       

      +

      Home  - gets you back to the homepage / dashboard

      +

       

      +

      My DMPs - includes all DMPs which the user is either the owner or the collaborator of

      +

       

      +

      My Datasets - includes all Datasets which the user is either the owner or the collaborator of

      +

       

      +

      Public DMPs - a collection of DMPs publicly available in Argos

      +

       

      +

      Public Datasets - a collection of Datasets publicly available in Argos

      +

       

      +

      About - informs about the scope and main functions of the tool

      +

       

      +

      Terms of Service - provides the legal status for using of ARGOS

      +

       

      +

      Glossary - includes the terminology used in the tool and explains basic components

      +

       

      +

      User Guide - a guide for users to learn how to use Argos

      +

       

      +

      Contact support - a contact form that facilitates communication with Argos team

      +

       

      +
      +
    5. +

      Dashboard

      +
      6. +

       

      +

      Dashboard is the console that appears after entering Argos from the Homepage and includes condensed information based on Argos function and their use.

      +

       

      +

      Dashboard - Not logged in

      +

       

      +

      +

       

      +

      + + + + + + + +
      +

      +       		+

      Latest Activity - displays publicly available DMPs and Datasets according to the date of their publication in Argos and their Label (DMPs or Datasets)

      +
      +

       

      +

      + + + + + + + +
      +

      +       		+

      Public Usage - shows the number of publicly available DMPs, Datasets, Grants and Organizations included in Argos

      +

       

      +

      Note! When logged in to ARGOS the Homepage becomes a personal Dashboard, hence the numbers change to correspond to information provided by the individual’s activity.

      +
      +

       

      +

      Dashboard - Logged in

      +

       

      +

      +

       

      +

       

      +

      + + + + + + + +
      +

      +       		+

      Latest Activity - displays users’ DMPs and Datasets classified according to the date of their last modification, the status of the document (draft, finalized, published) and their label (DMPs or Datasets)

      +
      +

       

      +

      + + + + + + + +
      +

      +       		+

      Personal Usage - shows users activity in DMPs, Datasets, Grants and Organizations

      +
      +

       

      +
    6. +

      My DMPs / My Datasets

      +
      7. +

       

      +

      Contains all DMPs and Datasets which the user is either the owner or the collaborator of. Both DMPs and Datasets on the user dashboard are classified by the date of their last modification, the status of the document (draft, finalized, published) and their label (DMPs or Datasets).

      +

       

      +

      My DMPs

      +

      Each DMP card is green and shows the role of the person viewing the DMP, the status of the writing process, the version of the current DMP, the grant associated with the DMP, the number and name of datasets that the DMP has.

      +

       

      +

      +

       

      +

      Export - supports download of the DMP outputs in the following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools)

      +

       

      +

      Add Dataset - adds more Datasets to existing DMPs

      +

       

      +

      Invite - provides people with edit rights on the document

      +

       

      +

      Clone - creates an exact replica of the DMP

      +

       

      +

      + + + + + + + +
      +

      +       		+

      New version - starts a new version of the DMP

      +

      All DMP Versions  - shows the history of the different versions of the existing DMP

      +

      Delete - permanently removes DMPs

      +

       

      +
      +

       

      +

       

      +

      My Datasets

      +

      Each Dataset card is yellow and shows the role of the person viewing the Dataset, the status of the writing process, the grant associated with the DMP and the tite of the DMP that the dataset is part of.

      +

       

      +

      +

       

      +

      Export - supports download of the DMP outputs in the following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools)

      +

       

      +

      Invite - Sends email or searches the Argos Users Catalogue to find colleagues/ collaborators. Invitation sent provides people with edit rights on the document.

      +

       

      +

       

      +

      + + + + + + + +
      +

      +       		+

      Copy Dataset - creates a copy of the dataset

      +

      Delete - permanently removes Datasets

      +
      +
    7. +

      Public DMPs / Public Datasets

      +
      8. +

       

      +

      Contains DMPs outputs that are openly available in Argos. That means that DMP owners and members are making their DMP and/or Dataset outputs available to all Argos and non-Argos users who might want to consult or re-use them under the framework provided by the assigned DMP license.

      +

      Both DMPs and Datasets on the user dashboard are classified by the date of their last modification and their label (DMPs or Datasets). Users can also search for the DMP or Dataset from the search bar.

      +

       

      +

      Public DMPs

      +

      Each Public DMP card is green and displays the title of the DMP, its status (published), the version of the DMP, the grant associated with it, the number and name of datasets that the DMP contains.

      +

       

      +

      +

       

      +

      Export - supports download of the DMP outputs in the following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools)

      +

       

      +

      Clone - creates an exact replica of the DMP

      +

      + + + + + + + +
      +

      +       		+

      All DMP Versions - shows the history of the different versions of the existing DMP

      +

       

      +
      +

       

      +

       

      +

      Public Datasets

      +

      Each Public Dataset card is yellow and displays the title of the dataset, the status of the dataset (published), the grant associated with the DMP and the title of the DMP that the dataset is part of.

      +

       

      +

      +

       

      +

      Export - supports download of the DMP outputs in the following formats: PDF, Document, XML, RDA JSON (can be imported to other RDA compliant DMP tools)

      +

       

      +

      + + + + + + + +
      +

      +       		+

      Copy Dataset - creates a copy of the dataset

      +
      +
    8. +

      Create DMPs

      +
      9. +

       

      +

      There are many ways to create new DMPs in Argos.

      +

       

      +

      Start new DMP - Start Wizard

      +

      +

       

      +

      There are four steps involved in creating a DMP: Main Info - Funding Info - License Info - Dataset Info

      +

       

      +

       

      +
        +
      1. Main Info
        2. +

         

        +

        +

        +

         

        +

         

        +

        Title - title of the DMP

        +

         

        +

        Description - brief description of what the DMP is about, it’s scope and objectives

        +

         

        +

        Language - the language of the DMP

        +

         

        +

        Visibility - how the DMP is displayed in Argos. By choosing Public, the DMP is automatically made available to all users from the “Public DMPs” collection.

        +

         

        +

        Researchers - the people that have produced, processed, analysed the data described in the DMP

        +

         

        +

        Organizations - the names of the organizations contributing to the creation and revision of the DMPs

        +

         

        +

        Contact - the contact details of the DMP owner

        +

         

        +

         

        +
      2. Funding Info
        3. +

         

        +

        +

         

        +

        Funding organizations - A drop-down menu where users may find the organisation that their research is funded by. In case that the name of a funding organisation can not be found in Argos, users may create a new record with the name and details of the funding organisation (“Insert it manually”).

        +

         

        +

        Grants - A drop-down menu to select the grant that is associated with the research project of the given funding organisation. In case that the grant can not be found in Argos, users may create a new record with the number and name of the grant (“Insert it manually”).

        +

         

        +

        Project - This field is to be completed only for projects where multiple grants apply. Otherwise, it is left blank and is later filled automatically by Argos metadata.

        +

         

        +

        Note!  There may be many projects associated with a grant number.

        +

         

        +

         

        +
      3. License Info
        4. +

         

        +

        +

        License - A list of licenses to choose from and assign to DMPs

        +

         

        +

         

        +
      4. Dataset Info
        5. +

         

        +

        +

         

        +

        Dataset Info - Select a template to describe your datasets. You may select more than one template.

        +

         

        +

        Save DMPs

        +

         

        +

        Discard - undo all changes made to the dataset

        +

         

        +

        Save - keeps all changes made to the DMP and continues work on the same page

        +

         

        +

        Save & Add Dataset - keeps all changes made to the DMP and the Dataset editor starts to describe the first dataset of the DMP

        + +
      +
    9. +

      Add Dataset(s)

      +
      10. +

      There are two ways to create datasets: when creating the first dataset of the DMP and when adding datasets to existing DMPs. Add datasets are linked to and are associated with at least one DMP in Argos. A dataset can not exist as an orphan record.

      +

       

      +

      First dataset

      +

      +

      Once the DMP is created, the user can fill in the description for their data in the Dataset Editor.

      +

       

      +

      Add dataset - Adds more Dataset to existing DMPs

      +

      There are three steps involved in adding a Dataset: Select a DMP for your Dataset - Select Template - Edit Dataset

      +

       

      +
        +
      1. Select a DMP for your Dataset
        2. +

        +

        Selects an existing DMP from the drop-down menu

        +

         

        +
      2. Select Template
        3. +

        +

        Selects the template of the Dataset that users are required to describe their datasets with by corresponding to their grant funding organisations.

        +

         

        +
      3. Edit Dataset
        4. +

        +

        A Dataset Editor to add information that describes management activities according to the selected template.

        +

         

        +

        Save Datasets

        +

        There are many ways to Save a DMP in Argos. They all serve the same function, but the difference lies in the follow up action.

        +

         

        +

        +

         

        +

        Discard - undo all changes made to the dataset

        +

         

        +

        Save - keeps all changes made and continues work on the same page

        +

         

        +

        Save & Close - keeps all changes made, but the editor’s window closes and the user is redirected to their dashboard

        +

         

        +

        Save & Add New - keeps all changes made and a new editor starts to describe a new dataset

        +
      +
    10. +

      DMPs/ Datasets records

      +
      11. +

      Records of DMPs and Datasets in Argos after editing and after finalization.

      +

      Users can view the DMPs and Datasets they create from their dashboard. By opening a record they have created, they are provided with additional functionalities that are binded to the completion of the DMP writing process. Different functionalities apply according to the status of the DMP, i.e. before or after the DMP finalization.

      +

       

      +

       

      +

      DMPs before finalization

      +

      +

       

      +

      Before finalization, the DMP can be further edited, deleted or cloned. Users can review information that they have added regarding grant, researchers, DMP description and datasets used. New datasets can be added at any time from this page. Users can export the DMP, they can start working on a new version and/ or invite colleagues to collaborate on completing the DMP.

      +

       

      +

       

      +

      Invite

      +

      +

       

      +

       

      +

      DMPs after finalization

      +

      +

       

      +

      After the DMP finalization, the DMP can be made publicly visible in Argos and deposited in Zenodo. Users can export the finalized DMP, they can start working on a new version and/ or invite colleagues to collaborate on completing the DMP. Finalization is possible to be reverted.

      +

       

      +

       

      +

      Datasets before finalization

      +

      Argos offers different options before and after the Dataset finalization.

      +

       

      +

      +

       

      +

      Before finalization, the Dataset can be further edited, deleted or cloned. Users can access the whole DMP that the dataset is part of from that page and review information that they have added regarding grant, researchers and Dataset description. Users can export the description of the dataset and invite colleagues to collaborate on its completion.

      +

       

      +

       

      +

      Datasets after finalization

      +

      +

       

      +

      After finalization, the Dataset can be exported and shared with colleagues for review.

      +

       

      +

       

      +

       

      +

       

      +

       

      +
    +
+
+
+
+
+ + + + + +