-
-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Traduz página sobre documentação e interface de busca
- Loading branch information
Showing
3 changed files
with
91 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,28 @@ | ||
Documentation | ||
########################### | ||
Documentation | ||
############### | ||
|
||
Soon | ||
The project's technical documentation helps interested parties, users | ||
and developers to understand the project, registering fundamental information and | ||
describing in more depth how Querido Diário works and what features it offers. | ||
|
||
- **Repository**: https://github.com/okfn-brasil/querido-diario-comunidade | ||
- **How to install and preview the documentation**: `README`_ | ||
|
||
All official documentation (this site!) is generated from the repository's ``.rst`` files, | ||
built with the `Sphinx`_ documentation generator, using the | ||
`sphinx-rtd-theme`_, and is hosted on the `Read The Docs`_ service. | ||
|
||
Each of the pages on this site, listed in the navigation menu, corresponds to | ||
a file of the same name in the ``/docs`` directory. You can also access the files | ||
via the "Edit on GitHub" link at the top of every page. | ||
|
||
.. important:: | ||
It is important that the documentation is up-to-date and relevant to the community. | ||
Don't hesitate to contribute with pull requests (PRs) for adjustments, complements | ||
and additions, as well as translations into other languages. | ||
|
||
.. REFERENCES: | ||
.. _README: https://github.com/okfn-brasil/querido-diario-comunidade?tab=readme-ov-file#como-executar | ||
.. _Sphinx: https://www.sphinx-doc.org/en/master/ | ||
.. _sphinx-rtd-theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/ | ||
.. _Read The Docs: https://about.readthedocs.com/?ref=readthedocs.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,65 @@ | ||
Search Interface | ||
########################### | ||
######################## | ||
|
||
Soon | ||
The Querido Diário search interface is a resource that allows users to search, in a | ||
user-friendly way, the data that the project stores: the texts of official gazettes. | ||
It is accessible through the `Querido Diário web platform`_. | ||
|
||
Learn how to use the search interface as you prefer, either by watching a recording | ||
or through a textual tutorial, below. | ||
|
||
Browsing the site (in Portuguese) | ||
*********************************** | ||
|
||
.. raw:: html | ||
|
||
<div style="position:relative;padding-bottom:56.25%;margin-bottom:3vh"> | ||
<iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" | ||
src="https://www.youtube.com/embed/Qk5oQ9g1iX8" | ||
title="YouTube video player" allow="accelerometer; autoplay; clipboard-write; | ||
encrypted-media; gyroscope; picture-in-picture; web-share" | ||
allowfullscreen></iframe> | ||
</div> | ||
|
||
Search Usage Tutorial | ||
****************************** | ||
|
||
.. image:: https://querido-diario-static.nyc3.cdn.digitaloceanspaces.com/docs/search-interface/interface-de-busca.png | ||
:alt: QD search interface on the web platform | ||
|
||
There, you can search by **keywords**: | ||
|
||
.. image:: https://querido-diario-static.nyc3.cdn.digitaloceanspaces.com/docs/search-interface/busca-querystring.png | ||
:alt: Keyword query result | ||
|
||
.. tip:: | ||
You can improve your search results by using `Advanced Search Operators`_. | ||
|
||
Apply **filters by municipality and date**: | ||
|
||
.. image:: https://querido-diario-static.nyc3.cdn.digitaloceanspaces.com/docs/search-interface/busca-filtros.png | ||
:alt: Query result by keywords with filters | ||
|
||
You can **sort results** in the most appropriate way for your search. | ||
|
||
.. image:: https://querido-diario-static.nyc3.cdn.digitaloceanspaces.com/docs/search-interface/busca-ordenacao.png | ||
:alt: Clicking the "sort by" button on the search page | ||
|
||
.. attention:: | ||
When sorting by **Relevance**, the first search results will be excerpts from | ||
gazettes with the greatest correspondence to the keywords used. In other words, the | ||
entire document is the most relevant and the excerpt is just one of the interesting | ||
passages from that edition. | ||
|
||
And you can also download the **official gazette in original and/or open format**: | ||
|
||
.. image:: https://querido-diario-static.nyc3.cdn.digitaloceanspaces.com/docs/search-interface/busca-baixar.png | ||
:alt: Clicking on the "download official diary" button of the diary excerpt | ||
|
||
.. tip:: | ||
If the excerpt does not provide sufficient context, it is recommended to download the gazette (in the format you prefer) | ||
and perform a text search for any of the terms present in the excerpt. | ||
|
||
.. REFERENCES | ||
.. _plataforma web do Querido Diário: https://queridodiario.ok.org.br/ | ||
.. _Advanced Search Operators: https://queridodiario.ok.org.br/tecnologia/busca-avancada |