invenio-app-rdm 5.0.0.dev0__py2.py3-none-any.whl → 14.0.0b4.dev4__py2.py3-none-any.whl

invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/statistics.en.html

@@ -0,0 +1,197 @@
+{#
+  Copyright (C) 2021-2023 CERN.
+  Copyright (C) 2021 Northwestern University.
+
+  Invenio App RDM is free software; you can redistribute it and/or modify it
+  under the terms of the MIT License; see LICENSE file for more details.
+#}
+{%- set title = _("FAQ statistics") %}
+{%- extends config.BASE_TEMPLATE %}
+
+{%- block page_body %}
+  <div class="ui two column grid container rel-mt-2">
+    <div class="ui row">
+      <div class="ui sixteen wide column">
+        <h2 id="statistics">Statistics</h2>
+        <p></p>
+      </div>
+      <div class="ui eight wide column">
+        <h3>
+          <p>What do you track?</p>
+        </h3>
+        <p>We track two types of events:</p>
+        <ol>
+          <li>Visits to a record page.</li>
+          <li>Downloads of a file.</li>
+        </ol>
+        <p>For both types of events, we track:</p>
+        <ol>
+          <li>
+            <strong>Visitor:</strong>
+            An anonymized visitor ID.
+          </li>
+          <li>
+            <strong>Visitor type:</strong>
+            If the request was made by a) human, b) machine or c) robot.
+          </li>
+          <li>
+            <strong>Country:</strong>
+            The country of origin of the request (based on the IP address).
+          </li>
+          <li>
+            <strong>Referrer:</strong>
+            The referrer domain.
+          </li>
+        </ol>
+        <h3>
+          <p>
+            What is a
+            <em>view</em>
+            ?
+          </p>
+        </h3>
+        <p>A user (human or machine) visiting a record, excluding double-clicks and robots.</p>
+        <h3>
+          <p>
+            What is a
+            <em>unique view</em>
+            ?
+          </p>
+        </h3>
+        <p>
+          A
+          <em>unique view</em>
+          is defined as one or more visits by a user within a 1-hour time-window. This means that if the same record was
+          accessed multiple times by the same user within the same time-window, we consider it as one unique view.
+        </p>
+        <h3>
+          <p>
+            What is a
+            <em>download</em>
+            ?
+          </p>
+        </h3>
+        <p>A user (human or machine) downloading a file from a record, excluding double-clicks and robots. If a record has
+          multiple files and you download all files, each file counts as one download.</p>
+        <h3>
+          <p>
+            What is a
+            <em>unique download</em>
+            ?
+          </p>
+        </h3>
+        <p>
+          A
+          <em>unique download</em>
+          is defined as one or more file downloads from files of a single record by a user within a 1-hour time-window. This
+          means that if one or more files of the same record were downloaded multiple times by the same user within the same
+          time-window, we consider it as one unique download.
+        </p>
+        <h3>
+          <p>
+            What is
+            <em>downloaded data volume</em>
+            ?
+          </p>
+        </h3>
+        <p>The total data volume that has been downloaded for all files in a record by a user (human or machine), excluding
+          double-clicks and robots. In case a user cancels a file download mid-way, we still count the total file size as
+          fully downloaded.</p><h3>
+          <p>How do you deal with versions?</p>
+        </h3>
+        <p>By default, for a record, we display the aggregated counts of views, downloads and data volume for all versions
+          of a record. You can further expand the usage statistics box on a record page to see the counts for the specific
+          version.</p>
+        <h3>
+          <p>How do you deal with robots?</p>
+        </h3>
+        <p>
+          Requests made by robots (aka crawlers, spiders, bots) are filtered out from the usage statistics. We detect robots
+          based on a standardized list of robots provided by the
+          <a href="https://www.projectcounter.org/">COUNTER</a>
+          and
+          <a href="https://makedatacount.org/">Making Data Count</a>
+          projects.
+        </p>
+        <h3>
+          <p>How often do you update usage statistics?</p>
+        </h3>
+        <p>Once a day.</p>
+        <h3>
+          <p>How can I see the most viewed records?</p>
+        </h3>
+        <p>
+          Any search on {{ config.THEME_SITENAME }} allows you to sort the search results by "
+          <a href="https://zenodo.org/search?sort=mostviewed">most viewed</a>
+          ".
+        </p>
+        <h3>
+          <p>How do you track?</p>
+        </h3>
+        <p>
+          We comply with the
+          <a href="https://www.projectcounter.org/">COUNTER Code of Practice</a>
+          as well as the
+          <a href="https://peerj.com/preprints/26505/">Code of Practice for Research Data Usage Metrics</a>
+          in our tracking. This means that our usage statistics can be compared with other COUNTER-compliant repositories.
+        </p>
+      </div>
+      <div class="ui eight wide column">
+        <h3>
+          <p>What is the difference between a machine and a robot?</p>
+        </h3>
+        <p>
+          A
+          <em>machine request</em>
+          is an automated request initiated by a human user, e.g. a script downloading data from {{ config.THEME_SITENAME }} and running an
+          analysis on the data. A
+          <em>robot request</em>
+          is an automated request made by e.g. a search engine crawler.
+        </p>
+        <h3>
+          <p>How do you anonymize users?</p>
+        </h3>
+        <p>For each view/download event, we track an anonymized visitor ID. This anonymized visitor ID changes for a user
+          every 24 hours, hence a user viewing the same record on two different days will have two different anonymized
+          visitor IDs. The reason we track an anonymized visitor ID is in order to count unique views and downloads.</p>
+        <p>
+          For security purposes, we also keep a web server access log which includes your
+          <a href="https://en.wikipedia.org/wiki/IP_address">IP address</a>
+          and your browser’s
+          <a href="https://en.wikipedia.org/wiki/User_agent">user agent</a>
+          string. This web server access log is automatically deleted after maximum 1 year and is also strictly separated
+          from the usage statistics collection.
+        </p>
+        <p>The anonymized visitor ID is generated from a personal identifier such as:</p>
+        <ol>
+          <li>a user ID (e.g. if you are logged in on zenodo.org),</li>
+          <li>a session ID,</li>
+          <li>or an IP address and your browser’s user-agent string.</li>
+        </ol>
+        <p>
+          We combine the personal identifier with a random text value (a salt) and apply a one-way
+          <a href="https://en.wikipedia.org/wiki/Cryptographic_hash_function">cryptographic hash function</a>
+          to scramble the data. The salt (random text value) is thrown away and regenerated every 24 hours. Using and
+          afterwards throwing away the random salt, ensures that the anonymized visitor ID is fully random.
+        </p>
+        <h3>
+          <p>Can I opt-out of the usage statistics tracking?</p>
+        </h3>
+        <p>No, it is not possible to opt-out. The usage statistics tracking is fully anonymized and is done on the
+          server-side.</p>
+        <h3>
+          <p>Do you support usage statistics for a community?</p>
+        </h3>
+        <p>Not yet, but we will be adding aggregated usage statistics for your communities.</p>
+        <h3>
+          <p>Do you track my search queries?</p>
+        </h3>
+        <p>No.</p>
+        <h3>
+          <p>Do you do any manual or automatic profiling of users?</p>
+        </h3>
+        <p>No.</p>
+      </div>
+    </div>
+  </div>
+{% endblock page_body %}

invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/statistics.sv.html

@@ -0,0 +1,196 @@
+{#
+  Copyright (C) 2021-2023 CERN.
+  Copyright (C) 2024 KTH Royal Institute of Technology.
+
+  Invenio App RDM är fri programvara; du kan återdistribuera och/eller modifiera den
+  enligt villkoren i MIT-licensen; se LICENSE-filen för mer information.
+#}
+{%- set title = _("FAQ statistics") %}
+{%- extends config.BASE_TEMPLATE %}
+
+{%- block page_body %}
+  <div class="ui two column grid container rel-mt-2">
+    <div class="ui row">
+      <div class="ui sixteen wide column">
+        <h2 id="statistics">Statistik</h2>
+        <p></p>
+      </div>
+      <div class="ui eight wide column">
+        <h3>
+          <p>Vad spårar ni?</p>
+        </h3>
+        <p>Vi spårar två typer av händelser:</p>
+        <ol>
+          <li>Besök på en post-sida.</li>
+          <li>Nedladdningar av en fil.</li>
+        </ol>
+        <p>För båda typer av händelser spårar vi:</p>
+        <ol>
+          <li>
+            <strong>Besökare:</strong>
+            Ett anonymiserat besökar-ID.
+          </li>
+          <li>
+            <strong>Besökarkategori:</strong>
+            Om förfrågan gjordes av a) människa, b) maskin eller c) robot.
+          </li>
+          <li>
+            <strong>Land:</strong>
+            Ursprungsland för förfrågan (baserat på IP-adress).
+          </li>
+          <li>
+            <strong>Referens:</strong>
+            Domän från vilken besökaren kom.
+          </li>
+        </ol>
+        <h3>
+          <p>
+            Vad är en
+            <em>visning</em>
+            ?
+          </p>
+        </h3>
+        <p>En användare (människa eller maskin) som besöker en post, exklusive dubbelklick och robotar.</p>
+        <h3>
+          <p>
+            Vad är en
+            <em>unik visning</em>
+            ?
+          </p>
+        </h3>
+        <p>
+          En
+          <em>unik visning</em>
+          definieras som ett eller flera besök av en användare inom ett tidsfönster på 1 timme. Detta innebär att om samma
+          post besöks flera gånger av samma användare inom samma tidsfönster räknas det som en unik visning.
+        </p>
+        <h3>
+          <p>
+            Vad är en
+            <em>nedladdning</em>
+            ?
+          </p>
+        </h3>
+        <p>En användare (människa eller maskin) som laddar ner en fil från en post, exklusive dubbelklick och robotar. Om en
+          post har flera filer och du laddar ner alla filer, räknas varje fil som en nedladdning.</p>
+        <h3>
+          <p>
+            Vad är en
+            <em>unik nedladdning</em>
+            ?
+          </p>
+        </h3>
+        <p>
+          En
+          <em>unik nedladdning</em>
+          definieras som en eller flera nedladdningar från filer i en post av en användare inom ett tidsfönster på 1 timme.
+          Detta innebär att om en eller flera filer från samma post laddas ner flera gånger av samma användare inom samma
+          tidsfönster räknas det som en unik nedladdning.
+        </p>
+        <h3>
+          <p>
+            Vad är
+            <em>nedladdad datavolym</em>
+            ?
+          </p>
+        </h3>
+        <p>Den totala datavolym som har laddats ner för alla filer i en post av en användare (människa eller maskin),
+          exklusive dubbelklick och robotar. Om en användare avbryter en nedladdning mitt i, räknar vi ändå hela filstorleken
+          som fullt nedladdad.</p><h3>
+          <p>Hur hanterar ni versioner?</p>
+        </h3>
+        <p>Som standard visar vi de sammanlagda räkningarna av visningar, nedladdningar och datavolymer för alla versioner av
+          en post. Du kan även expandera användningsstatistikrutan på en postsida för att se informationen för den specifika
+          versionen.</p>
+        <h3>
+          <p>Hur hanterar ni robotar?</p>
+        </h3>
+        <p>
+          Förfrågningar från robotar (även kallade crawlers, spindlar, bots) filtreras bort från användningsstatistiken. Vi
+          identifierar robotar baserat på en standardiserad lista från projekten
+          <a href="https://www.projectcounter.org/">COUNTER</a>
+          och
+          <a href="https://makedatacount.org/">Making Data Count</a>.
+        </p>
+        <h3>
+          <p>Hur ofta uppdateras användningsstatistiken?</p>
+        </h3>
+        <p>En gång om dagen.</p>
+        <h3>
+          <p>Hur kan jag se de mest visade posterna?</p>
+        </h3>
+        <p>
+          Vid sökningar på {{ config.THEME_SITENAME }} kan du sortera sökresultaten efter "
+          <a href="https://zenodo.org/search?sort=mostviewed">mest visade</a>
+          ".
+        </p>
+        <h3>
+          <p>Hur spårar ni?</p>
+        </h3>
+        <p>
+          Vi följer
+          <a href="https://www.projectcounter.org/">COUNTER Code of Practice</a>
+          samt
+          <a href="https://peerj.com/preprints/26505/">Code of Practice for Research Data Usage Metrics</a>
+          i vår spårning. Detta innebär att vår användningsstatistik kan jämföras med andra COUNTER-kompatibla arkiv.
+        </p>
+      </div>
+      <div class="ui eight wide column">
+        <h3>
+          <p>Vad är skillnaden mellan en maskin och en robot?</p>
+        </h3>
+        <p>
+          En
+          <em>maskinförfrågan</em>
+          är en automatiserad förfrågan initierad av en mänsklig användare, t.ex. ett skript som laddar ner data från {{
+          config.THEME_SITENAME }} och kör en analys på datan. En
+          <em>robotförfrågan</em>
+          är en automatiserad förfrågan gjord av t.ex. en sökmotorcrawler.
+        </p>
+        <h3>
+          <p>Hur anonymiserar ni användare?</p>
+        </h3>
+        <p>För varje visnings-/nedladdningshändelse spårar vi ett anonymiserat besökar-ID. Detta anonymiserade besökar-ID
+          ändras för en användare var 24:e timme, så en användare som besöker samma post två olika dagar får två olika
+          anonymiserade besökar-ID. Syftet med att spåra ett anonymiserat besökar-ID är att kunna räkna unika visningar och
+          nedladdningar.</p>
+        <p>
+          Av säkerhetsskäl behåller vi även en webbserverlogg som inkluderar din
+          <a href="https://en.wikipedia.org/wiki/IP_address">IP-adress</a>
+          och din webbläsares
+          <a href="https://en.wikipedia.org/wiki/User_agent">user agent</a>
+          -sträng. Denna logg raderas automatiskt efter högst ett år och är strikt separerad från insamlingen av användningsstatistik.
+        </p>
+        <p>Det anonymiserade besökar-ID:et genereras från en personlig identifierare, exempelvis:</p>
+        <ol>
+          <li>ett användar-ID (t.ex. om du är inloggad på zenodo.org),</li>
+          <li>ett sessions-ID,</li>
+          <li>eller en IP-adress och din webbläsares user agent-sträng.</li>
+        </ol>
+        <p>
+          Vi kombinerar den personliga identifieraren med ett slumpmässigt textvärde (ett salt) och tillämpar en envägs-
+          <a href="https://en.wikipedia.org/wiki/Cryptographic_hash_function">kryptografisk hash-funktion</a>
+          för att kryptera datan. Saltet (slumpvärdet) kastas bort och genereras om var 24:e timme. Genom att använda och
+          sedan kasta bort det slumpmässiga saltet säkerställs att det anonymiserade besökar-ID:et är helt slumpmässigt.
+        </p>
+        <h3>
+          <p>Kan jag välja bort att bli spårad i användningsstatistiken?</p>
+        </h3>
+        <p>Nej, det är inte möjligt att välja bort. Spårningen för användningsstatistik är fullt anonymiserad och sker på
+          serversidan.</p>
+        <h3>
+          <p>Stödjer ni användningsstatistik för en community?</p>
+        </h3>
+        <p>Inte än, men vi kommer att lägga till aggregerad användningsstatistik för communities.</p>
+        <h3>
+          <p>Spårar ni mina sökningar?</p>
+        </h3>
+        <p>Nej.</p>
+        <h3>
+          <p>Gör ni någon manuell eller automatisk profilering av användare?</p>
+        </h3>
+        <p>Nej.</p>
+      </div>
+    </div>
+  </div>
+{% endblock page_body %}

invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/versioning.en.html

@@ -0,0 +1,149 @@
+{#
+  Copyright (C) 2021-2023 CERN.
+  Copyright (C) 2021 Northwestern University.
+
+  Invenio App RDM is free software; you can redistribute it and/or modify it
+  under the terms of the MIT License; see LICENSE file for more details.
+#}
+{%- set title = _("FAQ versioning") %}
+{%- extends config.BASE_TEMPLATE %}
+
+{%- block page_body %}
+  <div class="ui two column grid container rel-mt-2">
+    <div class="ui row">
+      <div class="ui sixteen wide column">
+        <h2 id="versioning">DOI versioning</h2>
+      </div>
+      <div class="ui eight wide column">
+        <h5>
+          <p>What is DOI versioning?</p>
+        </h5>
+        <p>DOI versioning allows you to:</p>
+        <ul>
+          <li>edit/update the record’s files after they have been published.</li>
+          <li>cite a specific version of a record.</li>
+          <li>cite all of versions of a record.</li>
+        </ul>
+        <h5>
+          <p>How does DOI versioning work?</p>
+        </h5>
+        <p>
+          When you publish an upload for the first time, we register two DOIs:
+        </p>
+        <ul>
+          <li>
+            a DOI representing the <strong>specific version</strong> of your record.
+          </li>
+          <li>
+            a DOI representing <strong>all of the versions</strong> of your record.
+          </li>
+        </ul>
+        <p>Afterwards, we register a DOI for every new version of your upload.</p>
+        <p>
+          This is best illustrated by an example of a software package. If the
+          software has been released in two versions (v1.0 and v1.1), then
+          the following DOIs would have been registered:
+        </p>
+        <ul>
+          <li><strong>v1.0 (specific version):</strong> 10.1234/7s0da-05p39</li>
+          <li><strong>v1.1 (specific version):</strong> 10.1234/chc5z-w0r30</li>
+          <li><strong>Concept (all versions):</strong> 10.1234/3s67k-pd636</li>
+        </ul>
+        <p>
+          The first two DOIs for versions <strong>v1.0</strong> and
+          <strong>v.1.1</strong> represent the specific versions of the software.
+          The last DOI represents all the versions of the given software package,
+          i.e. the concept of the software package and the ensemble of versions. We
+          therefore also call the them <strong>Version DOIs</strong> and
+          <strong>Concept DOIs</strong> (note, technically both are just normal
+          DOIs).
+        </p>
+        <p>
+          You may notice that the version DOIs do not include a “.v1”-suffix. Read
+          below to find out why.
+        </p>
+        <h5>
+          <p>Which DOI should I use in citations?</p>
+        </h5>
+        <p>
+          You should normally always use the DOI for the
+          <strong>specific version</strong> of your record in citations. This is to
+          ensure that other researchers can access the
+          <strong>exact</strong> research artefact you used for reproducibility. By
+          default, we use the specific version to generate citations.
+        </p>
+        <p>
+          You can use the Concept DOI representing all versions in citations when it
+          is desirable to cite an evolving research artifact, without being specific
+          about the version.
+        </p>
+        <h5>
+          <p>Where does the Concept DOI resolve to?</p>
+        </h5>
+        <p>
+          The Concept DOI resolves to the landing page of the latest
+          version of your record.
+        </p>
+      </div>
+      <div class="ui eight wide column">
+        <h5>
+          <p>
+            I only want to change the title of my upload, do I still get a new DOI?
+          </p>
+        </h5>
+        <p>
+          No, you can continue to edit the metadata of your upload without
+          creating a new version of a record. You should only create a new version
+          if you want to update the files of your record.
+        </p>
+
+        <h5>
+          <p>Why don’t the DOIs have a version number suffix like “.v1”?</p>
+        </h5>
+        <p>
+          Including semantic information such as the version number in a DOI is bad
+          practice, because this information may change over time, while DOIs must
+          remain persistent and should not change.
+        </p>
+        <p>
+          Moreover, DOI versioning is linear, which means that the version number may
+          in fact not be the real version number of the resource.
+          Take for instance software, where it is common practice to have dot
+          versions and make new releases in a non-linear order (e.g. first v1.0,
+          then v1.1, then v2.0, then v1.2).
+        </p>
+        <p>
+          The versioning suffix is also not a functionality of the DOI system, i.e.
+          adding .v2 to a DOI will not resolve to version 2 of a resource for any DOI
+          from any provider. Different providers also use different patterns such as
+          e.g. .v2, .2, /2.
+        </p>
+        <p>
+          Most importantly, version suffixes are not machine readable. A discovery
+          system that understands DOIs, will not know that .v1 and .v2 of a DOI are
+          in fact two versions of the same resource.
+        </p>
+        <p>
+          A better solution to this problem is to semantically link two DOIs in the
+          metadata of a DOI. This ensures that discovery systems have a
+          machine-readable way to discover that two DOIs are versions of the same
+          resource.
+        </p>
+        <p>
+          See also <a href="https://doi.org/10.5438/55E5-T5C0">Cool DOIs</a> for
+          further information.
+        </p>
+
+        <h5>
+          <p>Do you duplicate all the files for every new version of a record?</p>
+        </h5>
+        <p>
+          No, if you change a 10kb README file in 50GB dataset we do not duplicate
+          the entire 50GB dataset. InvenioRDM, the underlying technical software
+          platform, efficiently handles the file storage so we only store the new
+          extra 10kb.
+        </p>
+      </div>
+    </div>
+  </div>
+{% endblock page_body %}