diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..ee62946 --- /dev/null +++ b/404.html @@ -0,0 +1,159 @@ + + + + + + + + Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • +
  • +
  • +
+
+
+
+
+ + +

404

+ +

Page not found

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + + diff --git a/changelog/changelog/index.html b/changelog/changelog/index.html new file mode 100644 index 0000000..7b18de0 --- /dev/null +++ b/changelog/changelog/index.html @@ -0,0 +1,573 @@ + + + + + + + + Changelog - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Changelog

+

As principais mudanças realizadas no repositório do Ro-dou estão documentadas aqui a partir de 25/04/2023.

+

[0.3.0] - 2024-11-12

+

What's Changed

+
    +
  • +

    Permitir busca no Querido Diário para um grupo de municípios by @slfabio in https://github.com/gestaogovbr/Ro-dou/pull/148 +A partir desta mudança, é permitido informar uma lista de municípios para buscas no Querido Diário.

    +
  • +
  • +

    Cria novo parâmetro de filtro por tipo de publicação by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/154 +O parâmetro pubtype permite filtrar publicações tanto no DOU quanto no INLABS com base no tipo (Decreto, Lei, Ata, etc.).

    +
  • +
  • +

    Melhorias no deployment local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/156

    +
  • +
+

🚀 Outros

+
    +
  • Update CHANGELOG.md for 0.2.4 by @github-actions in https://github.com/gestaogovbr/Ro-dou/pull/145
  • +
+

New Contributors

+
    +
  • @slfabio made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/148
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.2.4...0.2.5

+

[0.2.4] - 2024-09-10

+ + +

What's Changed

+

Hotfix

+

Corrige resultados incompletos na busca com filtros por unidades b57b486a2fb692e3e664e764dcc5e2c0f83c9948

+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.2.3...0.2.4

+

[0.2.3] - 2024-09-04

+ + +

What's Changed

+

Hotfix

+
    +
  • Ajusta o código para utilizar XCom_pull de múltiplos Tasks IDs no Airflow 2.10.0. by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/140
  • +
+

🚀 Outros

+
    +
  • Ignore markdown files in CI Tests by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/141
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.2.2...0.2.3

+

[0.2.2] - 2024-09-02

+ + +

What's Changed

+
    +
  • Upgrade Airflow to 2.10.0 by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/137
  • +
+

🚀 Outros

+
    +
  • Cast tags to a list when generating dags by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/135
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.2.1...0.2.2

+

[0.2.1] - 2024-08-30

+ + +

What's Changed

+
    +
  • Criar busca de exemplo para DOU e Querido Diário (modo misto) by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/132
  • +
+

🚀 Outros

+
    +
  • Hotfix by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/131
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.2.0...0.2.1

+

[0.2.0] - 2024-08-29

+ + +

What's Changed

+
    +
  • Os resultados agora são agrupados por unidade, quando informada.
  • +
  • Utilização do Pydantic para validação dos campos do yaml.
  • +
+

🚀 Outros

+
    +
  • Agrupar resultados por unidade by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/122
  • +
  • Migrate yaml file validation from JSON schema to Pydantic schemas by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/118
  • +
  • Fix logic operators in result_as_html function by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/123
  • +
  • Add syspath for schemas and change dag.owners to string by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/125
  • +
  • Alter trigger to run CI Tests on push only to main branch by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/127
  • +
  • Hotfix para correção de variável no módulo de envio de email by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/128
  • +
  • Corrige as linhas e colunas na exportação via CSV by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/129
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.1.5...0.2.0

+

[0.1.5] - 2024-08-09

+ + +

What's Changed

+
    +
  • Cria parâmetro opcional para uso da ementa (se houver) da publicação ao invés da janela de contexto ou texto completo. by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/113
  • +
  • Cria parâmetro para uso de dataset no Data-Aware Schedulling. O schedule da DAG agora pode ser definido por três meios: cron, dataset ou cron + dataset
  • +
  • by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/115
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.1.4...0.1.5

+

[0.1.4] - 2024-07-30

+

What's Changed

+
    +
  • Close p tag in watermark by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/109
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.1.3...0.1.4

+

[0.1.3] - 2024-07-25

+
    +
  • Cria a nova página de documentação do Ro-DOU no Github Pages
  • +
  • Cria a marca d'agua do Ro-DOU no template do email
  • +
  • Adiciona quebra de linhas no texto no modo full_text (INLABS)
  • +
  • Corrige bug quando a paginação de resultados é igual a 2 (DOU)
  • +
+

What's Changed

+
    +
  • Update README.md by @marcelosinnerworkings in https://github.com/gestaogovbr/Ro-dou/pull/95
  • +
  • Fix format for Outlook display by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/96
  • +
  • Force justify text by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/97
  • +
  • Include parameter for dynamic no result text in notification by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/98
  • +
  • add dataset trigger scheduler by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/99
  • +
  • Fix pagination by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/104
  • +
  • Keep line breaks in full text mode by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/105
  • +
  • Add watermark in email template by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/108
  • +
+

New Contributors

+
    +
  • @marcelosinnerworkings made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/95
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.1.2...0.1.3

+

[0.1.2]

+
    +
  • Integração com o portal INLABS, da Imprensa Nacional, permitindo a leitura das edições do DOU pelos arquivos XML
  • +
  • Remove dependências com o framework FastETL
  • +
  • Cria filtro de pesquisa por unidade (department)
  • +
  • Cria opção de exibição de texto completo da publicação
  • +
  • Cria opção de busca avançada usando operadores lógicos (INLABS)
  • +
  • Implementa a opção de múltiplos searchs no mesmo YAML
  • +
  • Cria opção para omitir metadados (hide_filter) no relatório do clipping
  • +
  • Cria opção para permitir inclusão de cabeçalho e rodapé no corpo do relatório
  • +
  • Formata o texto para modo justificado
  • +
+

What's Changed

+
    +
  • Move DOUhook from FastETL to Ro-dou src by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/66
  • +
  • Validate yaml by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/75
  • +
  • Create filter for department by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/77
  • +
  • change exact search to consider special characters by @gutaors in https://github.com/gestaogovbr/Ro-dou/pull/80
  • +
  • Inlabs db by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/81
  • +
  • add full_text option by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/82
  • +
  • Implement search with logical operators by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/85
  • +
  • Implement subsearchs by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/87
  • +
  • Fix select_terms_from_db bug by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/88
  • +
  • Create param hide_filter by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/90
  • +
  • Hide filters for slack and discord by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/91
  • +
  • Add Header and footer text by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/93
  • +
  • Justify text in email report by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/94
  • +
+

New Contributors

+
    +
  • @gutaors made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/80
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.1.1...0.1.2

+

[0.1.1]

+

What's Changed

+

fix css file access

+

[0.1.0] - 2023-08-31

+

Altera a forma de encontrar os arquivos de configuração das DAGs (dag_confs/*.yml).

+

Antes considerava que a pasta dag_confs/ estava na mesma raiz que os arquivos do ro-dou em ./src. Agora o caminho da(s) pasta(s) deve ser informado pela variável de ambiente RO_DOU__DAG_CONF_DIR e separado por : quando mais de um.

+

Exemplo:

+

As pastas /opt/airflow/dags/repo1/dag_confs e /opt/airflow/dags/repo2/dag_confs possuem arquivos de configuração (yaml) para geração das DAGs do rodou. A variável de ambiente RO_DOU__DAG_CONF_DIR deve ser atribuída assim:

+
RO_DOU__DAG_CONF_DIR=/opt/airflow/dags/repo1/dag_confs:/opt/airflow/dags/repo2/dag_confs
+
+

Esta alteração permite que os arquivos de configuração das DAGs (dag_confs/*.yml) estejam em qualquer pasta da máquina ou container.

+

What's Changed

+
    +
  • Change name organization economia to gestao by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/60
  • +
  • change dag_confs search by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/62
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/compare/0.0.7...0.1.0

+

[0.0.7] 2023-04-27

+

What's Changed

+
    +
  • fix workflow docker build publish
  • +
+

[0.0.6] 2023-04-27

+

What's Changed

+
    +
  • fix workflow docker build publish
  • +
+

[0.0.5] 2023-04-27

+

What's Changed

+
    +
  • fix workflow docker build publish
  • +
+

[0.0.4] 2023-04-27

+

What's Changed

+
    +
  • fix workflow docker build publish
  • +
+

[0.0.3] 2023-04-27

+

What's Changed

+
    +
  • fix workflow docker build publish
  • +
+

[0.0.2] 2023-04-25

+

What's Changed

+
    +
  • Conjunto de mudanças para v.1 by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/4
  • +
  • Cria resiliência na chamada da API do DOU by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/5
  • +
  • Cria opção de pesquisa no Querido Diário by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/14
  • +
  • Trigger date horario local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/17
  • +
  • altera template de data do título do email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/18
  • +
  • Incluir serviço do selenium no docker-compose.yml by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/22
  • +
  • Adiciona tentativas de execução na função search_text_with_retry by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/23
  • +
  • Criar parâmetro para enviar email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/24
  • +
  • Make tests run in colored output by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/25
  • +
  • Implementa feature de documentação markdown e informações úteis by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/31
  • +
  • Add documentation and separate tests for DAG Docs by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/34
  • +
  • Fix spelling in "links" by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/35
  • +
  • Fix searching terms read from database by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/39
  • +
  • remove selenium from Ro-dou by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/40
  • +
  • Mount as a volume only the modules used by Ro-DOU by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/44
  • +
  • Upgrade actions/checkout to v3 in CI by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/47
  • +
  • [dou_dag_generator] enables to find ro_dou folder inside airflow dags… by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/49
  • +
  • Decouple this project from the airflow2-docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/51
  • +
  • Bundle src code and plugin into docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/53
  • +
  • [WIP] Discord Integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/50
  • +
  • Workflow to build and publish docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/54
  • +
  • update fastetl import by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/56
  • +
  • Slack integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/58
  • +
+

New Contributors

+
    +
  • @nitaibezerra made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/4
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/commits/0.0.2

+

[0.0.1] 2023-04-25

+

What's Changed

+
    +
  • Conjunto de mudanças para v.1 by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/4
  • +
  • Cria resiliência na chamada da API do DOU by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/5
  • +
  • Cria opção de pesquisa no Querido Diário by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/14
  • +
  • Trigger date horario local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/17
  • +
  • altera template de data do título do email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/18
  • +
  • Incluir serviço do selenium no docker-compose.yml by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/22
  • +
  • Adiciona tentativas de execução na função search_text_with_retry by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/23
  • +
  • Criar parâmetro para enviar email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/24
  • +
  • Make tests run in colored output by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/25
  • +
  • Implementa feature de documentação markdown e informações úteis by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/31
  • +
  • Add documentation and separate tests for DAG Docs by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/34
  • +
  • Fix spelling in "links" by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/35
  • +
  • Fix searching terms read from database by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/39
  • +
  • remove selenium from Ro-dou by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/40
  • +
  • Mount as a volume only the modules used by Ro-DOU by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/44
  • +
  • Upgrade actions/checkout to v3 in CI by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/47
  • +
  • [dou_dag_generator] enables to find ro_dou folder inside airflow dags… by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/49
  • +
  • Decouple this project from the airflow2-docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/51
  • +
  • Bundle src code and plugin into docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/53
  • +
  • [WIP] Discord Integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/50
  • +
  • Workflow to build and publish docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/54
  • +
  • update fastetl import by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/56
  • +
  • Slack integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/58
  • +
+

New Contributors

+
    +
  • @nitaibezerra made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/4
  • +
+

Full Changelog: https://github.com/gestaogovbr/Ro-dou/commits/0.0.1

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + +
+ + + + + + + + + diff --git a/como_contribuir/contribuicoes/index.html b/como_contribuir/contribuicoes/index.html new file mode 100644 index 0000000..77f7f38 --- /dev/null +++ b/como_contribuir/contribuicoes/index.html @@ -0,0 +1,177 @@ + + + + + + + + Contribuições - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Como contribuir

+

Os arquivos do projeto Ro-DOU são disponibilizados publicamente no perfil GitHub do Ministério da Gestão e da Inovação em Serviços Públicos e podem ser acessados clicando aqui.

+

Contribuições externas ao projeto são bem-vindas. Para sugerir melhorias, abra uma issue via GitHub. A issue será avaliada assim que possível pela equipe da SEGES/MGI.

+

Caso deseje expressar outros comentários, críticas, dúvidas ou sugestões, contate-nos.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/exemplos/index.html b/como_funciona/exemplos/index.html new file mode 100644 index 0000000..a7b15a4 --- /dev/null +++ b/como_funciona/exemplos/index.html @@ -0,0 +1,459 @@ + + + + + + + + Exemplos - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Exemplos de configuração do arquivo YAML

+

Neste segmento, você encontrará uma série de exemplos práticos de utilização do Ro-DOU. A leitura dos exemplos ajudará a visualizar de que maneira o Ro-DOU pode ser utilizado.

+

Exemplo 1

+

A configuração a seguir cria uma DAG que realiza a pesquisa diária dos +6 termos listados e envia o relatório para o e-mail fornecido.

+
dag:
+  id: pesquisa_dou_termos_interesse_nitai
+  description: Pesquisa termos de interesse de Nitai.
+  search:
+    terms:
+      - dados abertos
+      - governo aberto
+      - engenharia de dados
+      - software livre
+      - código aberto
+      - open source
+  report:
+    emails:
+      - endereco@dominio.com
+
+

Exemplo 2

+

A configuração a seguir realiza a pesquisa diária de segunda-feira a sexta-feira, 8AM, apenas na Seção 1 e na Edição Suplementar e envia o resultado em formato CSV, anexado ao e-mail. O parâmetro schedule +aceita valores CRON.

+
dag:
+  id: dag_id_deve_ser_unico_em_todo_airflow
+  description: DAG exemplo de monitoramento no DOU.
+  schedule: 0 8 * * MON-FRI
+  search:
+    terms:
+      - alocação
+      - realoca
+      - permuta
+      - estrutura regimental
+      - organização básica
+    dou_sections:
+      - SECAO_1
+      - EDICAO_SUPLEMENTAR
+  report:
+    emails:
+      - dest1@gestao.gov.br
+      - dest2@gestao.gov.br
+    attach_csv: True
+    subject: Assunto do Email
+
+

Note que aqui são utilizados os parâmetros opcionais schedule, +dou_section e attach_csv.

+

Exemplo 3

+

A configuração a seguir utiliza o parâmetro from_db_select em terms, que torna dinâmica a parametrização dos termos para pesquisa. Note também a inclusão de tags que ajudam na organização e na busca das DAGs no Airflow.

+
dag:
+  id: dag_ultra_dinamica
+  description: A pesquisa depende do select SQL.
+  tags:
+    - projeto_a
+    - departamento_x
+  search:
+    terms:
+      from_db_select:
+        sql: SELECT text FROM schema.tabela;
+        conn_id: airflow_conn_id
+  report:
+    emails:
+      - email-destino@gestao.gov.br
+    subject: "[String] com caracteres especiais deve estar entre aspas"
+
+

Exemplo 4

+

A configuração a seguir utiliza o parâmetro from_airflow_variable em terms, que também carrega dinamicamente a lista de termos. Neste caso, há a recuperação a partir de uma variável do Airflow. Aqui, também é utilizado o campo field para limitar as pesquisas ao campo título das publicações no Diário Oficial da União.

+
dag:
+  id: pesquisa_a_lista_na_variavel
+  description: É fácil editar a variável na interface do Airflow.
+  search:
+    terms:
+      from_airflow_variable: nome_da_variavel_no_airflow
+    field: TITULO
+  report:
+    emails:
+      - email-destino@gestao.gov.br
+    skip_null: False
+
+

Caso não encontre nenhum resultado, será enviado um e-mail informando que +nenhum termo foi encontrado.

+

Exemplo 5

+

A configuração a seguir produz uma DAG que executa apenas uma vez por mês, no dia 1 às 8 AM, como pode ser visto no schedule. Simultaneamente, a pesquisa no Diário Oficial da União é realizada nos diários oficiais do último mês inteiro, através do uso do parâmetro date. Aqui, também é utilizado o parâmetro is_exact_search +com valor False para utilizar uma pesquisa aproximada.

+

Apesar do fato de que o termo buscado "paralelpipido" contenha um erro ortográfico, a busca retorna os resultados corretos. Veja!

+
dag:
+  id: relatorio_mensal_do_dou
+  description: Envia um numero menor de emails.
+  schedule: 0 8 1 * *
+  search:
+    terms:
+      - paralelpipido
+    date: MES
+    is_exact_search: False
+  report:
+    emails:
+      - email-destino@gestao.gov.br
+
+

Exemplo 6

+

A configuração a seguir produz uma DAG que pesquisa no Querido Diário pelos termos "pandemia", "dados pessoais" e "prefeitura", buscando apenas os resultados do Diário Oficial de Belo Horizonte. Para conhecer o Querido Diário, acesse +https://queridodiario.ok.org.br/.

+
dag:
+  id: dou_qd_example
+  description: DAG de teste
+  search:
+    sources:
+    - QD
+    territory_id: 3106200 # Belo Horizonte
+    terms:
+    - pandemia
+    - dados pessoais
+    - prefeitura
+  report:
+    emails:
+      - destination@gestao.gov.br
+    attach_csv: True
+    subject: "Teste do Ro-dou"
+
+

Exemplo 7

+

A configuração a seguir produz uma DAG exatamente igual ao exemplo básico, mas adiciona uma descrição longa do que a DAG faz, usando o parâmetro +doc_md. Essa descrição pode conter formatação markdown, incluindo +títulos, listas, links etc.

+

Além disso, acrescenta também uma referência ao nome do arquivo que +gerou a DAG, bem como os seus parâmetros.

+
dag:
+  id: markdown_docs_example
+  description: DAG com documentação em markdown
+  search:
+    terms:
+    - dados abertos
+    - governo aberto
+    - lei de acesso à informação
+  report:
+    emails:
+      - destination@gestao.gov.br
+    subject: "Teste do Ro-dou"
+  doc_md: >-
+    ## Ola!
+
+    Esta é uma DAG de exemplo com documentação em markdown. Esta
+    descrição é opcional e pode ser definida no parâmetro `doc_md`.
+
+      * Ah, aqui você também pode usar *markdown* para
+      * escrever listas, por exemplo,
+      * ou colocar [links](graph)!
+
+

Para ver essa documentação, basta clicar o botão "DAG Docs" em qualquer +tela de visualização da DAG no Airflow.

+

Botão "DAG Docs". Captura de tela da documentação de DAG no Airflow.

+

Exemplo 8

+

Esta configuração envia as notificações para canais Discord. É necessário ter +permissões de administrador no Discord para gerar o Webhook:

+
dag:
+  id: discord_example
+  description: Envia notificações para canal Discord
+  search:
+    terms:
+    - manifestação cultural
+    - expressão cultural
+    - política cultural
+  report:
+    report:
+    discord:
+      webhook: https://discord.com/api/webhooks/105220xxxxxx811250/Q-XsfdnoHtudTQ-8A6zzzzznitai-vi0bGLE7xxxxxxxxxxxxxxxxxxxmx94R3oZ1h0ngl1
+
+

Exemplo 9

+

Esta configuração envia as notificações para canais Slack. É necessário ter +permissões de administrador no Slack para gerar o Webhook:

+
dag:
+  id: slack_example
+  description: Envia notificações para canal Slack
+  search:
+    terms:
+    - manifestação cultural
+    - expressão cultural
+    - política cultural
+  report:
+    report:
+    slack:
+      webhook: https://hooks.slack.com/services/XXXXXXXX/XXXXNFDXXX/n6QXXXXrPwxQ71ZXXXXXT9
+
+

Exemplo 10

+

Esta configuração filtra os resultados por órgão/unidade selecionados. +Por enquanto disponível apenas para as pesquisas no DOU.

+
dag:
+  id: department_example
+  description: DAG de teste (filtro por departamento)
+  search:
+    terms:
+      - dados abertos
+    department:
+      - Ministério da Gestão e da Inovação em Serviços Públicos
+      - Ministério da Defesa
+  report:
+    emails:
+      - destination@gestao.gov.br
+    subject: "Teste do Ro-dou"
+
+

Exemplo 11

+

Esta configuração permite múltiplas buscas utilizando o mesmo arquivo. +O Ro-dou permite numa mesma busca juntar resultados do DOU e Querido Diário.

+
dag:
+  id: multiple_searchs_example
+  description: DAG de teste com múltiplas buscas
+  search:
+    - header: "Pesquisa no DOU"
+      sources:
+        - DOU
+      terms:
+        - dados abertos
+        - governo aberto
+        - lei de acesso à informação
+      force_rematch: On
+      ignore_signature_match: On
+    - header: "Pesquisa no QD"
+      sources:
+        - QD
+      terms:
+        - dados abertos
+        - governo aberto
+        - lei de acesso à informação
+      force_rematch: On
+      ignore_signature_match: On
+    - header: "Pesquisa no DOU e QD (misto)"
+      sources:
+        - DOU
+        - QD
+      terms:
+        - dados abertos
+        - governo aberto
+        - lei de acesso à informação
+      force_rematch: On
+      ignore_signature_match: On
+  report:
+    emails:
+      - destination@gestao.gov.br
+    subject: "Teste do Ro-dou"
+
+

Exemplo 12

+

Esta configuração filtra os resultados por tipos de publicações selecionadas. +Disponível para as pesquisas no DOU e INLABS.

+
dag:
+  id: pubtype_example
+  description: DAG de teste (filtro por tipo de publicação)
+  search:
+    sources:
+      - DOU
+    terms:
+      - programa
+    pubtype:
+      - Ato
+      - Portaria
+      - Edital
+      - Extrato
+      - Ratificação
+      - Resolução
+      - Retificação
+      - Protocolo
+  report:
+    emails:
+      - destination@gestao.gov.br
+    subject: "Teste do Ro-dou"
+
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/intro_funcionamento/index.html b/como_funciona/intro_funcionamento/index.html new file mode 100644 index 0000000..877824d --- /dev/null +++ b/como_funciona/intro_funcionamento/index.html @@ -0,0 +1,181 @@ + + + + + + + + Introdução - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Como funciona

+

Nesta seção, você encontrará as seguintes informações sobre o Ro-DOU:

+
    +
  • Compreendendo melhor a pesquisa no Diário Oficial da União
  • +
  • Recursos e funcionalidades
  • +
  • Parâmetros de pesquisa disponíveis
  • +
  • Exemplos de configuração do arquivo YAML
  • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/operadores/index.html b/como_funciona/operadores/index.html new file mode 100644 index 0000000..04199df --- /dev/null +++ b/como_funciona/operadores/index.html @@ -0,0 +1,201 @@ + + + + + + + + Operadores de pesquisa avançada - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Operadores de Pesquisa Avançada

+

Os seguintes operadores de pesquisa avançada no Ro-DOU podem ser configurados nos arquivos YAML:

+
    +
  • & : Equivalente ao operador lógico and (conjunção "e").
  • +
  • | : Equivalente ao operador lógico or (conjunção "ou").
  • +
  • ! : Equivalente ao operador lógico not (negação).
  • +
+

O exemplo abaixo demonstra, na prática, como tais operadores podem ser utilizados no Ro-DOU:

+
dag:
+  id: inlabs_advanced_search_example
+  description: DAG de teste
+  tags:
+    - inlabs
+  schedule: 0 8 * * MON-FRI
+  owner:
+    - cdata
+  search:
+    sources:
+    - INLABS
+    terms:
+    - designar & ( MGI | MINISTÉRIO FAZENDA)
+    - instituto & federal ! paraná
+  report:
+    emails:
+      - destination@economia.gov.br
+    attach_csv: True
+    subject: "Teste do Ro-dou"
+
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/parametros/index.html b/como_funciona/parametros/index.html new file mode 100644 index 0000000..d33c417 --- /dev/null +++ b/como_funciona/parametros/index.html @@ -0,0 +1,222 @@ + + + + + + + + Parâmetros de pesquisa - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Parâmetros de pesquisa disponíveis

+

A página abaixo lista os parâmetros configuráveis nos arquivos YAML:

+

Parâmetros da DAG

+
    +
  • id: Nome identificador da DAG a ser gerada.
  • +
  • description: Descrição da DAG de pesquisa.
  • +
  • doc_md: Documentação em markdown da DAG para uma descrição mais completa.
  • +
  • schedule: Agendamento da periodicidade de execução da DAG. Padrão cron (0 8 * * MON-FRI)
  • +
  • dataset: Agendamento da DAG baseado na atualização de um Dataset do Airflow. Em conjunto com o schedule a execução é condicionada ao schedule e dataset.
  • +
  • tags: Tags para categorizar a DAG.
  • +
  • owner: Responsável pela DAG.
  • +
+ +
    +
  • search: Pode ser uma ou uma lista de pesquisas.
  • +
  • date: Intervalo de data para busca. Valores: DIA, SEMANA, MES, ANO. Default: DIA
  • +
  • department: Lista de unidades a serem filtradas na busca. O nome deve ser idêntico ao da publicação.
  • +
  • dou_sections: Lista de seções do DOU onde a busca deverá ser realizada. Valores aceitos: SECAO_1, SECAO_2, SECAO_3, EDICAO_EXTRA, EDICAO_SUPLEMENTAR, TODOS.
  • +
  • field: Campos dos quais os termos devem ser pesquisados. Valores: TUDO, TITULO, CONTEUDO. Default: TUDO
  • +
  • force_rematch: Indica que a busca deve ser forçada, mesmo que já tenha sido feita anteriormente. Valores: True ou False.
  • +
  • full_text: Define se no relatório será exibido o texto completo, ao invés de um resumo. Valores: True ou False. Default: False. (Funcionalidade disponível apenas no INLABS)
  • +
  • use_summary: Define se no relatório será exibido a ementa, se existir. Valores: True ou False. Default: False. (Funcionalidade disponível apenas no INLABS)
  • +
  • ignore_signature_match: Ignora a correspondência de assinatura ao realizar a busca. Valores: True ou False. Default: False.
  • +
  • is_exact_search: Busca somente o termo exato. Valores: True ou False. Default: True.
  • +
  • pubtype: Lista de tipos de publicações a serem filtradas na busca. Valores: Lista de tipos de publicações.
  • +
  • sources: Fontes de pesquisa dos diários oficiais. Pode ser uma ou uma lista. Opções disponíveis: DOU, QD, INLABS.
  • +
  • terms: Lista de termos a serem buscados. Para o INLABS podem ser utilizados operadores avançados de busca.
  • +
  • territory_id: Lista de identificadores do id do município. Necessário para buscar no Querido Diário.
  • +
+

Parâmetros do Relatório (Report)

+
    +
  • attach_csv: Anexar no email o resultado da pesquisa em CSV.
  • +
  • discord_webhook: URL de Webhook para integração com o Discord.
  • +
  • emails: Lista de emails dos destinatários.
  • +
  • footer_text: Texto em HTML do rodapé do relatório.
  • +
  • header_text: Texto em HTML de cabeçalho do relatório.
  • +
  • hide_filters: Omite no relatório os filtros de pesquisa.
  • +
  • no_results_found_text: Texto padrão para quando não há resultados encontrados. Default: Nenhum dos termos pesquisados foi encontrado nesta consulta.
  • +
  • report: Parâmetros de notificação de relatório.
  • +
  • skip_null: Dispensa o envio de email quando não há resultados encontrados em todas as pesquisas. Valores: True ou False. Default: True.
  • +
  • slack_webhook: URL de Webhook para integração com o Slack.
  • +
  • subject: Texto de assunto do email.
  • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/pesquisa_dou/index.html b/como_funciona/pesquisa_dou/index.html new file mode 100644 index 0000000..2a60d02 --- /dev/null +++ b/como_funciona/pesquisa_dou/index.html @@ -0,0 +1,177 @@ + + + + + + + + Compreendendo a pesquisa no D.O.U. - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Compreendendo melhor a pesquisa no Diário Oficial da União

+

Todos os parâmetros disponíveis para pesquisa no Diário Oficial da União (DOU) foram criados a partir da API da Imprensa Nacional, que por sua vez é utilizada pelo buscador oficial do DOU em https://www.in.gov.br/consulta/.

+

Assim, é possível notar que o Ro-DOU consegue automatizar todo, ou quase todo, tipo de pesquisa que pode ser feita no site do Diário Oficial da União. A imagem abaixo é o painel de pesquisa avançada do site:

+

Captura de tela do painel de pesquisa avançada no site do DOU.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/recursos_funcionalidades/index.html b/como_funciona/recursos_funcionalidades/index.html new file mode 100644 index 0000000..64fcc94 --- /dev/null +++ b/como_funciona/recursos_funcionalidades/index.html @@ -0,0 +1,182 @@ + + + + + + + + Recursos e funcionalidades - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Recursos e funcionalidades

+

O Ro-DOU possui os seguintes recursos e funcionalidades voltados aos usuários:

+
    +
  • Resultados com frequências diária, semanal ou mensal;
  • +
  • Relatórios em formato .CSV para facilitação do uso;
  • +
  • Busca dinâmica das palavras-chaves de um banco de dados ou de uma variável;
  • +
  • Pesquisa em seção específica do diário oficial;
  • +
  • Envio de notificações para os canais existentes no Discord e no Slack.
  • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_funciona/tipos_de_publicacoes/index.html b/como_funciona/tipos_de_publicacoes/index.html new file mode 100644 index 0000000..867d2e9 --- /dev/null +++ b/como_funciona/tipos_de_publicacoes/index.html @@ -0,0 +1,394 @@ + + + + + + + + Tipos de publicacoes - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +

Tipos de publicações (parâmetro pubtype)

+
    +
  • Ação Direta de Inconstitucionalidade e Ação Declaratória de Constitucionalidade
  • +
  • Acórdão
  • +
  • Acordo Coletivo de Trabalho
  • +
  • Ajuste
  • +
  • Alvará
  • +
  • Aresto
  • +
  • Ata
  • +
  • Ato
  • +
  • Ato Complementar
  • +
  • Ato Concessório
  • +
  • Ato Declaratório
  • +
  • Ato Declaratório Conjunto
  • +
  • Ato Normativo
  • +
  • Ato Regimental
  • +
  • Ato Regulamentar
  • +
  • Auto de Infração
  • +
  • Autorização
  • +
  • Aviso
  • +
  • Aviso aos Acionistas
  • +
  • Aviso de Adiamento
  • +
  • Aviso de Adjudicação
  • +
  • Aviso de Alienação
  • +
  • Aviso de Alteração
  • +
  • Aviso de Alteração de Resultado de Habilitação
  • +
  • Aviso de Anulação
  • +
  • Aviso de Audiência Pública
  • +
  • Aviso de Cadastramento
  • +
  • Aviso de Cancelamento
  • +
  • Aviso de Cancelamento de Termo Aditivo
  • +
  • Aviso de Chamamento Público
  • +
  • Aviso de Coleta de Preços
  • +
  • Aviso de Consulta Pública
  • +
  • Aviso de Convalidação
  • +
  • Aviso de Credenciamento
  • +
  • Aviso de Dispensa de Licitação
  • +
  • Aviso de Eleição
  • +
  • Aviso de Extravio
  • +
  • Aviso de Fato Relevante
  • +
  • Aviso de Habilitação
  • +
  • Aviso de Homologação
  • +
  • Aviso de Homologação e Adjudicação
  • +
  • Aviso de Índice Técnico
  • +
  • Aviso de Inexigibilidade de Licitação
  • +
  • Aviso de Julgamento
  • +
  • Aviso de Licença
  • +
  • Aviso de Licitação
  • +
  • Aviso de Licitação-Concorrência
  • +
  • Aviso de Licitação-Convite
  • +
  • Aviso de Licitação Deserta
  • +
  • Aviso de Licitação-Leilão
  • +
  • Aviso de Licitação-Pregão
  • +
  • Aviso de Licitação-RDC Eletrônico
  • +
  • Aviso de Licitação-RDC Presencial
  • +
  • Aviso de Licitação-Registro de Preços
  • +
  • Aviso de Licitação-Tomada de Preços
  • +
  • Aviso de Nota Técnica
  • +
  • Aviso de Padronização
  • +
  • Aviso de Penalidade
  • +
  • Aviso de Preços Registrados
  • +
  • Aviso de Pré-Qualificação
  • +
  • Aviso de Processo Seletivo
  • +
  • Aviso de Proposta Comercial
  • +
  • Aviso de Proposta Técnica
  • +
  • Aviso de Prorrogação
  • +
  • Aviso de Reabertura de Prazo
  • +
  • Aviso de Registro de Chapas
  • +
  • Aviso de Registro de Diplomas
  • +
  • Aviso de Registro de Preços
  • +
  • Aviso de Relação de Compras
  • +
  • Aviso de Rescisão
  • +
  • Aviso de Retificação
  • +
  • Aviso de Revogação
  • +
  • Aviso de Seleção
  • +
  • Aviso de Serviço e Compra
  • +
  • Aviso de Sorteio
  • +
  • Aviso de Suspensão
  • +
  • Aviso de Tomada de Subsídios
  • +
  • Balancete
  • +
  • Balancete Financeiro
  • +
  • Balancete Patrimonial e Financeiro
  • +
  • Balanço Patrimonial
  • +
  • Balanço Social
  • +
  • Certidão
  • +
  • Circular
  • +
  • Comunicado
  • +
  • Consulta Pública
  • +
  • Contrato de Gestão
  • +
  • Convênio
  • +
  • Decisão
  • +
  • Decreto de Pessoal
  • +
  • Decreto Legislativo
  • +
  • Decreto não numerado
  • +
  • Decreto numerado
  • +
  • Deliberação
  • +
  • Demonstração Contábil
  • +
  • Despacho
  • +
  • Despacho Interministerial
  • +
  • Edital
  • +
  • Edital da Justiça Gratuita (Art. 32 Portaria 268/2009-IN)
  • +
  • Edital de Citação
  • +
  • Edital de Concurso Público
  • +
  • Edital de Convocação
  • +
  • Edital de Credenciamento
  • +
  • Edital de Intimação
  • +
  • Edital de Leilão
  • +
  • Edital de Notificação
  • +
  • Edital de Processo Seletivo
  • +
  • Edital de Vestibular
  • +
  • Emenda
  • +
  • Emenda Constitucional
  • +
  • Estatuto
  • +
  • Extrato
  • +
  • Extrato da Ata
  • +
  • Extrato de Acordo de Cooperação
  • +
  • Extrato de Acordo de Cooperação Federativa
  • +
  • Extrato de Acordo de Cooperação Técnica
  • +
  • Extrato de Adesão
  • +
  • Extrato de Ajuste
  • +
  • Extrato de Apostilamento
  • +
  • Extrato de Autorização de Fornecimento de Material
  • +
  • Extrato de Autorização de Serviço
  • +
  • Extrato de Autorização de Uso
  • +
  • Extrato de Carta Contrato
  • +
  • Extrato de Carta Reversal
  • +
  • Extrato de Cessão
  • +
  • Extrato de Cessão de Uso
  • +
  • Extrato de Comodato
  • +
  • Extrato de Compromisso
  • +
  • Extrato de Concessão de Uso
  • +
  • Extrato de Contrato
  • +
  • Extrato de Convênio
  • +
  • Extrato de Cooperação Mútua
  • +
  • Extrato de Credenciamento
  • +
  • Extrato de Denúncia
  • +
  • Extrato de Depósito
  • +
  • Extrato de Dispensa de Chamamento Público
  • +
  • Extrato de Dispensa de Licitação
  • +
  • Extrato de Distrato
  • +
  • Extrato de Doação
  • +
  • Extrato de Escritura de Compra e Venda
  • +
  • Extrato de Extinção (Lei nº 8.745 - contratação temporária)
  • +
  • Extrato de Fornecimento
  • +
  • Extrato de Inexigibilidade de Licitação
  • +
  • Extrato de Instrumento Convocatório
  • +
  • Extrato de Instrumentos Contratuais
  • +
  • Extrato de Memorando de Entendimento
  • +
  • Extrato de Nota de Empenho
  • +
  • Extrato de Ordem de Compra
  • +
  • Extrato de Ordem de Execução de Serviço
  • +
  • Extrato de Ordem de Fornecimento
  • +
  • Extrato de Parceria
  • +
  • Extrato de Parecer Técnico
  • +
  • Extrato de Permissão de Uso
  • +
  • Extrato de Permuta
  • +
  • Extrato de Prorrogação de Ofício
  • +
  • Extrato de Protocolo de Cooperação
  • +
  • Extrato de Protocolo de Intenção
  • +
  • Extrato de Recolhimento
  • +
  • Extrato de Reconhecimento
  • +
  • Extrato de Reconhecimento de Dívida
  • +
  • Extrato de Registro de Preços
  • +
  • Extrato de Rerratificação
  • +
  • Extrato de Rescisão
  • +
  • Extrato de Rescisão Contratual
  • +
  • Extrato de Resilição
  • +
  • Extrato de Sub-rogação
  • +
  • Extrato de Termo Aditivo
  • +
  • Extrato de Termo de Ajustamento de Conduta
  • +
  • Extrato de Termo de Cooperação Técnica
  • +
  • Extrato de Termo de Entrega
  • +
  • Extrato de Termo de Execução de Projeto
  • +
  • Extrato de Termo de Execução Descentralizada
  • +
  • Extrato de Termo de Fomento
  • +
  • Extrato de Termo de Ocupação de Imóvel
  • +
  • Extrato de Termo de Parceria
  • +
  • Extrato de Transferência de Posse
  • +
  • Extrato Prévio
  • +
  • Fato Relevante
  • +
  • Instrução
  • +
  • Instrução Normativa
  • +
  • Instrução Normativa Conjunta
  • +
  • Lei
  • +
  • Lei Complementar
  • +
  • Lista de Antiguidade
  • +
  • Medida Provisória
  • +
  • Memorando de Entendimento
  • +
  • Mensagem
  • +
  • Norma Complementar
  • +
  • Ofício circular
  • +
  • Ordem de Serviço
  • +
  • Orientação Normativa
  • +
  • Pacto
  • +
  • Parecer Normativo
  • +
  • Pauta
  • +
  • Portaria
  • +
  • Portaria Conjunta
  • +
  • Portaria Intergovernamental
  • +
  • Portaria Interministerial
  • +
  • Processo Disciplinar
  • +
  • Proposta Orçamentária
  • +
  • Protocolo
  • +
  • Protocolo de Intenções
  • +
  • Provimento
  • +
  • Ratificação
  • +
  • Recomendação
  • +
  • Recurso Disciplinar
  • +
  • Relatórios
  • +
  • Republicação
  • +
  • Resolução
  • +
  • Resolução do Senado Federal
  • +
  • Resultado de Análise
  • +
  • Resultado de Avaliação Técnica
  • +
  • Resultado de Cadastramento
  • +
  • Resultado de Concurso Público
  • +
  • Resultado de Eleição
  • +
  • Resultado de Habilitação
  • +
  • Resultado de Índice Técnico
  • +
  • Resultado de Julgamento
  • +
  • Resultado de Julgamento de Licitação
  • +
  • Resultado de Leilão
  • +
  • Resultado de Proposta Técnica
  • +
  • Resultado de Qualificação
  • +
  • Retificação
  • +
  • Retificação (de Edital)
  • +
  • Solução de Consulta
  • +
  • Súmula
  • +
  • Súmula Administrativa
  • +
  • Termo de Autorização
  • +
  • Termo de Liberação de Operação
  • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + + diff --git a/como_utilizar/instalacao/index.html b/como_utilizar/instalacao/index.html new file mode 100644 index 0000000..792f95a --- /dev/null +++ b/como_utilizar/instalacao/index.html @@ -0,0 +1,215 @@ + + + + + + + + Instalação e configuração - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Instalação e configuração

+

Configurando o ambiente local 'Hello World'

+

O código-fonte está disponibilizado no perfil do GitHub do Ministério da Gestão e da Inovação em Serviços Públicos.

+

Neste título, fornecemos abaixo uma configuração demonstrativa para que você possa executar o Ro-DOU no seu computador. Para isso, é necessário ter o Docker Compose na versão 1.29 ou maior instalado. Os passos para a instalação estão disponíveis em https://docs.docker.com/compose/install/ ou em tutoriais no YouTube.

+

Após clonar o repositório do Ro-DOU para o seu computador com o comando git clone, acesse o diretório pelo terminal e execute os comandos a seguir:

+
make run
+
+

Este comando baixa as imagens Docker necessárias, efetua o build do container Docker do Ro-DOU e executa todos os demais passos necessários.

+

O Apache Airflow, que também é usado para rodar o Ro-DOU, pode demorar alguns minutos para se configurar na primeira vez. Posteriormente, ele estará disponível em http://localhost:8080/. Para se autenticar e acessar o Apache Airflow, entre no link e utilize login airflow e senha airflow.

+

Na página sobre o que é o Ro-DOU, explicamos o que é um grafo acíclico dirigido (DAG) do Airflow e como obter mais informações sobre este conceito.

+

Na tela inicial do Airflow, são fornecidos clippings de exemplo. A partir dos arquivos YAML (.yaml) do diretório dag_confs/, é possível manipular e customizar as pesquisas de clipping desejadas nos diários oficiais. Dentro dos arquivos YAML, é possível, por exemplo, definir palavras-chave de busca e um endereço de e-mail para recebimento de uma mensagem com os resultados da busca no(s) diário(s) oficial(is).

+

Para executar qualquer DAG do Airflow, é necessário ligá-la. Inicialmente, todas as DAGs ficam pausadas por padrão. Sugerimos começar testando o clipping all_parameters_example. Utilize o botão toggle para ligá-lo. Após ativá-lo, o Airflow executará a DAG uma única vez. Clique no nome da DAG +para visualizar o detalhe da execução.

+

Você observará que, tanto na visualização em árvore (Tree) como na visualização em Grafo (Graph) dentro do Apache Airflow, é possível constatar se houve algum resultado encontrado na API da Imprensa Nacional para os termos e demais parâmetros deste clipping. Se a tarefa chamada "send_report" estiver na cor verde, significa que foi encontrado um resultado e que uma mensagem de e-mail foi enviada para o endereço configurado no arquivo YAML.

+

Para visualizar a mensagem de e-mail, acesse o endereço http://localhost:5001/. Este é um serviço que simula uma caixa de e-mail (servidor SMTP) para fins de experimentação. Voilà!.

+

Lembre-se que o arquivo de configuração deste clipping está na pasta dag_confs/. Confira aqui no GitHub o conteúdo do arquivo YAML.

+

Agora, faremos um segundo teste: o clipping terms_from_variable, seguindo os mesmo passos. Neste caso, os termos pesquisados estão listados em uma variável do Airflow e podem ser modificados pela interface gráfica. Acesse no menu Admin >> Variables ou pela URL http://localhost:8080/variable/list/.

+

Leia a seção Configurando em Produção para instalar o Ro-dou utilizando um provedor SMTP real que enviará os e-mails para os destinatários verdadeiros.

+

Observação: Para utilizar o source: - INLABS, é necessário alterar a conexão inlabs_portal no Apache Airflow, apontando o usuário e senha de autenticação do portal. Um novo usuário pode ser cadastrado pelo portal INLABS. A DAG +que realiza o download dos arquivos do INLABS é a ro-dou_inlabs_load_pg.

+

Quando tiver terminado de utilizar o ambiente de teste do Ro-DOU, desligue-o por meio do seguinte comando:

+
make down
+
+

Configurando o ambiente de produção

+

Para utilizar o Ro-DOU em ambiente de produção, é necessário que o servidor tenha disponível um serviço SMTP que será utilizado pelo Apache Airflow para envio de mensagens de e-mail pela Internet. Siga os seguintes passos:

+
    +
  1. +

    Utilize as credenciais do serviço SMTP (host, usuário, senha, porta etc.) +para editar o arquivo docker-compose.yml, substituindo as variáveis referentes ao serviço SMTP, a exemplo de AIRFLOW__SMTP__SMTP_HOST.

    +
  2. +
  3. +

    Ao final do arquivo docker-compose.yml, remova as linhas que declaram o +serviço smtp4dev, uma vez que ele não será mais necessário.

    +
  4. +
+

Uma vez executados esses passos, basta agora inicializar o Ro-DOU por meio do comando:

+
make run
+
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_utilizar/intro_utilizacao/index.html b/como_utilizar/intro_utilizacao/index.html new file mode 100644 index 0000000..32c4720 --- /dev/null +++ b/como_utilizar/intro_utilizacao/index.html @@ -0,0 +1,181 @@ + + + + + + + + Introdução - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Como utilizar

+

Nesta seção, você encontrará as seguintes informações sobre o Ro-DOU:

+
    +
  • Instalação e configuração
  • +
  • Ambiente local e ambiente de produção
  • +
  • Usuários internos e externos ao Ministério da Gestão e da Inovação em Serviços Públicos
  • +
  • Notificação de erros na execução das DAGs do Apache Airflow
  • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_utilizar/notificacao_de_erros/index.html b/como_utilizar/notificacao_de_erros/index.html new file mode 100644 index 0000000..5398125 --- /dev/null +++ b/como_utilizar/notificacao_de_erros/index.html @@ -0,0 +1,189 @@ + + + + + + + + Notificação de erros - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Notificação de erros na execução das DAGs

+

É importante recordar que o Ro-DOU permite o envio de mensagens via Slack quando ocorre alguma falha na execução da DAG no Apache Airflow. Para usar essa funcionalidade, efetue as seguintes configurações:

+
    +
  1. +

    Criar o app no Slack conforme orientações do vídeo How to Add Slack Notifications to Your Airflow DAG's with Airflow Notifiers.

    +
  2. +
  3. +

    Criar uma conexão no Apache Airflow com a seguinte configuração:

    +
  4. +
  5. +

    Connection Id = slack_notify_rodou_dagrun

    +
  6. +
  7. Connection Type = Slack API
  8. +
  9. Description = {"channel": "nome-do-channel-para-mandar-mensagem"}
  10. +
  11. Slack API Token = obtido no passo 1
  12. +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/como_utilizar/usuarios/index.html b/como_utilizar/usuarios/index.html new file mode 100644 index 0000000..de6367b --- /dev/null +++ b/como_utilizar/usuarios/index.html @@ -0,0 +1,198 @@ + + + + + + + + Usuários internos e externos - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Usuários internos e externos

+

Usuários do Ministério da Gestão e da Inovação em Serviços Públicos

+

Para as unidades do Ministério da Gestão e da Inovação em Serviços Públicos que desejem solicitar a utilização de clippings via Ro-DOU, a Secretaria de Gestão e Inovação do MGI está disponível para auxiliá-las a configurar o serviço.

+

É preciso que a unidade interessada encaminhe as seguintes informações para o endereço seges.cginf@gestao.gov.br:

+
    +
  • texto do assunto do e-mail que conterá o relatório do Ro-DOU;
  • +
  • lista de termos (palavras-chaves) para a pesquisa, separadas linha a linha;
  • +
  • seção ou seções do DOU que deverá(ão) ser pesquisada(s);
  • +
  • inclusão ou exclusão da edição extra e/ou suplementar do DOU na pesquisa;
  • +
  • necessidade ou dispensa de que um arquivo de planilha .CSV seja anexado ao e-mail com os resultados;
  • +
  • interesse em receber o e-mail, mesmo se nenhum resultado da pesquisa no DOU for encontrado para um dia específico;
  • +
  • horário e dias da semana para realização da pesquisa e envio do relatório (por padrão, ocorre às 9h da manhã, de segunda-feira a sexta-feira); e
  • +
  • lista com os endereços de e-mail  que receberão o relatório do Ro-DOU.
  • +
+

Os termos de pesquisa devem ser registrados no Git ou em uma tabela no banco de dados? Depende.

+
    +
  • Se os termos de pesquisa são relativamente poucos e têm a expectativa de mudanças infrequentes, deixar no yaml (Git).
  • +
  • Se os termos de pesquisa são muito numerosos e têm a expectativa de mudarem constantemente, usar uma tabela no banco de dados. Assim, uma outra DAG ou processo pode manter essa tabela sempre atualizada, sem que nada precise mudar no Git.
  • +
+

Usuários externos (de fora do MGI)

+

Usuários de órgãos públicos que não sejam unidades do Ministério da Gestão e da Inovação em Serviços Públicos poderão enviar dúvidas ou comentários ao endereço seges.cginf@gestao.gov.br.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/css/fonts/Roboto-Slab-Bold.woff b/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/css/fonts/Roboto-Slab-Bold.woff2 b/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/css/fonts/Roboto-Slab-Regular.woff b/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/css/fonts/Roboto-Slab-Regular.woff2 b/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/css/fonts/fontawesome-webfont.eot b/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/css/fonts/fontawesome-webfont.eot differ diff --git a/css/fonts/fontawesome-webfont.svg b/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/css/fonts/fontawesome-webfont.ttf b/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/css/fonts/fontawesome-webfont.ttf differ diff --git a/css/fonts/fontawesome-webfont.woff b/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/css/fonts/fontawesome-webfont.woff differ diff --git a/css/fonts/fontawesome-webfont.woff2 b/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/css/fonts/fontawesome-webfont.woff2 differ diff --git a/css/fonts/lato-bold-italic.woff b/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/css/fonts/lato-bold-italic.woff differ diff --git a/css/fonts/lato-bold-italic.woff2 b/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/css/fonts/lato-bold-italic.woff2 differ diff --git a/css/fonts/lato-bold.woff b/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/css/fonts/lato-bold.woff differ diff --git a/css/fonts/lato-bold.woff2 b/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/css/fonts/lato-bold.woff2 differ diff --git a/css/fonts/lato-normal-italic.woff b/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/css/fonts/lato-normal-italic.woff differ diff --git a/css/fonts/lato-normal-italic.woff2 b/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/css/fonts/lato-normal-italic.woff2 differ diff --git a/css/fonts/lato-normal.woff b/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/css/fonts/lato-normal.woff differ diff --git a/css/fonts/lato-normal.woff2 b/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/css/fonts/lato-normal.woff2 differ diff --git a/css/theme.css b/css/theme.css new file mode 100644 index 0000000..ad77300 --- /dev/null +++ b/css/theme.css @@ -0,0 +1,13 @@ +/* + * This file is copied from the upstream ReadTheDocs Sphinx + * theme. To aid upgradability this file should *not* be edited. + * modifications we need should be included in theme_extra.css. + * + * https://github.com/readthedocs/sphinx_rtd_theme + */ + + /* sphinx_rtd_theme version 1.2.0 | MIT license */ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} diff --git a/css/theme_extra.css b/css/theme_extra.css new file mode 100644 index 0000000..ab0631a --- /dev/null +++ b/css/theme_extra.css @@ -0,0 +1,197 @@ +/* + * Wrap inline code samples otherwise they shoot of the side and + * can't be read at all. + * + * https://github.com/mkdocs/mkdocs/issues/313 + * https://github.com/mkdocs/mkdocs/issues/233 + * https://github.com/mkdocs/mkdocs/issues/834 + */ +.rst-content code { + white-space: pre-wrap; + word-wrap: break-word; + padding: 2px 5px; +} + +/** + * Make code blocks display as blocks and give them the appropriate + * font size and padding. + * + * https://github.com/mkdocs/mkdocs/issues/855 + * https://github.com/mkdocs/mkdocs/issues/834 + * https://github.com/mkdocs/mkdocs/issues/233 + */ +.rst-content pre code { + white-space: pre; + word-wrap: normal; + display: block; + padding: 12px; + font-size: 12px; +} + +/** + * Fix code colors + * + * https://github.com/mkdocs/mkdocs/issues/2027 + */ +.rst-content code { + color: #E74C3C; +} + +.rst-content pre code { + color: #000; + background: #f8f8f8; +} + +/* + * Fix link colors when the link text is inline code. + * + * https://github.com/mkdocs/mkdocs/issues/718 + */ +a code { + color: #2980B9; +} +a:hover code { + color: #3091d1; +} +a:visited code { + color: #9B59B6; +} + +/* + * The CSS classes from highlight.js seem to clash with the + * ReadTheDocs theme causing some code to be incorrectly made + * bold and italic. + * + * https://github.com/mkdocs/mkdocs/issues/411 + */ +pre .cs, pre .c { + font-weight: inherit; + font-style: inherit; +} + +/* + * Fix some issues with the theme and non-highlighted code + * samples. Without and highlighting styles attached the + * formatting is broken. + * + * https://github.com/mkdocs/mkdocs/issues/319 + */ +.rst-content .no-highlight { + display: block; + padding: 0.5em; + color: #333; +} + + +/* + * Additions specific to the search functionality provided by MkDocs + */ + +.search-results { + margin-top: 23px; +} + +.search-results article { + border-top: 1px solid #E1E4E5; + padding-top: 24px; +} + +.search-results article:first-child { + border-top: none; +} + +form .search-query { + width: 100%; + border-radius: 50px; + padding: 6px 12px; + border-color: #D1D4D5; +} + +/* + * Improve inline code blocks within admonitions. + * + * https://github.com/mkdocs/mkdocs/issues/656 + */ + .rst-content .admonition code { + color: #404040; + border: 1px solid #c7c9cb; + border: 1px solid rgba(0, 0, 0, 0.2); + background: #f8fbfd; + background: rgba(255, 255, 255, 0.7); +} + +/* + * Account for wide tables which go off the side. + * Override borders to avoid weirdness on narrow tables. + * + * https://github.com/mkdocs/mkdocs/issues/834 + * https://github.com/mkdocs/mkdocs/pull/1034 + */ +.rst-content .section .docutils { + width: 100%; + overflow: auto; + display: block; + border: none; +} + +td, th { + border: 1px solid #e1e4e5 !important; + border-collapse: collapse; +} + +/* + * Without the following amendments, the navigation in the theme will be + * slightly cut off. This is due to the fact that the .wy-nav-side has a + * padding-bottom of 2em, which must not necessarily align with the font-size of + * 90 % on the .rst-current-version container, combined with the padding of 12px + * above and below. These amendments fix this in two steps: First, make sure the + * .rst-current-version container has a fixed height of 40px, achieved using + * line-height, and then applying a padding-bottom of 40px to this container. In + * a second step, the items within that container are re-aligned using flexbox. + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ + .wy-nav-side { + padding-bottom: 40px; +} + +/* For section-index only */ +.wy-menu-vertical .current-section p { + background-color: #e3e3e3; + color: #404040; +} + +/* + * The second step of above amendment: Here we make sure the items are aligned + * correctly within the .rst-current-version container. Using flexbox, we + * achieve it in such a way that it will look like the following: + * + * [No repo_name] + * Next >> // On the first page + * << Previous Next >> // On all subsequent pages + * + * [With repo_name] + * Next >> // On the first page + * << Previous Next >> // On all subsequent pages + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ +.rst-versions .rst-current-version { + padding: 0 12px; + display: flex; + font-size: initial; + justify-content: space-between; + align-items: center; + line-height: 40px; +} + +/* + * Please note that this amendment also involves removing certain inline-styles + * from the file ./mkdocs/themes/readthedocs/versions.html. + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ +.rst-current-version span { + flex: 1; + text-align: center; +} diff --git a/definicao/rodou/index.html b/definicao/rodou/index.html new file mode 100644 index 0000000..dd326a9 --- /dev/null +++ b/definicao/rodou/index.html @@ -0,0 +1,190 @@ + + + + + + + + O que é Ro-DOU? - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +

O que é Ro-DOU?

+

Nesta seção, você encontrará as seguintes informações sobre o Ro-DOU:

+
    +
  • Definição
  • +
  • Arquitetura
  • +
+

Definição

+

Conforme dito na página inicial, o Ro-DOU é uma ferramenta que efetua um clipping do Diário +Oficial da União (D.O.U.) e dos Diários Oficiais de municípios, por meio do Querido Diário. O Ro-DOU permite o recebimento de notificações (via e-mail, Slack, Discord ou outros) de todas as publicações que contenham as palavras-chaves que você definir.

+

O Ro-DOU gera dinamicamente grafos acíclicos dirigidos (DAGs) no Apache Airflow. Uma DAG nada mais é que um fluxo de tarefas executadas em sequência ou de maneira paralela, a partir de um código Python. Para entender com mais detalhes técnicos como uma DAG do Airflow funciona, clique aqui.

+

Nos arquivos YAML, é possível configurar os detalhes dos termos de pesquisa desejado (as palavras-chaves) e os contatos (e.g. endereços de e-mail) para recebimento dos resultados da pesquisa.

+

Arquitetura

+

A maneira como os diferentes componentes do Ro-DOU se relacionam pode ser sintetizada no diagrama abaixo. Para ampliar a imagem, clique aqui.

+

Diagrama de arquitetura do Ro-DOU

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/img/favicon.ico b/img/favicon.ico new file mode 100644 index 0000000..e85006a Binary files /dev/null and b/img/favicon.ico differ diff --git a/index.html b/index.html new file mode 100644 index 0000000..31ffebd --- /dev/null +++ b/index.html @@ -0,0 +1,180 @@ + + + + + + + + Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +

Ro-DOU

+

CI Tests

+

O Ro-DOU é uma ferramenta que efetua um clipping do Diário +Oficial da União (D.O.U.) e dos Diários Oficiais de municípios, por meio do Querido Diário. O Ro-DOU permite o recebimento de notificações (via e-mail, Slack, Discord ou outros) de todas as publicações que contenham as palavras-chaves que você definir.

+

Neste site, você encontrará informações sobre como usar o Ro-DOU e quais funcionalidades ele proporciona, além de outras informações sobre como contribuir para melhorar a ferramenta e como contatar o MGI.

+

O Ro-DOU é uma solução desenvolvida pela Secretaria de Gestão e Inovação do Ministério da Gestão e da Inovação em Serviços Públicos.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + + Next » + + +
+ + + + + + + + + + + diff --git a/js/html5shiv.min.js b/js/html5shiv.min.js new file mode 100644 index 0000000..1a01c94 --- /dev/null +++ b/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); diff --git a/js/jquery-3.6.0.min.js b/js/jquery-3.6.0.min.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/js/jquery-3.6.0.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t + + + + + + + Conteúdos sobre o Ro-DOU - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Oficinas e demais mídias sobre o Ro-DOU

+

Conheça o Ro-DOU - página institucional do Ministério de Gestão e da Inovação em Serviços Públicos.

+

Vídeo de apresentação - vídeo institucional do MGI sobre o Ro-DOU.

+

Ro-DOU - Robô de mineração do Diário Oficial da União - apresentação completa no canal da ENAP no YouTube, feita na Semana de Inovação de 2021.

+

Ro-DOU - Robô de mineração do Diário Oficial da União - palestra sobre o Ro-DOU no evento Python Brasil 2024 - Rio de Janeiro.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/outros/contato/index.html b/outros/contato/index.html new file mode 100644 index 0000000..c7fa46b --- /dev/null +++ b/outros/contato/index.html @@ -0,0 +1,177 @@ + + + + + + + + Contato - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Contato

+

O Ro-DOU é desenvolvido e mantido pela Coordenação-Geral de Gestão da Informação, órgão do Ministério da Gestão e da Inovação em Serviços Públicos: https://www.gov.br/gestao/pt-br.

+

Dúvidas, sugestões e demais comentários sobre o Ro-DOU podem ser enviados ao endereço de e-mail seges.cginf@gestao.gov.br.

+

Interações de caráter técnico e sugestões de melhoria no código-fonte e nas funcionalidades do Ro-DOU podem ser enviadas diretamente via GitHub, por meio da abertura de issues: https://github.com/gestaogovbr/Ro-dou.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/outros/faq/index.html b/outros/faq/index.html new file mode 100644 index 0000000..92edf1e --- /dev/null +++ b/outros/faq/index.html @@ -0,0 +1,233 @@ + + + + + + + + FAQ - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

FAQ e problemas frequentes

+

Nesta seção, você encontrará perguntas e respostas comuns e solução de problemas mais frequentes na utilização do Ro-DOU.

+
    +
  1. +

    Do que é preciso para instalar o Ro-DOU?
    +As instruções detalhadas de instalação estão neste link.

    +
  2. +
  3. +

    Como configurar os parâmetros de pesquisa do Ro-DOU?
    +Os parâmetros devem ser editados no arquivo em formato yml.

    +
  4. +
  5. +

    Qual a configuração mínima para a instalação do Ro-DOU?
    +É recomendado 4 Gb de memória RAM e 2 Gb de espaço em disco pelo menos.

    +
  6. +
  7. +

    Posso rodar o Ro-DOU no meu computador pessoal?
    +Sim. O Ro-DOU pode ser instalado em qualquer sistema operacional com suporte ao Docker.

    +
  8. +
  9. +

    Quais são as fontes de dados do Ro-DOU?
    + Os dados são obtidos via INLABS, API da Imprensa Nacional e API do Querido Diário.

    +
  10. +
  11. +

    De que forma o Ro-DOU é capaz de enviar relatórios?
    +Via e-mail, Slack, Discord.

    +
  12. +
  13. +

    Preciso pagar pra usar o Ro-DOU?
    +Não, ele é gratuito.

    +
  14. +
  15. +

    Posso usar o Ro-DOU para fazer buscas nas edições mais antigas do DOU?
    +Sim, basta indicar a data desejada no campo "trigger_date" ao disparar manualmente a DAG.

    +
  16. +
  17. +

    Como receber atualizações de versão do Ro-DOU?
    +Sim, basta acompanhar o change log (log de atualizações) disponível aqui.

    +
  18. +
  19. +

    Posso utilizar o Ro-dou em meu órgão?
    +Sim. Confira as instruções aqui.

    +
  20. +
  21. +

    Posso utilizar o Ro-dou na minha empresa privada?
    +Sim. Não são cobrados direitos autorais ou de exclusividade.

    +
  22. +
  23. +

    Existe um limite de acessos diário para buscas com o Ro-DOU?
    +Não. Os acessos são ilimitados.

    +
  24. +
  25. +

    É necessário fazer alguma configuração de fuso horário para o Ro-DOU?
    +Sim. O padrão é América-São Paulo para o ambiente Airflow que dá sustentação ao Ro-DOU através da variável de ambiente chamada AIRFLOW__CORE__DEFAULT__TIMEZONE.

    +
  26. +
  27. +

    Posso usar o Ro-DOU no exterior?
    +Sim. O Ro-DOU pode ser executado em qualquer lugar desde que tenha acesso à internet.

    +
  28. +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/outros/links/index.html b/outros/links/index.html new file mode 100644 index 0000000..c231419 --- /dev/null +++ b/outros/links/index.html @@ -0,0 +1,196 @@ + + + + + + + + Links relevantes - Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ + +

O Diário Oficial da União (D.O.U.) é publicado pela Imprensa Nacional:

+ +

Para operar, o Ro-DOU utiliza diferentes tecnologias, ferramentas e dependências. Podem ser destacadas as seguintes:

+ +

O Ro-DOU também utiliza as funcionalidades das ferramentas INLABS e Querido Diário:

+ +

Este site de documentação do Ro-DOU foi elaborado com a ajuda do MkDocs:

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + « Previous + + + Next » + + +
+ + + + + + + + + diff --git a/search.html b/search.html new file mode 100644 index 0000000..d8bf4d9 --- /dev/null +++ b/search.html @@ -0,0 +1,166 @@ + + + + + + + + Ro-DOU - ferramenta de clipping dos diários oficiais + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • +
  • +
  • +
+
+
+
+
+ + +

Search Results

+ + + +
+ Searching... +
+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + + +
+ + + + + + + + + diff --git a/search/lunr.js b/search/lunr.js new file mode 100644 index 0000000..aca0a16 --- /dev/null +++ b/search/lunr.js @@ -0,0 +1,3475 @@ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ + +;(function(){ + +/** + * A convenience function for configuring and constructing + * a new lunr Index. + * + * A lunr.Builder instance is created and the pipeline setup + * with a trimmer, stop word filter and stemmer. + * + * This builder object is yielded to the configuration function + * that is passed as a parameter, allowing the list of fields + * and other builder parameters to be customised. + * + * All documents _must_ be added within the passed config function. + * + * @example + * var idx = lunr(function () { + * this.field('title') + * this.field('body') + * this.ref('id') + * + * documents.forEach(function (doc) { + * this.add(doc) + * }, this) + * }) + * + * @see {@link lunr.Builder} + * @see {@link lunr.Pipeline} + * @see {@link lunr.trimmer} + * @see {@link lunr.stopWordFilter} + * @see {@link lunr.stemmer} + * @namespace {function} lunr + */ +var lunr = function (config) { + var builder = new lunr.Builder + + builder.pipeline.add( + lunr.trimmer, + lunr.stopWordFilter, + lunr.stemmer + ) + + builder.searchPipeline.add( + lunr.stemmer + ) + + config.call(builder, builder) + return builder.build() +} + +lunr.version = "2.3.9" +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A namespace containing utils for the rest of the lunr library + * @namespace lunr.utils + */ +lunr.utils = {} + +/** + * Print a warning message to the console. + * + * @param {String} message The message to be printed. + * @memberOf lunr.utils + * @function + */ +lunr.utils.warn = (function (global) { + /* eslint-disable no-console */ + return function (message) { + if (global.console && console.warn) { + console.warn(message) + } + } + /* eslint-enable no-console */ +})(this) + +/** + * Convert an object to a string. + * + * In the case of `null` and `undefined` the function returns + * the empty string, in all other cases the result of calling + * `toString` on the passed object is returned. + * + * @param {Any} obj The object to convert to a string. + * @return {String} string representation of the passed object. + * @memberOf lunr.utils + */ +lunr.utils.asString = function (obj) { + if (obj === void 0 || obj === null) { + return "" + } else { + return obj.toString() + } +} + +/** + * Clones an object. + * + * Will create a copy of an existing object such that any mutations + * on the copy cannot affect the original. + * + * Only shallow objects are supported, passing a nested object to this + * function will cause a TypeError. + * + * Objects with primitives, and arrays of primitives are supported. + * + * @param {Object} obj The object to clone. + * @return {Object} a clone of the passed object. + * @throws {TypeError} when a nested object is passed. + * @memberOf Utils + */ +lunr.utils.clone = function (obj) { + if (obj === null || obj === undefined) { + return obj + } + + var clone = Object.create(null), + keys = Object.keys(obj) + + for (var i = 0; i < keys.length; i++) { + var key = keys[i], + val = obj[key] + + if (Array.isArray(val)) { + clone[key] = val.slice() + continue + } + + if (typeof val === 'string' || + typeof val === 'number' || + typeof val === 'boolean') { + clone[key] = val + continue + } + + throw new TypeError("clone is not deep and does not support nested objects") + } + + return clone +} +lunr.FieldRef = function (docRef, fieldName, stringValue) { + this.docRef = docRef + this.fieldName = fieldName + this._stringValue = stringValue +} + +lunr.FieldRef.joiner = "/" + +lunr.FieldRef.fromString = function (s) { + var n = s.indexOf(lunr.FieldRef.joiner) + + if (n === -1) { + throw "malformed field ref string" + } + + var fieldRef = s.slice(0, n), + docRef = s.slice(n + 1) + + return new lunr.FieldRef (docRef, fieldRef, s) +} + +lunr.FieldRef.prototype.toString = function () { + if (this._stringValue == undefined) { + this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef + } + + return this._stringValue +} +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A lunr set. + * + * @constructor + */ +lunr.Set = function (elements) { + this.elements = Object.create(null) + + if (elements) { + this.length = elements.length + + for (var i = 0; i < this.length; i++) { + this.elements[elements[i]] = true + } + } else { + this.length = 0 + } +} + +/** + * A complete set that contains all elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ +lunr.Set.complete = { + intersect: function (other) { + return other + }, + + union: function () { + return this + }, + + contains: function () { + return true + } +} + +/** + * An empty set that contains no elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ +lunr.Set.empty = { + intersect: function () { + return this + }, + + union: function (other) { + return other + }, + + contains: function () { + return false + } +} + +/** + * Returns true if this set contains the specified object. + * + * @param {object} object - Object whose presence in this set is to be tested. + * @returns {boolean} - True if this set contains the specified object. + */ +lunr.Set.prototype.contains = function (object) { + return !!this.elements[object] +} + +/** + * Returns a new set containing only the elements that are present in both + * this set and the specified set. + * + * @param {lunr.Set} other - set to intersect with this set. + * @returns {lunr.Set} a new set that is the intersection of this and the specified set. + */ + +lunr.Set.prototype.intersect = function (other) { + var a, b, elements, intersection = [] + + if (other === lunr.Set.complete) { + return this + } + + if (other === lunr.Set.empty) { + return other + } + + if (this.length < other.length) { + a = this + b = other + } else { + a = other + b = this + } + + elements = Object.keys(a.elements) + + for (var i = 0; i < elements.length; i++) { + var element = elements[i] + if (element in b.elements) { + intersection.push(element) + } + } + + return new lunr.Set (intersection) +} + +/** + * Returns a new set combining the elements of this and the specified set. + * + * @param {lunr.Set} other - set to union with this set. + * @return {lunr.Set} a new set that is the union of this and the specified set. + */ + +lunr.Set.prototype.union = function (other) { + if (other === lunr.Set.complete) { + return lunr.Set.complete + } + + if (other === lunr.Set.empty) { + return this + } + + return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements))) +} +/** + * A function to calculate the inverse document frequency for + * a posting. This is shared between the builder and the index + * + * @private + * @param {object} posting - The posting for a given term + * @param {number} documentCount - The total number of documents. + */ +lunr.idf = function (posting, documentCount) { + var documentsWithTerm = 0 + + for (var fieldName in posting) { + if (fieldName == '_index') continue // Ignore the term index, its not a field + documentsWithTerm += Object.keys(posting[fieldName]).length + } + + var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5) + + return Math.log(1 + Math.abs(x)) +} + +/** + * A token wraps a string representation of a token + * as it is passed through the text processing pipeline. + * + * @constructor + * @param {string} [str=''] - The string token being wrapped. + * @param {object} [metadata={}] - Metadata associated with this token. + */ +lunr.Token = function (str, metadata) { + this.str = str || "" + this.metadata = metadata || {} +} + +/** + * Returns the token string that is being wrapped by this object. + * + * @returns {string} + */ +lunr.Token.prototype.toString = function () { + return this.str +} + +/** + * A token update function is used when updating or optionally + * when cloning a token. + * + * @callback lunr.Token~updateFunction + * @param {string} str - The string representation of the token. + * @param {Object} metadata - All metadata associated with this token. + */ + +/** + * Applies the given function to the wrapped string token. + * + * @example + * token.update(function (str, metadata) { + * return str.toUpperCase() + * }) + * + * @param {lunr.Token~updateFunction} fn - A function to apply to the token string. + * @returns {lunr.Token} + */ +lunr.Token.prototype.update = function (fn) { + this.str = fn(this.str, this.metadata) + return this +} + +/** + * Creates a clone of this token. Optionally a function can be + * applied to the cloned token. + * + * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token. + * @returns {lunr.Token} + */ +lunr.Token.prototype.clone = function (fn) { + fn = fn || function (s) { return s } + return new lunr.Token (fn(this.str, this.metadata), this.metadata) +} +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A function for splitting a string into tokens ready to be inserted into + * the search index. Uses `lunr.tokenizer.separator` to split strings, change + * the value of this property to change how strings are split into tokens. + * + * This tokenizer will convert its parameter to a string by calling `toString` and + * then will split this string on the character in `lunr.tokenizer.separator`. + * Arrays will have their elements converted to strings and wrapped in a lunr.Token. + * + * Optional metadata can be passed to the tokenizer, this metadata will be cloned and + * added as metadata to every token that is created from the object to be tokenized. + * + * @static + * @param {?(string|object|object[])} obj - The object to convert into tokens + * @param {?object} metadata - Optional metadata to associate with every token + * @returns {lunr.Token[]} + * @see {@link lunr.Pipeline} + */ +lunr.tokenizer = function (obj, metadata) { + if (obj == null || obj == undefined) { + return [] + } + + if (Array.isArray(obj)) { + return obj.map(function (t) { + return new lunr.Token( + lunr.utils.asString(t).toLowerCase(), + lunr.utils.clone(metadata) + ) + }) + } + + var str = obj.toString().toLowerCase(), + len = str.length, + tokens = [] + + for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) { + var char = str.charAt(sliceEnd), + sliceLength = sliceEnd - sliceStart + + if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) { + + if (sliceLength > 0) { + var tokenMetadata = lunr.utils.clone(metadata) || {} + tokenMetadata["position"] = [sliceStart, sliceLength] + tokenMetadata["index"] = tokens.length + + tokens.push( + new lunr.Token ( + str.slice(sliceStart, sliceEnd), + tokenMetadata + ) + ) + } + + sliceStart = sliceEnd + 1 + } + + } + + return tokens +} + +/** + * The separator used to split a string into tokens. Override this property to change the behaviour of + * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. + * + * @static + * @see lunr.tokenizer + */ +lunr.tokenizer.separator = /[\s\-]+/ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.Pipelines maintain an ordered list of functions to be applied to all + * tokens in documents entering the search index and queries being ran against + * the index. + * + * An instance of lunr.Index created with the lunr shortcut will contain a + * pipeline with a stop word filter and an English language stemmer. Extra + * functions can be added before or after either of these functions or these + * default functions can be removed. + * + * When run the pipeline will call each function in turn, passing a token, the + * index of that token in the original list of all tokens and finally a list of + * all the original tokens. + * + * The output of functions in the pipeline will be passed to the next function + * in the pipeline. To exclude a token from entering the index the function + * should return undefined, the rest of the pipeline will not be called with + * this token. + * + * For serialisation of pipelines to work, all functions used in an instance of + * a pipeline should be registered with lunr.Pipeline. Registered functions can + * then be loaded. If trying to load a serialised pipeline that uses functions + * that are not registered an error will be thrown. + * + * If not planning on serialising the pipeline then registering pipeline functions + * is not necessary. + * + * @constructor + */ +lunr.Pipeline = function () { + this._stack = [] +} + +lunr.Pipeline.registeredFunctions = Object.create(null) + +/** + * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token + * string as well as all known metadata. A pipeline function can mutate the token string + * or mutate (or add) metadata for a given token. + * + * A pipeline function can indicate that the passed token should be discarded by returning + * null, undefined or an empty string. This token will not be passed to any downstream pipeline + * functions and will not be added to the index. + * + * Multiple tokens can be returned by returning an array of tokens. Each token will be passed + * to any downstream pipeline functions and all will returned tokens will be added to the index. + * + * Any number of pipeline functions may be chained together using a lunr.Pipeline. + * + * @interface lunr.PipelineFunction + * @param {lunr.Token} token - A token from the document being processed. + * @param {number} i - The index of this token in the complete list of tokens for this document/field. + * @param {lunr.Token[]} tokens - All tokens for this document/field. + * @returns {(?lunr.Token|lunr.Token[])} + */ + +/** + * Register a function with the pipeline. + * + * Functions that are used in the pipeline should be registered if the pipeline + * needs to be serialised, or a serialised pipeline needs to be loaded. + * + * Registering a function does not add it to a pipeline, functions must still be + * added to instances of the pipeline for them to be used when running a pipeline. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @param {String} label - The label to register this function with + */ +lunr.Pipeline.registerFunction = function (fn, label) { + if (label in this.registeredFunctions) { + lunr.utils.warn('Overwriting existing registered function: ' + label) + } + + fn.label = label + lunr.Pipeline.registeredFunctions[fn.label] = fn +} + +/** + * Warns if the function is not registered as a Pipeline function. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @private + */ +lunr.Pipeline.warnIfFunctionNotRegistered = function (fn) { + var isRegistered = fn.label && (fn.label in this.registeredFunctions) + + if (!isRegistered) { + lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\n', fn) + } +} + +/** + * Loads a previously serialised pipeline. + * + * All functions to be loaded must already be registered with lunr.Pipeline. + * If any function from the serialised data has not been registered then an + * error will be thrown. + * + * @param {Object} serialised - The serialised pipeline to load. + * @returns {lunr.Pipeline} + */ +lunr.Pipeline.load = function (serialised) { + var pipeline = new lunr.Pipeline + + serialised.forEach(function (fnName) { + var fn = lunr.Pipeline.registeredFunctions[fnName] + + if (fn) { + pipeline.add(fn) + } else { + throw new Error('Cannot load unregistered function: ' + fnName) + } + }) + + return pipeline +} + +/** + * Adds new functions to the end of the pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline. + */ +lunr.Pipeline.prototype.add = function () { + var fns = Array.prototype.slice.call(arguments) + + fns.forEach(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + this._stack.push(fn) + }, this) +} + +/** + * Adds a single function after a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ +lunr.Pipeline.prototype.after = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + pos = pos + 1 + this._stack.splice(pos, 0, newFn) +} + +/** + * Adds a single function before a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ +lunr.Pipeline.prototype.before = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + this._stack.splice(pos, 0, newFn) +} + +/** + * Removes a function from the pipeline. + * + * @param {lunr.PipelineFunction} fn The function to remove from the pipeline. + */ +lunr.Pipeline.prototype.remove = function (fn) { + var pos = this._stack.indexOf(fn) + if (pos == -1) { + return + } + + this._stack.splice(pos, 1) +} + +/** + * Runs the current list of functions that make up the pipeline against the + * passed tokens. + * + * @param {Array} tokens The tokens to run through the pipeline. + * @returns {Array} + */ +lunr.Pipeline.prototype.run = function (tokens) { + var stackLength = this._stack.length + + for (var i = 0; i < stackLength; i++) { + var fn = this._stack[i] + var memo = [] + + for (var j = 0; j < tokens.length; j++) { + var result = fn(tokens[j], j, tokens) + + if (result === null || result === void 0 || result === '') continue + + if (Array.isArray(result)) { + for (var k = 0; k < result.length; k++) { + memo.push(result[k]) + } + } else { + memo.push(result) + } + } + + tokens = memo + } + + return tokens +} + +/** + * Convenience method for passing a string through a pipeline and getting + * strings out. This method takes care of wrapping the passed string in a + * token and mapping the resulting tokens back to strings. + * + * @param {string} str - The string to pass through the pipeline. + * @param {?object} metadata - Optional metadata to associate with the token + * passed to the pipeline. + * @returns {string[]} + */ +lunr.Pipeline.prototype.runString = function (str, metadata) { + var token = new lunr.Token (str, metadata) + + return this.run([token]).map(function (t) { + return t.toString() + }) +} + +/** + * Resets the pipeline by removing any existing processors. + * + */ +lunr.Pipeline.prototype.reset = function () { + this._stack = [] +} + +/** + * Returns a representation of the pipeline ready for serialisation. + * + * Logs a warning if the function has not been registered. + * + * @returns {Array} + */ +lunr.Pipeline.prototype.toJSON = function () { + return this._stack.map(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + + return fn.label + }) +} +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A vector is used to construct the vector space of documents and queries. These + * vectors support operations to determine the similarity between two documents or + * a document and a query. + * + * Normally no parameters are required for initializing a vector, but in the case of + * loading a previously dumped vector the raw elements can be provided to the constructor. + * + * For performance reasons vectors are implemented with a flat array, where an elements + * index is immediately followed by its value. E.g. [index, value, index, value]. This + * allows the underlying array to be as sparse as possible and still offer decent + * performance when being used for vector calculations. + * + * @constructor + * @param {Number[]} [elements] - The flat list of element index and element value pairs. + */ +lunr.Vector = function (elements) { + this._magnitude = 0 + this.elements = elements || [] +} + + +/** + * Calculates the position within the vector to insert a given index. + * + * This is used internally by insert and upsert. If there are duplicate indexes then + * the position is returned as if the value for that index were to be updated, but it + * is the callers responsibility to check whether there is a duplicate at that index + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @returns {Number} + */ +lunr.Vector.prototype.positionForIndex = function (index) { + // For an empty vector the tuple can be inserted at the beginning + if (this.elements.length == 0) { + return 0 + } + + var start = 0, + end = this.elements.length / 2, + sliceLength = end - start, + pivotPoint = Math.floor(sliceLength / 2), + pivotIndex = this.elements[pivotPoint * 2] + + while (sliceLength > 1) { + if (pivotIndex < index) { + start = pivotPoint + } + + if (pivotIndex > index) { + end = pivotPoint + } + + if (pivotIndex == index) { + break + } + + sliceLength = end - start + pivotPoint = start + Math.floor(sliceLength / 2) + pivotIndex = this.elements[pivotPoint * 2] + } + + if (pivotIndex == index) { + return pivotPoint * 2 + } + + if (pivotIndex > index) { + return pivotPoint * 2 + } + + if (pivotIndex < index) { + return (pivotPoint + 1) * 2 + } +} + +/** + * Inserts an element at an index within the vector. + * + * Does not allow duplicates, will throw an error if there is already an entry + * for this index. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + */ +lunr.Vector.prototype.insert = function (insertIdx, val) { + this.upsert(insertIdx, val, function () { + throw "duplicate index" + }) +} + +/** + * Inserts or updates an existing index within the vector. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + * @param {function} fn - A function that is called for updates, the existing value and the + * requested value are passed as arguments + */ +lunr.Vector.prototype.upsert = function (insertIdx, val, fn) { + this._magnitude = 0 + var position = this.positionForIndex(insertIdx) + + if (this.elements[position] == insertIdx) { + this.elements[position + 1] = fn(this.elements[position + 1], val) + } else { + this.elements.splice(position, 0, insertIdx, val) + } +} + +/** + * Calculates the magnitude of this vector. + * + * @returns {Number} + */ +lunr.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude + + var sumOfSquares = 0, + elementsLength = this.elements.length + + for (var i = 1; i < elementsLength; i += 2) { + var val = this.elements[i] + sumOfSquares += val * val + } + + return this._magnitude = Math.sqrt(sumOfSquares) +} + +/** + * Calculates the dot product of this vector and another vector. + * + * @param {lunr.Vector} otherVector - The vector to compute the dot product with. + * @returns {Number} + */ +lunr.Vector.prototype.dot = function (otherVector) { + var dotProduct = 0, + a = this.elements, b = otherVector.elements, + aLen = a.length, bLen = b.length, + aVal = 0, bVal = 0, + i = 0, j = 0 + + while (i < aLen && j < bLen) { + aVal = a[i], bVal = b[j] + if (aVal < bVal) { + i += 2 + } else if (aVal > bVal) { + j += 2 + } else if (aVal == bVal) { + dotProduct += a[i + 1] * b[j + 1] + i += 2 + j += 2 + } + } + + return dotProduct +} + +/** + * Calculates the similarity between this vector and another vector. + * + * @param {lunr.Vector} otherVector - The other vector to calculate the + * similarity with. + * @returns {Number} + */ +lunr.Vector.prototype.similarity = function (otherVector) { + return this.dot(otherVector) / this.magnitude() || 0 +} + +/** + * Converts the vector to an array of the elements within the vector. + * + * @returns {Number[]} + */ +lunr.Vector.prototype.toArray = function () { + var output = new Array (this.elements.length / 2) + + for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) { + output[j] = this.elements[i] + } + + return output +} + +/** + * A JSON serializable representation of the vector. + * + * @returns {Number[]} + */ +lunr.Vector.prototype.toJSON = function () { + return this.elements +} +/* eslint-disable */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ + +/** + * lunr.stemmer is an english language stemmer, this is a JavaScript + * implementation of the PorterStemmer taken from http://tartarus.org/~martin + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token - The string to stem + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + * @function + */ +lunr.stemmer = (function(){ + var step2list = { + "ational" : "ate", + "tional" : "tion", + "enci" : "ence", + "anci" : "ance", + "izer" : "ize", + "bli" : "ble", + "alli" : "al", + "entli" : "ent", + "eli" : "e", + "ousli" : "ous", + "ization" : "ize", + "ation" : "ate", + "ator" : "ate", + "alism" : "al", + "iveness" : "ive", + "fulness" : "ful", + "ousness" : "ous", + "aliti" : "al", + "iviti" : "ive", + "biliti" : "ble", + "logi" : "log" + }, + + step3list = { + "icate" : "ic", + "ative" : "", + "alize" : "al", + "iciti" : "ic", + "ical" : "ic", + "ful" : "", + "ness" : "" + }, + + c = "[^aeiou]", // consonant + v = "[aeiouy]", // vowel + C = c + "[^aeiouy]*", // consonant sequence + V = v + "[aeiou]*", // vowel sequence + + mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0 + meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1 + mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1 + s_v = "^(" + C + ")?" + v; // vowel in stem + + var re_mgr0 = new RegExp(mgr0); + var re_mgr1 = new RegExp(mgr1); + var re_meq1 = new RegExp(meq1); + var re_s_v = new RegExp(s_v); + + var re_1a = /^(.+?)(ss|i)es$/; + var re2_1a = /^(.+?)([^s])s$/; + var re_1b = /^(.+?)eed$/; + var re2_1b = /^(.+?)(ed|ing)$/; + var re_1b_2 = /.$/; + var re2_1b_2 = /(at|bl|iz)$/; + var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$"); + var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var re_1c = /^(.+?[^aeiou])y$/; + var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + + var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + + var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + var re2_4 = /^(.+?)(s|t)(ion)$/; + + var re_5 = /^(.+?)e$/; + var re_5_1 = /ll$/; + var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var porterStemmer = function porterStemmer(w) { + var stem, + suffix, + firstch, + re, + re2, + re3, + re4; + + if (w.length < 3) { return w; } + + firstch = w.substr(0,1); + if (firstch == "y") { + w = firstch.toUpperCase() + w.substr(1); + } + + // Step 1a + re = re_1a + re2 = re2_1a; + + if (re.test(w)) { w = w.replace(re,"$1$2"); } + else if (re2.test(w)) { w = w.replace(re2,"$1$2"); } + + // Step 1b + re = re_1b; + re2 = re2_1b; + if (re.test(w)) { + var fp = re.exec(w); + re = re_mgr0; + if (re.test(fp[1])) { + re = re_1b_2; + w = w.replace(re,""); + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = re_s_v; + if (re2.test(stem)) { + w = stem; + re2 = re2_1b_2; + re3 = re3_1b_2; + re4 = re4_1b_2; + if (re2.test(w)) { w = w + "e"; } + else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); } + else if (re4.test(w)) { w = w + "e"; } + } + } + + // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say) + re = re_1c; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + w = stem + "i"; + } + + // Step 2 + re = re_2; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step2list[suffix]; + } + } + + // Step 3 + re = re_3; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step3list[suffix]; + } + } + + // Step 4 + re = re_4; + re2 = re2_4; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + if (re.test(stem)) { + w = stem; + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = re_mgr1; + if (re2.test(stem)) { + w = stem; + } + } + + // Step 5 + re = re_5; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + re2 = re_meq1; + re3 = re3_5; + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) { + w = stem; + } + } + + re = re_5_1; + re2 = re_mgr1; + if (re.test(w) && re2.test(w)) { + re = re_1b_2; + w = w.replace(re,""); + } + + // and turn initial Y back to y + + if (firstch == "y") { + w = firstch.toLowerCase() + w.substr(1); + } + + return w; + }; + + return function (token) { + return token.update(porterStemmer); + } +})(); + +lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer') +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.generateStopWordFilter builds a stopWordFilter function from the provided + * list of stop words. + * + * The built in lunr.stopWordFilter is built using this generator and can be used + * to generate custom stopWordFilters for applications or non English languages. + * + * @function + * @param {Array} token The token to pass through the filter + * @returns {lunr.PipelineFunction} + * @see lunr.Pipeline + * @see lunr.stopWordFilter + */ +lunr.generateStopWordFilter = function (stopWords) { + var words = stopWords.reduce(function (memo, stopWord) { + memo[stopWord] = stopWord + return memo + }, {}) + + return function (token) { + if (token && words[token.toString()] !== token.toString()) return token + } +} + +/** + * lunr.stopWordFilter is an English language stop word list filter, any words + * contained in the list will not be passed through the filter. + * + * This is intended to be used in the Pipeline. If the token does not pass the + * filter then undefined will be returned. + * + * @function + * @implements {lunr.PipelineFunction} + * @params {lunr.Token} token - A token to check for being a stop word. + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ +lunr.stopWordFilter = lunr.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your' +]) + +lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter') +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.trimmer is a pipeline function for trimming non word + * characters from the beginning and end of tokens before they + * enter the index. + * + * This implementation may not work correctly for non latin + * characters and should either be removed or adapted for use + * with languages with non-latin characters. + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token The token to pass through the filter + * @returns {lunr.Token} + * @see lunr.Pipeline + */ +lunr.trimmer = function (token) { + return token.update(function (s) { + return s.replace(/^\W+/, '').replace(/\W+$/, '') + }) +} + +lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer') +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A token set is used to store the unique list of all tokens + * within an index. Token sets are also used to represent an + * incoming query to the index, this query token set and index + * token set are then intersected to find which tokens to look + * up in the inverted index. + * + * A token set can hold multiple tokens, as in the case of the + * index token set, or it can hold a single token as in the + * case of a simple query token set. + * + * Additionally token sets are used to perform wildcard matching. + * Leading, contained and trailing wildcards are supported, and + * from this edit distance matching can also be provided. + * + * Token sets are implemented as a minimal finite state automata, + * where both common prefixes and suffixes are shared between tokens. + * This helps to reduce the space used for storing the token set. + * + * @constructor + */ +lunr.TokenSet = function () { + this.final = false + this.edges = {} + this.id = lunr.TokenSet._nextId + lunr.TokenSet._nextId += 1 +} + +/** + * Keeps track of the next, auto increment, identifier to assign + * to a new tokenSet. + * + * TokenSets require a unique identifier to be correctly minimised. + * + * @private + */ +lunr.TokenSet._nextId = 1 + +/** + * Creates a TokenSet instance from the given sorted array of words. + * + * @param {String[]} arr - A sorted array of strings to create the set from. + * @returns {lunr.TokenSet} + * @throws Will throw an error if the input array is not sorted. + */ +lunr.TokenSet.fromArray = function (arr) { + var builder = new lunr.TokenSet.Builder + + for (var i = 0, len = arr.length; i < len; i++) { + builder.insert(arr[i]) + } + + builder.finish() + return builder.root +} + +/** + * Creates a token set from a query clause. + * + * @private + * @param {Object} clause - A single clause from lunr.Query. + * @param {string} clause.term - The query clause term. + * @param {number} [clause.editDistance] - The optional edit distance for the term. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.fromClause = function (clause) { + if ('editDistance' in clause) { + return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance) + } else { + return lunr.TokenSet.fromString(clause.term) + } +} + +/** + * Creates a token set representing a single string with a specified + * edit distance. + * + * Insertions, deletions, substitutions and transpositions are each + * treated as an edit distance of 1. + * + * Increasing the allowed edit distance will have a dramatic impact + * on the performance of both creating and intersecting these TokenSets. + * It is advised to keep the edit distance less than 3. + * + * @param {string} str - The string to create the token set from. + * @param {number} editDistance - The allowed edit distance to match. + * @returns {lunr.Vector} + */ +lunr.TokenSet.fromFuzzyString = function (str, editDistance) { + var root = new lunr.TokenSet + + var stack = [{ + node: root, + editsRemaining: editDistance, + str: str + }] + + while (stack.length) { + var frame = stack.pop() + + // no edit + if (frame.str.length > 0) { + var char = frame.str.charAt(0), + noEditNode + + if (char in frame.node.edges) { + noEditNode = frame.node.edges[char] + } else { + noEditNode = new lunr.TokenSet + frame.node.edges[char] = noEditNode + } + + if (frame.str.length == 1) { + noEditNode.final = true + } + + stack.push({ + node: noEditNode, + editsRemaining: frame.editsRemaining, + str: frame.str.slice(1) + }) + } + + if (frame.editsRemaining == 0) { + continue + } + + // insertion + if ("*" in frame.node.edges) { + var insertionNode = frame.node.edges["*"] + } else { + var insertionNode = new lunr.TokenSet + frame.node.edges["*"] = insertionNode + } + + if (frame.str.length == 0) { + insertionNode.final = true + } + + stack.push({ + node: insertionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str + }) + + // deletion + // can only do a deletion if we have enough edits remaining + // and if there are characters left to delete in the string + if (frame.str.length > 1) { + stack.push({ + node: frame.node, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // deletion + // just removing the last character from the str + if (frame.str.length == 1) { + frame.node.final = true + } + + // substitution + // can only do a substitution if we have enough edits remaining + // and if there are characters left to substitute + if (frame.str.length >= 1) { + if ("*" in frame.node.edges) { + var substitutionNode = frame.node.edges["*"] + } else { + var substitutionNode = new lunr.TokenSet + frame.node.edges["*"] = substitutionNode + } + + if (frame.str.length == 1) { + substitutionNode.final = true + } + + stack.push({ + node: substitutionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // transposition + // can only do a transposition if there are edits remaining + // and there are enough characters to transpose + if (frame.str.length > 1) { + var charA = frame.str.charAt(0), + charB = frame.str.charAt(1), + transposeNode + + if (charB in frame.node.edges) { + transposeNode = frame.node.edges[charB] + } else { + transposeNode = new lunr.TokenSet + frame.node.edges[charB] = transposeNode + } + + if (frame.str.length == 1) { + transposeNode.final = true + } + + stack.push({ + node: transposeNode, + editsRemaining: frame.editsRemaining - 1, + str: charA + frame.str.slice(2) + }) + } + } + + return root +} + +/** + * Creates a TokenSet from a string. + * + * The string may contain one or more wildcard characters (*) + * that will allow wildcard matching when intersecting with + * another TokenSet. + * + * @param {string} str - The string to create a TokenSet from. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.fromString = function (str) { + var node = new lunr.TokenSet, + root = node + + /* + * Iterates through all characters within the passed string + * appending a node for each character. + * + * When a wildcard character is found then a self + * referencing edge is introduced to continually match + * any number of any characters. + */ + for (var i = 0, len = str.length; i < len; i++) { + var char = str[i], + final = (i == len - 1) + + if (char == "*") { + node.edges[char] = node + node.final = final + + } else { + var next = new lunr.TokenSet + next.final = final + + node.edges[char] = next + node = next + } + } + + return root +} + +/** + * Converts this TokenSet into an array of strings + * contained within the TokenSet. + * + * This is not intended to be used on a TokenSet that + * contains wildcards, in these cases the results are + * undefined and are likely to cause an infinite loop. + * + * @returns {string[]} + */ +lunr.TokenSet.prototype.toArray = function () { + var words = [] + + var stack = [{ + prefix: "", + node: this + }] + + while (stack.length) { + var frame = stack.pop(), + edges = Object.keys(frame.node.edges), + len = edges.length + + if (frame.node.final) { + /* In Safari, at this point the prefix is sometimes corrupted, see: + * https://github.com/olivernn/lunr.js/issues/279 Calling any + * String.prototype method forces Safari to "cast" this string to what + * it's supposed to be, fixing the bug. */ + frame.prefix.charAt(0) + words.push(frame.prefix) + } + + for (var i = 0; i < len; i++) { + var edge = edges[i] + + stack.push({ + prefix: frame.prefix.concat(edge), + node: frame.node.edges[edge] + }) + } + } + + return words +} + +/** + * Generates a string representation of a TokenSet. + * + * This is intended to allow TokenSets to be used as keys + * in objects, largely to aid the construction and minimisation + * of a TokenSet. As such it is not designed to be a human + * friendly representation of the TokenSet. + * + * @returns {string} + */ +lunr.TokenSet.prototype.toString = function () { + // NOTE: Using Object.keys here as this.edges is very likely + // to enter 'hash-mode' with many keys being added + // + // avoiding a for-in loop here as it leads to the function + // being de-optimised (at least in V8). From some simple + // benchmarks the performance is comparable, but allowing + // V8 to optimize may mean easy performance wins in the future. + + if (this._str) { + return this._str + } + + var str = this.final ? '1' : '0', + labels = Object.keys(this.edges).sort(), + len = labels.length + + for (var i = 0; i < len; i++) { + var label = labels[i], + node = this.edges[label] + + str = str + label + node.id + } + + return str +} + +/** + * Returns a new TokenSet that is the intersection of + * this TokenSet and the passed TokenSet. + * + * This intersection will take into account any wildcards + * contained within the TokenSet. + * + * @param {lunr.TokenSet} b - An other TokenSet to intersect with. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.prototype.intersect = function (b) { + var output = new lunr.TokenSet, + frame = undefined + + var stack = [{ + qNode: b, + output: output, + node: this + }] + + while (stack.length) { + frame = stack.pop() + + // NOTE: As with the #toString method, we are using + // Object.keys and a for loop instead of a for-in loop + // as both of these objects enter 'hash' mode, causing + // the function to be de-optimised in V8 + var qEdges = Object.keys(frame.qNode.edges), + qLen = qEdges.length, + nEdges = Object.keys(frame.node.edges), + nLen = nEdges.length + + for (var q = 0; q < qLen; q++) { + var qEdge = qEdges[q] + + for (var n = 0; n < nLen; n++) { + var nEdge = nEdges[n] + + if (nEdge == qEdge || qEdge == '*') { + var node = frame.node.edges[nEdge], + qNode = frame.qNode.edges[qEdge], + final = node.final && qNode.final, + next = undefined + + if (nEdge in frame.output.edges) { + // an edge already exists for this character + // no need to create a new node, just set the finality + // bit unless this node is already final + next = frame.output.edges[nEdge] + next.final = next.final || final + + } else { + // no edge exists yet, must create one + // set the finality bit and insert it + // into the output + next = new lunr.TokenSet + next.final = final + frame.output.edges[nEdge] = next + } + + stack.push({ + qNode: qNode, + output: next, + node: node + }) + } + } + } + } + + return output +} +lunr.TokenSet.Builder = function () { + this.previousWord = "" + this.root = new lunr.TokenSet + this.uncheckedNodes = [] + this.minimizedNodes = {} +} + +lunr.TokenSet.Builder.prototype.insert = function (word) { + var node, + commonPrefix = 0 + + if (word < this.previousWord) { + throw new Error ("Out of order word insertion") + } + + for (var i = 0; i < word.length && i < this.previousWord.length; i++) { + if (word[i] != this.previousWord[i]) break + commonPrefix++ + } + + this.minimize(commonPrefix) + + if (this.uncheckedNodes.length == 0) { + node = this.root + } else { + node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child + } + + for (var i = commonPrefix; i < word.length; i++) { + var nextNode = new lunr.TokenSet, + char = word[i] + + node.edges[char] = nextNode + + this.uncheckedNodes.push({ + parent: node, + char: char, + child: nextNode + }) + + node = nextNode + } + + node.final = true + this.previousWord = word +} + +lunr.TokenSet.Builder.prototype.finish = function () { + this.minimize(0) +} + +lunr.TokenSet.Builder.prototype.minimize = function (downTo) { + for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) { + var node = this.uncheckedNodes[i], + childKey = node.child.toString() + + if (childKey in this.minimizedNodes) { + node.parent.edges[node.char] = this.minimizedNodes[childKey] + } else { + // Cache the key for this node since + // we know it can't change anymore + node.child._str = childKey + + this.minimizedNodes[childKey] = node.child + } + + this.uncheckedNodes.pop() + } +} +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * An index contains the built index of all documents and provides a query interface + * to the index. + * + * Usually instances of lunr.Index will not be created using this constructor, instead + * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be + * used to load previously built and serialized indexes. + * + * @constructor + * @param {Object} attrs - The attributes of the built search index. + * @param {Object} attrs.invertedIndex - An index of term/field to document reference. + * @param {Object} attrs.fieldVectors - Field vectors + * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens. + * @param {string[]} attrs.fields - The names of indexed document fields. + * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms. + */ +lunr.Index = function (attrs) { + this.invertedIndex = attrs.invertedIndex + this.fieldVectors = attrs.fieldVectors + this.tokenSet = attrs.tokenSet + this.fields = attrs.fields + this.pipeline = attrs.pipeline +} + +/** + * A result contains details of a document matching a search query. + * @typedef {Object} lunr.Index~Result + * @property {string} ref - The reference of the document this result represents. + * @property {number} score - A number between 0 and 1 representing how similar this document is to the query. + * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match. + */ + +/** + * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple + * query language which itself is parsed into an instance of lunr.Query. + * + * For programmatically building queries it is advised to directly use lunr.Query, the query language + * is best used for human entered text rather than program generated text. + * + * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported + * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello' + * or 'world', though those that contain both will rank higher in the results. + * + * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can + * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding + * wildcards will increase the number of documents that will be found but can also have a negative + * impact on query performance, especially with wildcards at the beginning of a term. + * + * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term + * hello in the title field will match this query. Using a field not present in the index will lead + * to an error being thrown. + * + * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term + * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported + * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2. + * Avoid large values for edit distance to improve query performance. + * + * Each term also supports a presence modifier. By default a term's presence in document is optional, however + * this can be changed to either required or prohibited. For a term's presence to be required in a document the + * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and + * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not + * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'. + * + * To escape special characters the backslash character '\' can be used, this allows searches to include + * characters that would normally be considered modifiers, e.g. `foo\~2` will search for a term "foo~2" instead + * of attempting to apply a boost of 2 to the search term "foo". + * + * @typedef {string} lunr.Index~QueryString + * @example Simple single term query + * hello + * @example Multiple term query + * hello world + * @example term scoped to a field + * title:hello + * @example term with a boost of 10 + * hello^10 + * @example term with an edit distance of 2 + * hello~2 + * @example terms with presence modifiers + * -foo +bar baz + */ + +/** + * Performs a search against the index using lunr query syntax. + * + * Results will be returned sorted by their score, the most relevant results + * will be returned first. For details on how the score is calculated, please see + * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}. + * + * For more programmatic querying use lunr.Index#query. + * + * @param {lunr.Index~QueryString} queryString - A string containing a lunr query. + * @throws {lunr.QueryParseError} If the passed query string cannot be parsed. + * @returns {lunr.Index~Result[]} + */ +lunr.Index.prototype.search = function (queryString) { + return this.query(function (query) { + var parser = new lunr.QueryParser(queryString, query) + parser.parse() + }) +} + +/** + * A query builder callback provides a query object to be used to express + * the query to perform on the index. + * + * @callback lunr.Index~queryBuilder + * @param {lunr.Query} query - The query object to build up. + * @this lunr.Query + */ + +/** + * Performs a query against the index using the yielded lunr.Query object. + * + * If performing programmatic queries against the index, this method is preferred + * over lunr.Index#search so as to avoid the additional query parsing overhead. + * + * A query object is yielded to the supplied function which should be used to + * express the query to be run against the index. + * + * Note that although this function takes a callback parameter it is _not_ an + * asynchronous operation, the callback is just yielded a query object to be + * customized. + * + * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query. + * @returns {lunr.Index~Result[]} + */ +lunr.Index.prototype.query = function (fn) { + // for each query clause + // * process terms + // * expand terms from token set + // * find matching documents and metadata + // * get document vectors + // * score documents + + var query = new lunr.Query(this.fields), + matchingFields = Object.create(null), + queryVectors = Object.create(null), + termFieldCache = Object.create(null), + requiredMatches = Object.create(null), + prohibitedMatches = Object.create(null) + + /* + * To support field level boosts a query vector is created per + * field. An empty vector is eagerly created to support negated + * queries. + */ + for (var i = 0; i < this.fields.length; i++) { + queryVectors[this.fields[i]] = new lunr.Vector + } + + fn.call(query, query) + + for (var i = 0; i < query.clauses.length; i++) { + /* + * Unless the pipeline has been disabled for this term, which is + * the case for terms with wildcards, we need to pass the clause + * term through the search pipeline. A pipeline returns an array + * of processed terms. Pipeline functions may expand the passed + * term, which means we may end up performing multiple index lookups + * for a single query term. + */ + var clause = query.clauses[i], + terms = null, + clauseMatches = lunr.Set.empty + + if (clause.usePipeline) { + terms = this.pipeline.runString(clause.term, { + fields: clause.fields + }) + } else { + terms = [clause.term] + } + + for (var m = 0; m < terms.length; m++) { + var term = terms[m] + + /* + * Each term returned from the pipeline needs to use the same query + * clause object, e.g. the same boost and or edit distance. The + * simplest way to do this is to re-use the clause object but mutate + * its term property. + */ + clause.term = term + + /* + * From the term in the clause we create a token set which will then + * be used to intersect the indexes token set to get a list of terms + * to lookup in the inverted index + */ + var termTokenSet = lunr.TokenSet.fromClause(clause), + expandedTerms = this.tokenSet.intersect(termTokenSet).toArray() + + /* + * If a term marked as required does not exist in the tokenSet it is + * impossible for the search to return any matches. We set all the field + * scoped required matches set to empty and stop examining any further + * clauses. + */ + if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = lunr.Set.empty + } + + break + } + + for (var j = 0; j < expandedTerms.length; j++) { + /* + * For each term get the posting and termIndex, this is required for + * building the query vector. + */ + var expandedTerm = expandedTerms[j], + posting = this.invertedIndex[expandedTerm], + termIndex = posting._index + + for (var k = 0; k < clause.fields.length; k++) { + /* + * For each field that this query term is scoped by (by default + * all fields are in scope) we need to get all the document refs + * that have this term in that field. + * + * The posting is the entry in the invertedIndex for the matching + * term from above. + */ + var field = clause.fields[k], + fieldPosting = posting[field], + matchingDocumentRefs = Object.keys(fieldPosting), + termField = expandedTerm + "/" + field, + matchingDocumentsSet = new lunr.Set(matchingDocumentRefs) + + /* + * if the presence of this term is required ensure that the matching + * documents are added to the set of required matches for this clause. + * + */ + if (clause.presence == lunr.Query.presence.REQUIRED) { + clauseMatches = clauseMatches.union(matchingDocumentsSet) + + if (requiredMatches[field] === undefined) { + requiredMatches[field] = lunr.Set.complete + } + } + + /* + * if the presence of this term is prohibited ensure that the matching + * documents are added to the set of prohibited matches for this field, + * creating that set if it does not yet exist. + */ + if (clause.presence == lunr.Query.presence.PROHIBITED) { + if (prohibitedMatches[field] === undefined) { + prohibitedMatches[field] = lunr.Set.empty + } + + prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet) + + /* + * Prohibited matches should not be part of the query vector used for + * similarity scoring and no metadata should be extracted so we continue + * to the next field + */ + continue + } + + /* + * The query field vector is populated using the termIndex found for + * the term and a unit value with the appropriate boost applied. + * Using upsert because there could already be an entry in the vector + * for the term we are working with. In that case we just add the scores + * together. + */ + queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b }) + + /** + * If we've already seen this term, field combo then we've already collected + * the matching documents and metadata, no need to go through all that again + */ + if (termFieldCache[termField]) { + continue + } + + for (var l = 0; l < matchingDocumentRefs.length; l++) { + /* + * All metadata for this term/field/document triple + * are then extracted and collected into an instance + * of lunr.MatchData ready to be returned in the query + * results + */ + var matchingDocumentRef = matchingDocumentRefs[l], + matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field), + metadata = fieldPosting[matchingDocumentRef], + fieldMatch + + if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) { + matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata) + } else { + fieldMatch.add(expandedTerm, field, metadata) + } + + } + + termFieldCache[termField] = true + } + } + } + + /** + * If the presence was required we need to update the requiredMatches field sets. + * We do this after all fields for the term have collected their matches because + * the clause terms presence is required in _any_ of the fields not _all_ of the + * fields. + */ + if (clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = requiredMatches[field].intersect(clauseMatches) + } + } + } + + /** + * Need to combine the field scoped required and prohibited + * matching documents into a global set of required and prohibited + * matches + */ + var allRequiredMatches = lunr.Set.complete, + allProhibitedMatches = lunr.Set.empty + + for (var i = 0; i < this.fields.length; i++) { + var field = this.fields[i] + + if (requiredMatches[field]) { + allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field]) + } + + if (prohibitedMatches[field]) { + allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field]) + } + } + + var matchingFieldRefs = Object.keys(matchingFields), + results = [], + matches = Object.create(null) + + /* + * If the query is negated (contains only prohibited terms) + * we need to get _all_ fieldRefs currently existing in the + * index. This is only done when we know that the query is + * entirely prohibited terms to avoid any cost of getting all + * fieldRefs unnecessarily. + * + * Additionally, blank MatchData must be created to correctly + * populate the results. + */ + if (query.isNegated()) { + matchingFieldRefs = Object.keys(this.fieldVectors) + + for (var i = 0; i < matchingFieldRefs.length; i++) { + var matchingFieldRef = matchingFieldRefs[i] + var fieldRef = lunr.FieldRef.fromString(matchingFieldRef) + matchingFields[matchingFieldRef] = new lunr.MatchData + } + } + + for (var i = 0; i < matchingFieldRefs.length; i++) { + /* + * Currently we have document fields that match the query, but we + * need to return documents. The matchData and scores are combined + * from multiple fields belonging to the same document. + * + * Scores are calculated by field, using the query vectors created + * above, and combined into a final document score using addition. + */ + var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]), + docRef = fieldRef.docRef + + if (!allRequiredMatches.contains(docRef)) { + continue + } + + if (allProhibitedMatches.contains(docRef)) { + continue + } + + var fieldVector = this.fieldVectors[fieldRef], + score = queryVectors[fieldRef.fieldName].similarity(fieldVector), + docMatch + + if ((docMatch = matches[docRef]) !== undefined) { + docMatch.score += score + docMatch.matchData.combine(matchingFields[fieldRef]) + } else { + var match = { + ref: docRef, + score: score, + matchData: matchingFields[fieldRef] + } + matches[docRef] = match + results.push(match) + } + } + + /* + * Sort the results objects by score, highest first. + */ + return results.sort(function (a, b) { + return b.score - a.score + }) +} + +/** + * Prepares the index for JSON serialization. + * + * The schema for this JSON blob will be described in a + * separate JSON schema file. + * + * @returns {Object} + */ +lunr.Index.prototype.toJSON = function () { + var invertedIndex = Object.keys(this.invertedIndex) + .sort() + .map(function (term) { + return [term, this.invertedIndex[term]] + }, this) + + var fieldVectors = Object.keys(this.fieldVectors) + .map(function (ref) { + return [ref, this.fieldVectors[ref].toJSON()] + }, this) + + return { + version: lunr.version, + fields: this.fields, + fieldVectors: fieldVectors, + invertedIndex: invertedIndex, + pipeline: this.pipeline.toJSON() + } +} + +/** + * Loads a previously serialized lunr.Index + * + * @param {Object} serializedIndex - A previously serialized lunr.Index + * @returns {lunr.Index} + */ +lunr.Index.load = function (serializedIndex) { + var attrs = {}, + fieldVectors = {}, + serializedVectors = serializedIndex.fieldVectors, + invertedIndex = Object.create(null), + serializedInvertedIndex = serializedIndex.invertedIndex, + tokenSetBuilder = new lunr.TokenSet.Builder, + pipeline = lunr.Pipeline.load(serializedIndex.pipeline) + + if (serializedIndex.version != lunr.version) { + lunr.utils.warn("Version mismatch when loading serialised index. Current version of lunr '" + lunr.version + "' does not match serialized index '" + serializedIndex.version + "'") + } + + for (var i = 0; i < serializedVectors.length; i++) { + var tuple = serializedVectors[i], + ref = tuple[0], + elements = tuple[1] + + fieldVectors[ref] = new lunr.Vector(elements) + } + + for (var i = 0; i < serializedInvertedIndex.length; i++) { + var tuple = serializedInvertedIndex[i], + term = tuple[0], + posting = tuple[1] + + tokenSetBuilder.insert(term) + invertedIndex[term] = posting + } + + tokenSetBuilder.finish() + + attrs.fields = serializedIndex.fields + + attrs.fieldVectors = fieldVectors + attrs.invertedIndex = invertedIndex + attrs.tokenSet = tokenSetBuilder.root + attrs.pipeline = pipeline + + return new lunr.Index(attrs) +} +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.Builder performs indexing on a set of documents and + * returns instances of lunr.Index ready for querying. + * + * All configuration of the index is done via the builder, the + * fields to index, the document reference, the text processing + * pipeline and document scoring parameters are all set on the + * builder before indexing. + * + * @constructor + * @property {string} _ref - Internal reference to the document reference field. + * @property {string[]} _fields - Internal reference to the document fields to index. + * @property {object} invertedIndex - The inverted index maps terms to document fields. + * @property {object} documentTermFrequencies - Keeps track of document term frequencies. + * @property {object} documentLengths - Keeps track of the length of documents added to the index. + * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing. + * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing. + * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index. + * @property {number} documentCount - Keeps track of the total number of documents indexed. + * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75. + * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2. + * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space. + * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index. + */ +lunr.Builder = function () { + this._ref = "id" + this._fields = Object.create(null) + this._documents = Object.create(null) + this.invertedIndex = Object.create(null) + this.fieldTermFrequencies = {} + this.fieldLengths = {} + this.tokenizer = lunr.tokenizer + this.pipeline = new lunr.Pipeline + this.searchPipeline = new lunr.Pipeline + this.documentCount = 0 + this._b = 0.75 + this._k1 = 1.2 + this.termIndex = 0 + this.metadataWhitelist = [] +} + +/** + * Sets the document field used as the document reference. Every document must have this field. + * The type of this field in the document should be a string, if it is not a string it will be + * coerced into a string by calling toString. + * + * The default ref is 'id'. + * + * The ref should _not_ be changed during indexing, it should be set before any documents are + * added to the index. Changing it during indexing can lead to inconsistent results. + * + * @param {string} ref - The name of the reference field in the document. + */ +lunr.Builder.prototype.ref = function (ref) { + this._ref = ref +} + +/** + * A function that is used to extract a field from a document. + * + * Lunr expects a field to be at the top level of a document, if however the field + * is deeply nested within a document an extractor function can be used to extract + * the right field for indexing. + * + * @callback fieldExtractor + * @param {object} doc - The document being added to the index. + * @returns {?(string|object|object[])} obj - The object that will be indexed for this field. + * @example Extracting a nested field + * function (doc) { return doc.nested.field } + */ + +/** + * Adds a field to the list of document fields that will be indexed. Every document being + * indexed should have this field. Null values for this field in indexed documents will + * not cause errors but will limit the chance of that document being retrieved by searches. + * + * All fields should be added before adding documents to the index. Adding fields after + * a document has been indexed will have no effect on already indexed documents. + * + * Fields can be boosted at build time. This allows terms within that field to have more + * importance when ranking search results. Use a field boost to specify that matches within + * one field are more important than other fields. + * + * @param {string} fieldName - The name of a field to index in all documents. + * @param {object} attributes - Optional attributes associated with this field. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this field. + * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document. + * @throws {RangeError} fieldName cannot contain unsupported characters '/' + */ +lunr.Builder.prototype.field = function (fieldName, attributes) { + if (/\//.test(fieldName)) { + throw new RangeError ("Field '" + fieldName + "' contains illegal character '/'") + } + + this._fields[fieldName] = attributes || {} +} + +/** + * A parameter to tune the amount of field length normalisation that is applied when + * calculating relevance scores. A value of 0 will completely disable any normalisation + * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b + * will be clamped to the range 0 - 1. + * + * @param {number} number - The value to set for this tuning parameter. + */ +lunr.Builder.prototype.b = function (number) { + if (number < 0) { + this._b = 0 + } else if (number > 1) { + this._b = 1 + } else { + this._b = number + } +} + +/** + * A parameter that controls the speed at which a rise in term frequency results in term + * frequency saturation. The default value is 1.2. Setting this to a higher value will give + * slower saturation levels, a lower value will result in quicker saturation. + * + * @param {number} number - The value to set for this tuning parameter. + */ +lunr.Builder.prototype.k1 = function (number) { + this._k1 = number +} + +/** + * Adds a document to the index. + * + * Before adding fields to the index the index should have been fully setup, with the document + * ref and all fields to index already having been specified. + * + * The document must have a field name as specified by the ref (by default this is 'id') and + * it should have all fields defined for indexing, though null or undefined values will not + * cause errors. + * + * Entire documents can be boosted at build time. Applying a boost to a document indicates that + * this document should rank higher in search results than other documents. + * + * @param {object} doc - The document to add to the index. + * @param {object} attributes - Optional attributes associated with this document. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this document. + */ +lunr.Builder.prototype.add = function (doc, attributes) { + var docRef = doc[this._ref], + fields = Object.keys(this._fields) + + this._documents[docRef] = attributes || {} + this.documentCount += 1 + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i], + extractor = this._fields[fieldName].extractor, + field = extractor ? extractor(doc) : doc[fieldName], + tokens = this.tokenizer(field, { + fields: [fieldName] + }), + terms = this.pipeline.run(tokens), + fieldRef = new lunr.FieldRef (docRef, fieldName), + fieldTerms = Object.create(null) + + this.fieldTermFrequencies[fieldRef] = fieldTerms + this.fieldLengths[fieldRef] = 0 + + // store the length of this field for this document + this.fieldLengths[fieldRef] += terms.length + + // calculate term frequencies for this field + for (var j = 0; j < terms.length; j++) { + var term = terms[j] + + if (fieldTerms[term] == undefined) { + fieldTerms[term] = 0 + } + + fieldTerms[term] += 1 + + // add to inverted index + // create an initial posting if one doesn't exist + if (this.invertedIndex[term] == undefined) { + var posting = Object.create(null) + posting["_index"] = this.termIndex + this.termIndex += 1 + + for (var k = 0; k < fields.length; k++) { + posting[fields[k]] = Object.create(null) + } + + this.invertedIndex[term] = posting + } + + // add an entry for this term/fieldName/docRef to the invertedIndex + if (this.invertedIndex[term][fieldName][docRef] == undefined) { + this.invertedIndex[term][fieldName][docRef] = Object.create(null) + } + + // store all whitelisted metadata about this token in the + // inverted index + for (var l = 0; l < this.metadataWhitelist.length; l++) { + var metadataKey = this.metadataWhitelist[l], + metadata = term.metadata[metadataKey] + + if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) { + this.invertedIndex[term][fieldName][docRef][metadataKey] = [] + } + + this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata) + } + } + + } +} + +/** + * Calculates the average document length for this index + * + * @private + */ +lunr.Builder.prototype.calculateAverageFieldLengths = function () { + + var fieldRefs = Object.keys(this.fieldLengths), + numberOfFields = fieldRefs.length, + accumulator = {}, + documentsWithField = {} + + for (var i = 0; i < numberOfFields; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + field = fieldRef.fieldName + + documentsWithField[field] || (documentsWithField[field] = 0) + documentsWithField[field] += 1 + + accumulator[field] || (accumulator[field] = 0) + accumulator[field] += this.fieldLengths[fieldRef] + } + + var fields = Object.keys(this._fields) + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i] + accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName] + } + + this.averageFieldLength = accumulator +} + +/** + * Builds a vector space model of every document using lunr.Vector + * + * @private + */ +lunr.Builder.prototype.createFieldVectors = function () { + var fieldVectors = {}, + fieldRefs = Object.keys(this.fieldTermFrequencies), + fieldRefsLength = fieldRefs.length, + termIdfCache = Object.create(null) + + for (var i = 0; i < fieldRefsLength; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + fieldName = fieldRef.fieldName, + fieldLength = this.fieldLengths[fieldRef], + fieldVector = new lunr.Vector, + termFrequencies = this.fieldTermFrequencies[fieldRef], + terms = Object.keys(termFrequencies), + termsLength = terms.length + + + var fieldBoost = this._fields[fieldName].boost || 1, + docBoost = this._documents[fieldRef.docRef].boost || 1 + + for (var j = 0; j < termsLength; j++) { + var term = terms[j], + tf = termFrequencies[term], + termIndex = this.invertedIndex[term]._index, + idf, score, scoreWithPrecision + + if (termIdfCache[term] === undefined) { + idf = lunr.idf(this.invertedIndex[term], this.documentCount) + termIdfCache[term] = idf + } else { + idf = termIdfCache[term] + } + + score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf) + score *= fieldBoost + score *= docBoost + scoreWithPrecision = Math.round(score * 1000) / 1000 + // Converts 1.23456789 to 1.234. + // Reducing the precision so that the vectors take up less + // space when serialised. Doing it now so that they behave + // the same before and after serialisation. Also, this is + // the fastest approach to reducing a number's precision in + // JavaScript. + + fieldVector.insert(termIndex, scoreWithPrecision) + } + + fieldVectors[fieldRef] = fieldVector + } + + this.fieldVectors = fieldVectors +} + +/** + * Creates a token set of all tokens in the index using lunr.TokenSet + * + * @private + */ +lunr.Builder.prototype.createTokenSet = function () { + this.tokenSet = lunr.TokenSet.fromArray( + Object.keys(this.invertedIndex).sort() + ) +} + +/** + * Builds the index, creating an instance of lunr.Index. + * + * This completes the indexing process and should only be called + * once all documents have been added to the index. + * + * @returns {lunr.Index} + */ +lunr.Builder.prototype.build = function () { + this.calculateAverageFieldLengths() + this.createFieldVectors() + this.createTokenSet() + + return new lunr.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline + }) +} + +/** + * Applies a plugin to the index builder. + * + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + * + * @param {Function} plugin The plugin to apply. + */ +lunr.Builder.prototype.use = function (fn) { + var args = Array.prototype.slice.call(arguments, 1) + args.unshift(this) + fn.apply(this, args) +} +/** + * Contains and collects metadata about a matching document. + * A single instance of lunr.MatchData is returned as part of every + * lunr.Index~Result. + * + * @constructor + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + * @property {object} metadata - A cloned collection of metadata associated with this document. + * @see {@link lunr.Index~Result} + */ +lunr.MatchData = function (term, field, metadata) { + var clonedMetadata = Object.create(null), + metadataKeys = Object.keys(metadata || {}) + + // Cloning the metadata to prevent the original + // being mutated during match data combination. + // Metadata is kept in an array within the inverted + // index so cloning the data can be done with + // Array#slice + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + clonedMetadata[key] = metadata[key].slice() + } + + this.metadata = Object.create(null) + + if (term !== undefined) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = clonedMetadata + } +} + +/** + * An instance of lunr.MatchData will be created for every term that matches a + * document. However only one instance is required in a lunr.Index~Result. This + * method combines metadata from another instance of lunr.MatchData with this + * objects metadata. + * + * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one. + * @see {@link lunr.Index~Result} + */ +lunr.MatchData.prototype.combine = function (otherMatchData) { + var terms = Object.keys(otherMatchData.metadata) + + for (var i = 0; i < terms.length; i++) { + var term = terms[i], + fields = Object.keys(otherMatchData.metadata[term]) + + if (this.metadata[term] == undefined) { + this.metadata[term] = Object.create(null) + } + + for (var j = 0; j < fields.length; j++) { + var field = fields[j], + keys = Object.keys(otherMatchData.metadata[term][field]) + + if (this.metadata[term][field] == undefined) { + this.metadata[term][field] = Object.create(null) + } + + for (var k = 0; k < keys.length; k++) { + var key = keys[k] + + if (this.metadata[term][field][key] == undefined) { + this.metadata[term][field][key] = otherMatchData.metadata[term][field][key] + } else { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key]) + } + + } + } + } +} + +/** + * Add metadata for a term/field pair to this instance of match data. + * + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + */ +lunr.MatchData.prototype.add = function (term, field, metadata) { + if (!(term in this.metadata)) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = metadata + return + } + + if (!(field in this.metadata[term])) { + this.metadata[term][field] = metadata + return + } + + var metadataKeys = Object.keys(metadata) + + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + + if (key in this.metadata[term][field]) { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key]) + } else { + this.metadata[term][field][key] = metadata[key] + } + } +} +/** + * A lunr.Query provides a programmatic way of defining queries to be performed + * against a {@link lunr.Index}. + * + * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method + * so the query object is pre-initialized with the right index fields. + * + * @constructor + * @property {lunr.Query~Clause[]} clauses - An array of query clauses. + * @property {string[]} allFields - An array of all available fields in a lunr.Index. + */ +lunr.Query = function (allFields) { + this.clauses = [] + this.allFields = allFields +} + +/** + * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause. + * + * This allows wildcards to be added to the beginning and end of a term without having to manually do any string + * concatenation. + * + * The wildcard constants can be bitwise combined to select both leading and trailing wildcards. + * + * @constant + * @default + * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour + * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists + * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with trailing wildcard + * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING }) + * @example query term with leading and trailing wildcard + * query.term('foo', { + * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING + * }) + */ + +lunr.Query.wildcard = new String ("*") +lunr.Query.wildcard.NONE = 0 +lunr.Query.wildcard.LEADING = 1 +lunr.Query.wildcard.TRAILING = 2 + +/** + * Constants for indicating what kind of presence a term must have in matching documents. + * + * @constant + * @enum {number} + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with required presence + * query.term('foo', { presence: lunr.Query.presence.REQUIRED }) + */ +lunr.Query.presence = { + /** + * Term's presence in a document is optional, this is the default value. + */ + OPTIONAL: 1, + + /** + * Term's presence in a document is required, documents that do not contain + * this term will not be returned. + */ + REQUIRED: 2, + + /** + * Term's presence in a document is prohibited, documents that do contain + * this term will not be returned. + */ + PROHIBITED: 3 +} + +/** + * A single clause in a {@link lunr.Query} contains a term and details on how to + * match that term against a {@link lunr.Index}. + * + * @typedef {Object} lunr.Query~Clause + * @property {string[]} fields - The fields in an index this clause should be matched against. + * @property {number} [boost=1] - Any boost that should be applied when matching this clause. + * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be. + * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline. + * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended. + * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents. + */ + +/** + * Adds a {@link lunr.Query~Clause} to this query. + * + * Unless the clause contains the fields to be matched all fields will be matched. In addition + * a default boost of 1 is applied to the clause. + * + * @param {lunr.Query~Clause} clause - The clause to add to this query. + * @see lunr.Query~Clause + * @returns {lunr.Query} + */ +lunr.Query.prototype.clause = function (clause) { + if (!('fields' in clause)) { + clause.fields = this.allFields + } + + if (!('boost' in clause)) { + clause.boost = 1 + } + + if (!('usePipeline' in clause)) { + clause.usePipeline = true + } + + if (!('wildcard' in clause)) { + clause.wildcard = lunr.Query.wildcard.NONE + } + + if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) { + clause.term = "*" + clause.term + } + + if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) { + clause.term = "" + clause.term + "*" + } + + if (!('presence' in clause)) { + clause.presence = lunr.Query.presence.OPTIONAL + } + + this.clauses.push(clause) + + return this +} + +/** + * A negated query is one in which every clause has a presence of + * prohibited. These queries require some special processing to return + * the expected results. + * + * @returns boolean + */ +lunr.Query.prototype.isNegated = function () { + for (var i = 0; i < this.clauses.length; i++) { + if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) { + return false + } + } + + return true +} + +/** + * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause} + * to the list of clauses that make up this query. + * + * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion + * to a token or token-like string should be done before calling this method. + * + * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an + * array, each term in the array will share the same options. + * + * @param {object|object[]} term - The term(s) to add to the query. + * @param {object} [options] - Any additional properties to add to the query clause. + * @returns {lunr.Query} + * @see lunr.Query#clause + * @see lunr.Query~Clause + * @example adding a single term to a query + * query.term("foo") + * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard + * query.term("foo", { + * fields: ["title"], + * boost: 10, + * wildcard: lunr.Query.wildcard.TRAILING + * }) + * @example using lunr.tokenizer to convert a string to tokens before using them as terms + * query.term(lunr.tokenizer("foo bar")) + */ +lunr.Query.prototype.term = function (term, options) { + if (Array.isArray(term)) { + term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this) + return this + } + + var clause = options || {} + clause.term = term.toString() + + this.clause(clause) + + return this +} +lunr.QueryParseError = function (message, start, end) { + this.name = "QueryParseError" + this.message = message + this.start = start + this.end = end +} + +lunr.QueryParseError.prototype = new Error +lunr.QueryLexer = function (str) { + this.lexemes = [] + this.str = str + this.length = str.length + this.pos = 0 + this.start = 0 + this.escapeCharPositions = [] +} + +lunr.QueryLexer.prototype.run = function () { + var state = lunr.QueryLexer.lexText + + while (state) { + state = state(this) + } +} + +lunr.QueryLexer.prototype.sliceString = function () { + var subSlices = [], + sliceStart = this.start, + sliceEnd = this.pos + + for (var i = 0; i < this.escapeCharPositions.length; i++) { + sliceEnd = this.escapeCharPositions[i] + subSlices.push(this.str.slice(sliceStart, sliceEnd)) + sliceStart = sliceEnd + 1 + } + + subSlices.push(this.str.slice(sliceStart, this.pos)) + this.escapeCharPositions.length = 0 + + return subSlices.join('') +} + +lunr.QueryLexer.prototype.emit = function (type) { + this.lexemes.push({ + type: type, + str: this.sliceString(), + start: this.start, + end: this.pos + }) + + this.start = this.pos +} + +lunr.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1) + this.pos += 1 +} + +lunr.QueryLexer.prototype.next = function () { + if (this.pos >= this.length) { + return lunr.QueryLexer.EOS + } + + var char = this.str.charAt(this.pos) + this.pos += 1 + return char +} + +lunr.QueryLexer.prototype.width = function () { + return this.pos - this.start +} + +lunr.QueryLexer.prototype.ignore = function () { + if (this.start == this.pos) { + this.pos += 1 + } + + this.start = this.pos +} + +lunr.QueryLexer.prototype.backup = function () { + this.pos -= 1 +} + +lunr.QueryLexer.prototype.acceptDigitRun = function () { + var char, charCode + + do { + char = this.next() + charCode = char.charCodeAt(0) + } while (charCode > 47 && charCode < 58) + + if (char != lunr.QueryLexer.EOS) { + this.backup() + } +} + +lunr.QueryLexer.prototype.more = function () { + return this.pos < this.length +} + +lunr.QueryLexer.EOS = 'EOS' +lunr.QueryLexer.FIELD = 'FIELD' +lunr.QueryLexer.TERM = 'TERM' +lunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE' +lunr.QueryLexer.BOOST = 'BOOST' +lunr.QueryLexer.PRESENCE = 'PRESENCE' + +lunr.QueryLexer.lexField = function (lexer) { + lexer.backup() + lexer.emit(lunr.QueryLexer.FIELD) + lexer.ignore() + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexTerm = function (lexer) { + if (lexer.width() > 1) { + lexer.backup() + lexer.emit(lunr.QueryLexer.TERM) + } + + lexer.ignore() + + if (lexer.more()) { + return lunr.QueryLexer.lexText + } +} + +lunr.QueryLexer.lexEditDistance = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.EDIT_DISTANCE) + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexBoost = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.BOOST) + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexEOS = function (lexer) { + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } +} + +// This matches the separator used when tokenising fields +// within a document. These should match otherwise it is +// not possible to search for some tokens within a document. +// +// It is possible for the user to change the separator on the +// tokenizer so it _might_ clash with any other of the special +// characters already used within the search string, e.g. :. +// +// This means that it is possible to change the separator in +// such a way that makes some words unsearchable using a search +// string. +lunr.QueryLexer.termSeparator = lunr.tokenizer.separator + +lunr.QueryLexer.lexText = function (lexer) { + while (true) { + var char = lexer.next() + + if (char == lunr.QueryLexer.EOS) { + return lunr.QueryLexer.lexEOS + } + + // Escape character is '\' + if (char.charCodeAt(0) == 92) { + lexer.escapeCharacter() + continue + } + + if (char == ":") { + return lunr.QueryLexer.lexField + } + + if (char == "~") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexEditDistance + } + + if (char == "^") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexBoost + } + + // "+" indicates term presence is required + // checking for length to ensure that only + // leading "+" are considered + if (char == "+" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + // "-" indicates term presence is prohibited + // checking for length to ensure that only + // leading "-" are considered + if (char == "-" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + if (char.match(lunr.QueryLexer.termSeparator)) { + return lunr.QueryLexer.lexTerm + } + } +} + +lunr.QueryParser = function (str, query) { + this.lexer = new lunr.QueryLexer (str) + this.query = query + this.currentClause = {} + this.lexemeIdx = 0 +} + +lunr.QueryParser.prototype.parse = function () { + this.lexer.run() + this.lexemes = this.lexer.lexemes + + var state = lunr.QueryParser.parseClause + + while (state) { + state = state(this) + } + + return this.query +} + +lunr.QueryParser.prototype.peekLexeme = function () { + return this.lexemes[this.lexemeIdx] +} + +lunr.QueryParser.prototype.consumeLexeme = function () { + var lexeme = this.peekLexeme() + this.lexemeIdx += 1 + return lexeme +} + +lunr.QueryParser.prototype.nextClause = function () { + var completedClause = this.currentClause + this.query.clause(completedClause) + this.currentClause = {} +} + +lunr.QueryParser.parseClause = function (parser) { + var lexeme = parser.peekLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.type) { + case lunr.QueryLexer.PRESENCE: + return lunr.QueryParser.parsePresence + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expected either a field or a term, found " + lexeme.type + + if (lexeme.str.length >= 1) { + errorMessage += " with value '" + lexeme.str + "'" + } + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } +} + +lunr.QueryParser.parsePresence = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.str) { + case "-": + parser.currentClause.presence = lunr.Query.presence.PROHIBITED + break + case "+": + parser.currentClause.presence = lunr.Query.presence.REQUIRED + break + default: + var errorMessage = "unrecognised presence operator'" + lexeme.str + "'" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term or field, found nothing" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term or field, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseField = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + if (parser.query.allFields.indexOf(lexeme.str) == -1) { + var possibleFields = parser.query.allFields.map(function (f) { return "'" + f + "'" }).join(', '), + errorMessage = "unrecognised field '" + lexeme.str + "', possible fields: " + possibleFields + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.fields = [lexeme.str] + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term, found nothing" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseTerm = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + parser.currentClause.term = lexeme.str.toLowerCase() + + if (lexeme.str.indexOf("*") != -1) { + parser.currentClause.usePipeline = false + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseEditDistance = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var editDistance = parseInt(lexeme.str, 10) + + if (isNaN(editDistance)) { + var errorMessage = "edit distance must be numeric" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.editDistance = editDistance + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseBoost = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var boost = parseInt(lexeme.str, 10) + + if (isNaN(boost)) { + var errorMessage = "boost must be numeric" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.boost = boost + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + + /** + * export the module via AMD, CommonJS or as a browser global + * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js + */ + ;(function (root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(factory) + } else if (typeof exports === 'object') { + /** + * Node. Does not work with strict CommonJS, but + * only CommonJS-like environments that support module.exports, + * like Node. + */ + module.exports = factory() + } else { + // Browser globals (root is window) + root.lunr = factory() + } + }(this, function () { + /** + * Just return a value to define the module export. + * This example returns an object, but the module + * can return a function as the exported value. + */ + return lunr + })) +})(); diff --git a/search/main.js b/search/main.js new file mode 100644 index 0000000..a5e469d --- /dev/null +++ b/search/main.js @@ -0,0 +1,109 @@ +function getSearchTermFromLocation() { + var sPageURL = window.location.search.substring(1); + var sURLVariables = sPageURL.split('&'); + for (var i = 0; i < sURLVariables.length; i++) { + var sParameterName = sURLVariables[i].split('='); + if (sParameterName[0] == 'q') { + return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); + } + } +} + +function joinUrl (base, path) { + if (path.substring(0, 1) === "/") { + // path starts with `/`. Thus it is absolute. + return path; + } + if (base.substring(base.length-1) === "/") { + // base ends with `/` + return base + path; + } + return base + "/" + path; +} + +function escapeHtml (value) { + return value.replace(/&/g, '&') + .replace(/"/g, '"') + .replace(//g, '>'); +} + +function formatResult (location, title, summary) { + return ''; +} + +function displayResults (results) { + var search_results = document.getElementById("mkdocs-search-results"); + while (search_results.firstChild) { + search_results.removeChild(search_results.firstChild); + } + if (results.length > 0){ + for (var i=0; i < results.length; i++){ + var result = results[i]; + var html = formatResult(result.location, result.title, result.summary); + search_results.insertAdjacentHTML('beforeend', html); + } + } else { + var noResultsText = search_results.getAttribute('data-no-results-text'); + if (!noResultsText) { + noResultsText = "No results found"; + } + search_results.insertAdjacentHTML('beforeend', '

' + noResultsText + '

'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..713e63b --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Ro-DOU O Ro-DOU \u00e9 uma ferramenta que efetua um clipping do Di\u00e1rio Oficial da Uni\u00e3o ( D.O.U. ) e dos Di\u00e1rios Oficiais de munic\u00edpios, por meio do Querido Di\u00e1rio . O Ro-DOU permite o recebimento de notifica\u00e7\u00f5es (via e-mail, Slack, Discord ou outros) de todas as publica\u00e7\u00f5es que contenham as palavras-chaves que voc\u00ea definir. Neste site, voc\u00ea encontrar\u00e1 informa\u00e7\u00f5es sobre como usar o Ro-DOU e quais funcionalidades ele proporciona, al\u00e9m de outras informa\u00e7\u00f5es sobre como contribuir para melhorar a ferramenta e como contatar o MGI. O Ro-DOU \u00e9 uma solu\u00e7\u00e3o desenvolvida pela Secretaria de Gest\u00e3o e Inova\u00e7\u00e3o do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos .","title":"P\u00e1gina Inicial"},{"location":"#ro-dou","text":"O Ro-DOU \u00e9 uma ferramenta que efetua um clipping do Di\u00e1rio Oficial da Uni\u00e3o ( D.O.U. ) e dos Di\u00e1rios Oficiais de munic\u00edpios, por meio do Querido Di\u00e1rio . O Ro-DOU permite o recebimento de notifica\u00e7\u00f5es (via e-mail, Slack, Discord ou outros) de todas as publica\u00e7\u00f5es que contenham as palavras-chaves que voc\u00ea definir. Neste site, voc\u00ea encontrar\u00e1 informa\u00e7\u00f5es sobre como usar o Ro-DOU e quais funcionalidades ele proporciona, al\u00e9m de outras informa\u00e7\u00f5es sobre como contribuir para melhorar a ferramenta e como contatar o MGI. O Ro-DOU \u00e9 uma solu\u00e7\u00e3o desenvolvida pela Secretaria de Gest\u00e3o e Inova\u00e7\u00e3o do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos .","title":"Ro-DOU"},{"location":"changelog/changelog/","text":"Changelog As principais mudan\u00e7as realizadas no reposit\u00f3rio do Ro-dou est\u00e3o documentadas aqui a partir de 25/04/2023. [0.3.0] - 2024-11-12 What's Changed Permitir busca no Querido Di\u00e1rio para um grupo de munic\u00edpios by @slfabio in https://github.com/gestaogovbr/Ro-dou/pull/148 A partir desta mudan\u00e7a, \u00e9 permitido informar uma lista de munic\u00edpios para buscas no Querido Di\u00e1rio. Cria novo par\u00e2metro de filtro por tipo de publica\u00e7\u00e3o by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/154 O par\u00e2metro pubtype permite filtrar publica\u00e7\u00f5es tanto no DOU quanto no INLABS com base no tipo (Decreto, Lei, Ata, etc.). Melhorias no deployment local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/156 \ud83d\ude80 Outros Update CHANGELOG.md for 0.2.4 by @github-actions in https://github.com/gestaogovbr/Ro-dou/pull/145 New Contributors @slfabio made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/148 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.4...0.2.5 [0.2.4] - 2024-09-10 What's Changed Hotfix Corrige resultados incompletos na busca com filtros por unidades b57b486a2fb692e3e664e764dcc5e2c0f83c9948 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.3...0.2.4 [0.2.3] - 2024-09-04 What's Changed Hotfix Ajusta o c\u00f3digo para utilizar XCom_pull de m\u00faltiplos Tasks IDs no Airflow 2.10.0. by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/140 \ud83d\ude80 Outros Ignore markdown files in CI Tests by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/141 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.2...0.2.3 [0.2.2] - 2024-09-02 What's Changed Upgrade Airflow to 2.10.0 by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/137 \ud83d\ude80 Outros Cast tags to a list when generating dags by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/135 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.1...0.2.2 [0.2.1] - 2024-08-30 What's Changed Criar busca de exemplo para DOU e Querido Di\u00e1rio (modo misto) by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/132 \ud83d\ude80 Outros Hotfix by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/131 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.0...0.2.1 [0.2.0] - 2024-08-29 What's Changed Os resultados agora s\u00e3o agrupados por unidade, quando informada. Utiliza\u00e7\u00e3o do Pydantic para valida\u00e7\u00e3o dos campos do yaml. \ud83d\ude80 Outros Agrupar resultados por unidade by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/122 Migrate yaml file validation from JSON schema to Pydantic schemas by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/118 Fix logic operators in result_as_html function by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/123 Add syspath for schemas and change dag.owners to string by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/125 Alter trigger to run CI Tests on push only to main branch by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/127 Hotfix para corre\u00e7\u00e3o de vari\u00e1vel no m\u00f3dulo de envio de email by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/128 Corrige as linhas e colunas na exporta\u00e7\u00e3o via CSV by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/129 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.5...0.2.0 [0.1.5] - 2024-08-09 What's Changed Cria par\u00e2metro opcional para uso da ementa (se houver) da publica\u00e7\u00e3o ao inv\u00e9s da janela de contexto ou texto completo. by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/113 Cria par\u00e2metro para uso de dataset no Data-Aware Schedulling. O schedule da DAG agora pode ser definido por tr\u00eas meios: cron, dataset ou cron + dataset by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/115 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.4...0.1.5 [0.1.4] - 2024-07-30 What's Changed Close p tag in watermark by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/109 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.3...0.1.4 [0.1.3] - 2024-07-25 Cria a nova p\u00e1gina de documenta\u00e7\u00e3o do Ro-DOU no Github Pages Cria a marca d'agua do Ro-DOU no template do email Adiciona quebra de linhas no texto no modo full_text (INLABS) Corrige bug quando a pagina\u00e7\u00e3o de resultados \u00e9 igual a 2 (DOU) What's Changed Update README.md by @marcelosinnerworkings in https://github.com/gestaogovbr/Ro-dou/pull/95 Fix format for Outlook display by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/96 Force justify text by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/97 Include parameter for dynamic no result text in notification by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/98 add dataset trigger scheduler by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/99 Fix pagination by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/104 Keep line breaks in full text mode by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/105 Add watermark in email template by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/108 New Contributors @marcelosinnerworkings made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/95 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.2...0.1.3 [0.1.2] Integra\u00e7\u00e3o com o portal INLABS, da Imprensa Nacional, permitindo a leitura das edi\u00e7\u00f5es do DOU pelos arquivos XML Remove depend\u00eancias com o framework FastETL Cria filtro de pesquisa por unidade (department) Cria op\u00e7\u00e3o de exibi\u00e7\u00e3o de texto completo da publica\u00e7\u00e3o Cria op\u00e7\u00e3o de busca avan\u00e7ada usando operadores l\u00f3gicos (INLABS) Implementa a op\u00e7\u00e3o de m\u00faltiplos searchs no mesmo YAML Cria op\u00e7\u00e3o para omitir metadados (hide_filter) no relat\u00f3rio do clipping Cria op\u00e7\u00e3o para permitir inclus\u00e3o de cabe\u00e7alho e rodap\u00e9 no corpo do relat\u00f3rio Formata o texto para modo justificado What's Changed Move DOUhook from FastETL to Ro-dou src by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/66 Validate yaml by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/75 Create filter for department by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/77 change exact search to consider special characters by @gutaors in https://github.com/gestaogovbr/Ro-dou/pull/80 Inlabs db by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/81 add full_text option by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/82 Implement search with logical operators by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/85 Implement subsearchs by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/87 Fix select_terms_from_db bug by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/88 Create param hide_filter by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/90 Hide filters for slack and discord by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/91 Add Header and footer text by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/93 Justify text in email report by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/94 New Contributors @gutaors made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/80 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.1...0.1.2 [0.1.1] What's Changed fix css file access [0.1.0] - 2023-08-31 Altera a forma de encontrar os arquivos de configura\u00e7\u00e3o das DAGs ( dag_confs/*.yml ). Antes considerava que a pasta dag_confs/ estava na mesma raiz que os arquivos do ro-dou em ./src . Agora o caminho da(s) pasta(s) deve ser informado pela vari\u00e1vel de ambiente RO_DOU__DAG_CONF_DIR e separado por : quando mais de um. Exemplo: As pastas /opt/airflow/dags/repo1/dag_confs e /opt/airflow/dags/repo2/dag_confs possuem arquivos de configura\u00e7\u00e3o (yaml) para gera\u00e7\u00e3o das DAGs do rodou. A vari\u00e1vel de ambiente RO_DOU__DAG_CONF_DIR deve ser atribu\u00edda assim: RO_DOU__DAG_CONF_DIR=/opt/airflow/dags/repo1/dag_confs:/opt/airflow/dags/repo2/dag_confs Esta altera\u00e7\u00e3o permite que os arquivos de configura\u00e7\u00e3o das DAGs ( dag_confs/*.yml ) estejam em qualquer pasta da m\u00e1quina ou container. What's Changed Change name organization economia to gestao by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/60 change dag_confs search by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/62 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.0.7...0.1.0 [0.0.7] 2023-04-27 What's Changed fix workflow docker build publish [0.0.6] 2023-04-27 What's Changed fix workflow docker build publish [0.0.5] 2023-04-27 What's Changed fix workflow docker build publish [0.0.4] 2023-04-27 What's Changed fix workflow docker build publish [0.0.3] 2023-04-27 What's Changed fix workflow docker build publish [0.0.2] 2023-04-25 What's Changed Conjunto de mudan\u00e7as para v.1 by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/4 Cria resili\u00eancia na chamada da API do DOU by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/5 Cria op\u00e7\u00e3o de pesquisa no Querido Di\u00e1rio by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/14 Trigger date horario local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/17 altera template de data do t\u00edtulo do email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/18 Incluir servi\u00e7o do selenium no docker-compose.yml by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/22 Adiciona tentativas de execu\u00e7\u00e3o na fun\u00e7\u00e3o search_text_with_retry by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/23 Criar par\u00e2metro para enviar email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/24 Make tests run in colored output by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/25 Implementa feature de documenta\u00e7\u00e3o markdown e informa\u00e7\u00f5es \u00fateis by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/31 Add documentation and separate tests for DAG Docs by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/34 Fix spelling in \"links\" by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/35 Fix searching terms read from database by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/39 remove selenium from Ro-dou by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/40 Mount as a volume only the modules used by Ro-DOU by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/44 Upgrade actions/checkout to v3 in CI by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/47 [dou_dag_generator] enables to find ro_dou folder inside airflow dags\u2026 by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/49 Decouple this project from the airflow2-docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/51 Bundle src code and plugin into docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/53 [WIP] Discord Integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/50 Workflow to build and publish docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/54 update fastetl import by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/56 Slack integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/58 New Contributors @nitaibezerra made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/4 Full Changelog : https://github.com/gestaogovbr/Ro-dou/commits/0.0.2 [0.0.1] 2023-04-25 What's Changed Conjunto de mudan\u00e7as para v.1 by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/4 Cria resili\u00eancia na chamada da API do DOU by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/5 Cria op\u00e7\u00e3o de pesquisa no Querido Di\u00e1rio by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/14 Trigger date horario local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/17 altera template de data do t\u00edtulo do email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/18 Incluir servi\u00e7o do selenium no docker-compose.yml by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/22 Adiciona tentativas de execu\u00e7\u00e3o na fun\u00e7\u00e3o search_text_with_retry by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/23 Criar par\u00e2metro para enviar email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/24 Make tests run in colored output by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/25 Implementa feature de documenta\u00e7\u00e3o markdown e informa\u00e7\u00f5es \u00fateis by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/31 Add documentation and separate tests for DAG Docs by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/34 Fix spelling in \"links\" by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/35 Fix searching terms read from database by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/39 remove selenium from Ro-dou by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/40 Mount as a volume only the modules used by Ro-DOU by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/44 Upgrade actions/checkout to v3 in CI by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/47 [dou_dag_generator] enables to find ro_dou folder inside airflow dags\u2026 by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/49 Decouple this project from the airflow2-docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/51 Bundle src code and plugin into docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/53 [WIP] Discord Integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/50 Workflow to build and publish docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/54 update fastetl import by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/56 Slack integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/58 New Contributors @nitaibezerra made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/4 Full Changelog : https://github.com/gestaogovbr/Ro-dou/commits/0.0.1","title":"Changelog"},{"location":"changelog/changelog/#changelog","text":"As principais mudan\u00e7as realizadas no reposit\u00f3rio do Ro-dou est\u00e3o documentadas aqui a partir de 25/04/2023.","title":"Changelog"},{"location":"changelog/changelog/#030-2024-11-12","text":"","title":"[0.3.0] - 2024-11-12"},{"location":"changelog/changelog/#whats-changed","text":"Permitir busca no Querido Di\u00e1rio para um grupo de munic\u00edpios by @slfabio in https://github.com/gestaogovbr/Ro-dou/pull/148 A partir desta mudan\u00e7a, \u00e9 permitido informar uma lista de munic\u00edpios para buscas no Querido Di\u00e1rio. Cria novo par\u00e2metro de filtro por tipo de publica\u00e7\u00e3o by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/154 O par\u00e2metro pubtype permite filtrar publica\u00e7\u00f5es tanto no DOU quanto no INLABS com base no tipo (Decreto, Lei, Ata, etc.). Melhorias no deployment local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/156","title":"What's Changed"},{"location":"changelog/changelog/#outros","text":"Update CHANGELOG.md for 0.2.4 by @github-actions in https://github.com/gestaogovbr/Ro-dou/pull/145","title":"\ud83d\ude80 Outros"},{"location":"changelog/changelog/#new-contributors","text":"@slfabio made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/148 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.4...0.2.5","title":"New Contributors"},{"location":"changelog/changelog/#024-2024-09-10","text":"","title":"[0.2.4] - 2024-09-10"},{"location":"changelog/changelog/#whats-changed_1","text":"","title":"What's Changed"},{"location":"changelog/changelog/#hotfix","text":"Corrige resultados incompletos na busca com filtros por unidades b57b486a2fb692e3e664e764dcc5e2c0f83c9948 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.3...0.2.4","title":"Hotfix"},{"location":"changelog/changelog/#023-2024-09-04","text":"","title":"[0.2.3] - 2024-09-04"},{"location":"changelog/changelog/#whats-changed_2","text":"","title":"What's Changed"},{"location":"changelog/changelog/#hotfix_1","text":"Ajusta o c\u00f3digo para utilizar XCom_pull de m\u00faltiplos Tasks IDs no Airflow 2.10.0. by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/140","title":"Hotfix"},{"location":"changelog/changelog/#outros_1","text":"Ignore markdown files in CI Tests by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/141 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.2...0.2.3","title":"\ud83d\ude80 Outros"},{"location":"changelog/changelog/#022-2024-09-02","text":"","title":"[0.2.2] - 2024-09-02"},{"location":"changelog/changelog/#whats-changed_3","text":"Upgrade Airflow to 2.10.0 by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/137","title":"What's Changed"},{"location":"changelog/changelog/#outros_2","text":"Cast tags to a list when generating dags by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/135 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.1...0.2.2","title":"\ud83d\ude80 Outros"},{"location":"changelog/changelog/#021-2024-08-30","text":"","title":"[0.2.1] - 2024-08-30"},{"location":"changelog/changelog/#whats-changed_4","text":"Criar busca de exemplo para DOU e Querido Di\u00e1rio (modo misto) by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/132","title":"What's Changed"},{"location":"changelog/changelog/#outros_3","text":"Hotfix by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/131 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.2.0...0.2.1","title":"\ud83d\ude80 Outros"},{"location":"changelog/changelog/#020-2024-08-29","text":"","title":"[0.2.0] - 2024-08-29"},{"location":"changelog/changelog/#whats-changed_5","text":"Os resultados agora s\u00e3o agrupados por unidade, quando informada. Utiliza\u00e7\u00e3o do Pydantic para valida\u00e7\u00e3o dos campos do yaml.","title":"What's Changed"},{"location":"changelog/changelog/#outros_4","text":"Agrupar resultados por unidade by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/122 Migrate yaml file validation from JSON schema to Pydantic schemas by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/118 Fix logic operators in result_as_html function by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/123 Add syspath for schemas and change dag.owners to string by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/125 Alter trigger to run CI Tests on push only to main branch by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/127 Hotfix para corre\u00e7\u00e3o de vari\u00e1vel no m\u00f3dulo de envio de email by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/128 Corrige as linhas e colunas na exporta\u00e7\u00e3o via CSV by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/129 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.5...0.2.0","title":"\ud83d\ude80 Outros"},{"location":"changelog/changelog/#015-2024-08-09","text":"","title":"[0.1.5] - 2024-08-09"},{"location":"changelog/changelog/#whats-changed_6","text":"Cria par\u00e2metro opcional para uso da ementa (se houver) da publica\u00e7\u00e3o ao inv\u00e9s da janela de contexto ou texto completo. by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/113 Cria par\u00e2metro para uso de dataset no Data-Aware Schedulling. O schedule da DAG agora pode ser definido por tr\u00eas meios: cron, dataset ou cron + dataset by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/115 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.4...0.1.5","title":"What's Changed"},{"location":"changelog/changelog/#014-2024-07-30","text":"","title":"[0.1.4] - 2024-07-30"},{"location":"changelog/changelog/#whats-changed_7","text":"Close p tag in watermark by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/109 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.3...0.1.4","title":"What's Changed"},{"location":"changelog/changelog/#013-2024-07-25","text":"Cria a nova p\u00e1gina de documenta\u00e7\u00e3o do Ro-DOU no Github Pages Cria a marca d'agua do Ro-DOU no template do email Adiciona quebra de linhas no texto no modo full_text (INLABS) Corrige bug quando a pagina\u00e7\u00e3o de resultados \u00e9 igual a 2 (DOU)","title":"[0.1.3] - 2024-07-25"},{"location":"changelog/changelog/#whats-changed_8","text":"Update README.md by @marcelosinnerworkings in https://github.com/gestaogovbr/Ro-dou/pull/95 Fix format for Outlook display by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/96 Force justify text by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/97 Include parameter for dynamic no result text in notification by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/98 add dataset trigger scheduler by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/99 Fix pagination by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/104 Keep line breaks in full text mode by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/105 Add watermark in email template by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/108","title":"What's Changed"},{"location":"changelog/changelog/#new-contributors_1","text":"@marcelosinnerworkings made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/95 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.2...0.1.3","title":"New Contributors"},{"location":"changelog/changelog/#012","text":"Integra\u00e7\u00e3o com o portal INLABS, da Imprensa Nacional, permitindo a leitura das edi\u00e7\u00f5es do DOU pelos arquivos XML Remove depend\u00eancias com o framework FastETL Cria filtro de pesquisa por unidade (department) Cria op\u00e7\u00e3o de exibi\u00e7\u00e3o de texto completo da publica\u00e7\u00e3o Cria op\u00e7\u00e3o de busca avan\u00e7ada usando operadores l\u00f3gicos (INLABS) Implementa a op\u00e7\u00e3o de m\u00faltiplos searchs no mesmo YAML Cria op\u00e7\u00e3o para omitir metadados (hide_filter) no relat\u00f3rio do clipping Cria op\u00e7\u00e3o para permitir inclus\u00e3o de cabe\u00e7alho e rodap\u00e9 no corpo do relat\u00f3rio Formata o texto para modo justificado","title":"[0.1.2]"},{"location":"changelog/changelog/#whats-changed_9","text":"Move DOUhook from FastETL to Ro-dou src by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/66 Validate yaml by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/75 Create filter for department by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/77 change exact search to consider special characters by @gutaors in https://github.com/gestaogovbr/Ro-dou/pull/80 Inlabs db by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/81 add full_text option by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/82 Implement search with logical operators by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/85 Implement subsearchs by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/87 Fix select_terms_from_db bug by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/88 Create param hide_filter by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/90 Hide filters for slack and discord by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/91 Add Header and footer text by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/93 Justify text in email report by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/94","title":"What's Changed"},{"location":"changelog/changelog/#new-contributors_2","text":"@gutaors made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/80 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.1.1...0.1.2","title":"New Contributors"},{"location":"changelog/changelog/#011","text":"","title":"[0.1.1]"},{"location":"changelog/changelog/#whats-changed_10","text":"fix css file access","title":"What's Changed"},{"location":"changelog/changelog/#010-2023-08-31","text":"Altera a forma de encontrar os arquivos de configura\u00e7\u00e3o das DAGs ( dag_confs/*.yml ). Antes considerava que a pasta dag_confs/ estava na mesma raiz que os arquivos do ro-dou em ./src . Agora o caminho da(s) pasta(s) deve ser informado pela vari\u00e1vel de ambiente RO_DOU__DAG_CONF_DIR e separado por : quando mais de um. Exemplo: As pastas /opt/airflow/dags/repo1/dag_confs e /opt/airflow/dags/repo2/dag_confs possuem arquivos de configura\u00e7\u00e3o (yaml) para gera\u00e7\u00e3o das DAGs do rodou. A vari\u00e1vel de ambiente RO_DOU__DAG_CONF_DIR deve ser atribu\u00edda assim: RO_DOU__DAG_CONF_DIR=/opt/airflow/dags/repo1/dag_confs:/opt/airflow/dags/repo2/dag_confs Esta altera\u00e7\u00e3o permite que os arquivos de configura\u00e7\u00e3o das DAGs ( dag_confs/*.yml ) estejam em qualquer pasta da m\u00e1quina ou container.","title":"[0.1.0] - 2023-08-31"},{"location":"changelog/changelog/#whats-changed_11","text":"Change name organization economia to gestao by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/60 change dag_confs search by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/62 Full Changelog : https://github.com/gestaogovbr/Ro-dou/compare/0.0.7...0.1.0","title":"What's Changed"},{"location":"changelog/changelog/#007-2023-04-27","text":"","title":"[0.0.7] 2023-04-27"},{"location":"changelog/changelog/#whats-changed_12","text":"fix workflow docker build publish","title":"What's Changed"},{"location":"changelog/changelog/#006-2023-04-27","text":"","title":"[0.0.6] 2023-04-27"},{"location":"changelog/changelog/#whats-changed_13","text":"fix workflow docker build publish","title":"What's Changed"},{"location":"changelog/changelog/#005-2023-04-27","text":"","title":"[0.0.5] 2023-04-27"},{"location":"changelog/changelog/#whats-changed_14","text":"fix workflow docker build publish","title":"What's Changed"},{"location":"changelog/changelog/#004-2023-04-27","text":"","title":"[0.0.4] 2023-04-27"},{"location":"changelog/changelog/#whats-changed_15","text":"fix workflow docker build publish","title":"What's Changed"},{"location":"changelog/changelog/#003-2023-04-27","text":"","title":"[0.0.3] 2023-04-27"},{"location":"changelog/changelog/#whats-changed_16","text":"fix workflow docker build publish","title":"What's Changed"},{"location":"changelog/changelog/#002-2023-04-25","text":"","title":"[0.0.2] 2023-04-25"},{"location":"changelog/changelog/#whats-changed_17","text":"Conjunto de mudan\u00e7as para v.1 by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/4 Cria resili\u00eancia na chamada da API do DOU by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/5 Cria op\u00e7\u00e3o de pesquisa no Querido Di\u00e1rio by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/14 Trigger date horario local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/17 altera template de data do t\u00edtulo do email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/18 Incluir servi\u00e7o do selenium no docker-compose.yml by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/22 Adiciona tentativas de execu\u00e7\u00e3o na fun\u00e7\u00e3o search_text_with_retry by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/23 Criar par\u00e2metro para enviar email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/24 Make tests run in colored output by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/25 Implementa feature de documenta\u00e7\u00e3o markdown e informa\u00e7\u00f5es \u00fateis by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/31 Add documentation and separate tests for DAG Docs by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/34 Fix spelling in \"links\" by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/35 Fix searching terms read from database by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/39 remove selenium from Ro-dou by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/40 Mount as a volume only the modules used by Ro-DOU by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/44 Upgrade actions/checkout to v3 in CI by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/47 [dou_dag_generator] enables to find ro_dou folder inside airflow dags\u2026 by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/49 Decouple this project from the airflow2-docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/51 Bundle src code and plugin into docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/53 [WIP] Discord Integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/50 Workflow to build and publish docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/54 update fastetl import by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/56 Slack integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/58","title":"What's Changed"},{"location":"changelog/changelog/#new-contributors_3","text":"@nitaibezerra made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/4 Full Changelog : https://github.com/gestaogovbr/Ro-dou/commits/0.0.2","title":"New Contributors"},{"location":"changelog/changelog/#001-2023-04-25","text":"","title":"[0.0.1] 2023-04-25"},{"location":"changelog/changelog/#whats-changed_18","text":"Conjunto de mudan\u00e7as para v.1 by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/4 Cria resili\u00eancia na chamada da API do DOU by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/5 Cria op\u00e7\u00e3o de pesquisa no Querido Di\u00e1rio by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/14 Trigger date horario local by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/17 altera template de data do t\u00edtulo do email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/18 Incluir servi\u00e7o do selenium no docker-compose.yml by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/22 Adiciona tentativas de execu\u00e7\u00e3o na fun\u00e7\u00e3o search_text_with_retry by @edulauer in https://github.com/gestaogovbr/Ro-dou/pull/23 Criar par\u00e2metro para enviar email by @salomaolopes in https://github.com/gestaogovbr/Ro-dou/pull/24 Make tests run in colored output by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/25 Implementa feature de documenta\u00e7\u00e3o markdown e informa\u00e7\u00f5es \u00fateis by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/31 Add documentation and separate tests for DAG Docs by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/34 Fix spelling in \"links\" by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/35 Fix searching terms read from database by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/39 remove selenium from Ro-dou by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/40 Mount as a volume only the modules used by Ro-DOU by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/44 Upgrade actions/checkout to v3 in CI by @augusto-herrmann in https://github.com/gestaogovbr/Ro-dou/pull/47 [dou_dag_generator] enables to find ro_dou folder inside airflow dags\u2026 by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/49 Decouple this project from the airflow2-docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/51 Bundle src code and plugin into docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/53 [WIP] Discord Integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/50 Workflow to build and publish docker image by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/54 update fastetl import by @vitorbellini in https://github.com/gestaogovbr/Ro-dou/pull/56 Slack integration by @nitaibezerra in https://github.com/gestaogovbr/Ro-dou/pull/58","title":"What's Changed"},{"location":"changelog/changelog/#new-contributors_4","text":"@nitaibezerra made their first contribution in https://github.com/gestaogovbr/Ro-dou/pull/4 Full Changelog : https://github.com/gestaogovbr/Ro-dou/commits/0.0.1","title":"New Contributors"},{"location":"como_contribuir/contribuicoes/","text":"Como contribuir Os arquivos do projeto Ro-DOU s\u00e3o disponibilizados publicamente no perfil GitHub do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos e podem ser acessados clicando aqui . Contribui\u00e7\u00f5es externas ao projeto s\u00e3o bem-vindas. Para sugerir melhorias, abra uma issue via GitHub. A issue ser\u00e1 avaliada assim que poss\u00edvel pela equipe da SEGES/MGI. Caso deseje expressar outros coment\u00e1rios, cr\u00edticas, d\u00favidas ou sugest\u00f5es, contate-nos .","title":"Contribui\u00e7\u00f5es"},{"location":"como_contribuir/contribuicoes/#como-contribuir","text":"Os arquivos do projeto Ro-DOU s\u00e3o disponibilizados publicamente no perfil GitHub do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos e podem ser acessados clicando aqui . Contribui\u00e7\u00f5es externas ao projeto s\u00e3o bem-vindas. Para sugerir melhorias, abra uma issue via GitHub. A issue ser\u00e1 avaliada assim que poss\u00edvel pela equipe da SEGES/MGI. Caso deseje expressar outros coment\u00e1rios, cr\u00edticas, d\u00favidas ou sugest\u00f5es, contate-nos .","title":"Como contribuir"},{"location":"como_funciona/exemplos/","text":"Exemplos de configura\u00e7\u00e3o do arquivo YAML Neste segmento, voc\u00ea encontrar\u00e1 uma s\u00e9rie de exemplos pr\u00e1ticos de utiliza\u00e7\u00e3o do Ro-DOU. A leitura dos exemplos ajudar\u00e1 a visualizar de que maneira o Ro-DOU pode ser utilizado. Exemplo 1 A configura\u00e7\u00e3o a seguir cria uma DAG que realiza a pesquisa di\u00e1ria dos 6 termos listados e envia o relat\u00f3rio para o e-mail fornecido. dag: id: pesquisa_dou_termos_interesse_nitai description: Pesquisa termos de interesse de Nitai. search: terms: - dados abertos - governo aberto - engenharia de dados - software livre - c\u00f3digo aberto - open source report: emails: - endereco@dominio.com Exemplo 2 A configura\u00e7\u00e3o a seguir realiza a pesquisa di\u00e1ria de segunda-feira a sexta-feira, 8AM , apenas na Se\u00e7\u00e3o 1 e na Edi\u00e7\u00e3o Suplementar e envia o resultado em formato CSV , anexado ao e-mail. O par\u00e2metro schedule aceita valores CRON. dag: id: dag_id_deve_ser_unico_em_todo_airflow description: DAG exemplo de monitoramento no DOU. schedule: 0 8 * * MON-FRI search: terms: - aloca\u00e7\u00e3o - realoca - permuta - estrutura regimental - organiza\u00e7\u00e3o b\u00e1sica dou_sections: - SECAO_1 - EDICAO_SUPLEMENTAR report: emails: - dest1@gestao.gov.br - dest2@gestao.gov.br attach_csv: True subject: Assunto do Email Note que aqui s\u00e3o utilizados os par\u00e2metros opcionais schedule , dou_section e attach_csv . Exemplo 3 A configura\u00e7\u00e3o a seguir utiliza o par\u00e2metro from_db_select em terms , que torna din\u00e2mica a parametriza\u00e7\u00e3o dos termos para pesquisa. Note tamb\u00e9m a inclus\u00e3o de tags que ajudam na organiza\u00e7\u00e3o e na busca das DAGs no Airflow. dag: id: dag_ultra_dinamica description: A pesquisa depende do select SQL. tags: - projeto_a - departamento_x search: terms: from_db_select: sql: SELECT text FROM schema.tabela; conn_id: airflow_conn_id report: emails: - email-destino@gestao.gov.br subject: \"[String] com caracteres especiais deve estar entre aspas\" Exemplo 4 A configura\u00e7\u00e3o a seguir utiliza o par\u00e2metro from_airflow_variable em terms , que tamb\u00e9m carrega dinamicamente a lista de termos. Neste caso, h\u00e1 a recupera\u00e7\u00e3o a partir de uma vari\u00e1vel do Airflow . Aqui, tamb\u00e9m \u00e9 utilizado o campo field para limitar as pesquisas ao campo t\u00edtulo das publica\u00e7\u00f5es no Di\u00e1rio Oficial da Uni\u00e3o. dag: id: pesquisa_a_lista_na_variavel description: \u00c9 f\u00e1cil editar a vari\u00e1vel na interface do Airflow. search: terms: from_airflow_variable: nome_da_variavel_no_airflow field: TITULO report: emails: - email-destino@gestao.gov.br skip_null: False Caso n\u00e3o encontre nenhum resultado, ser\u00e1 enviado um e-mail informando que nenhum termo foi encontrado. Exemplo 5 A configura\u00e7\u00e3o a seguir produz uma DAG que executa apenas uma vez por m\u00eas , no dia 1 \u00e0s 8 AM, como pode ser visto no schedule . Simultaneamente, a pesquisa no Di\u00e1rio Oficial da Uni\u00e3o \u00e9 realizada nos di\u00e1rios oficiais do \u00faltimo m\u00eas inteiro, atrav\u00e9s do uso do par\u00e2metro date . Aqui, tamb\u00e9m \u00e9 utilizado o par\u00e2metro is_exact_search com valor False para utilizar uma pesquisa aproximada. Apesar do fato de que o termo buscado \"paralelpip i do\" contenha um erro ortogr\u00e1fico, a busca retorna os resultados corretos. Veja! dag: id: relatorio_mensal_do_dou description: Envia um numero menor de emails. schedule: 0 8 1 * * search: terms: - paralelpipido date: MES is_exact_search: False report: emails: - email-destino@gestao.gov.br Exemplo 6 A configura\u00e7\u00e3o a seguir produz uma DAG que pesquisa no Querido Di\u00e1rio pelos termos \"pandemia\", \"dados pessoais\" e \"prefeitura\", buscando apenas os resultados do Di\u00e1rio Oficial de Belo Horizonte. Para conhecer o Querido Di\u00e1rio, acesse https://queridodiario.ok.org.br/ . dag: id: dou_qd_example description: DAG de teste search: sources: - QD territory_id: 3106200 # Belo Horizonte terms: - pandemia - dados pessoais - prefeitura report: emails: - destination@gestao.gov.br attach_csv: True subject: \"Teste do Ro-dou\" Exemplo 7 A configura\u00e7\u00e3o a seguir produz uma DAG exatamente igual ao exemplo b\u00e1sico, mas adiciona uma descri\u00e7\u00e3o longa do que a DAG faz, usando o par\u00e2metro doc_md . Essa descri\u00e7\u00e3o pode conter formata\u00e7\u00e3o markdown, incluindo t\u00edtulos, listas, links etc. Al\u00e9m disso, acrescenta tamb\u00e9m uma refer\u00eancia ao nome do arquivo que gerou a DAG, bem como os seus par\u00e2metros. dag: id: markdown_docs_example description: DAG com documenta\u00e7\u00e3o em markdown search: terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\" doc_md: >- ## Ola! Esta \u00e9 uma DAG de exemplo com documenta\u00e7\u00e3o em markdown. Esta descri\u00e7\u00e3o \u00e9 opcional e pode ser definida no par\u00e2metro `doc_md`. * Ah, aqui voc\u00ea tamb\u00e9m pode usar *markdown* para * escrever listas, por exemplo, * ou colocar [links](graph)! Para ver essa documenta\u00e7\u00e3o, basta clicar o bot\u00e3o \"DAG Docs\" em qualquer tela de visualiza\u00e7\u00e3o da DAG no Airflow. Exemplo 8 Esta configura\u00e7\u00e3o envia as notifica\u00e7\u00f5es para canais Discord. \u00c9 necess\u00e1rio ter permiss\u00f5es de administrador no Discord para gerar o Webhook: dag: id: discord_example description: Envia notifica\u00e7\u00f5es para canal Discord search: terms: - manifesta\u00e7\u00e3o cultural - express\u00e3o cultural - pol\u00edtica cultural report: report: discord: webhook: https://discord.com/api/webhooks/105220xxxxxx811250/Q-XsfdnoHtudTQ-8A6zzzzznitai-vi0bGLE7xxxxxxxxxxxxxxxxxxxmx94R3oZ1h0ngl1 Exemplo 9 Esta configura\u00e7\u00e3o envia as notifica\u00e7\u00f5es para canais Slack. \u00c9 necess\u00e1rio ter permiss\u00f5es de administrador no Slack para gerar o Webhook: dag: id: slack_example description: Envia notifica\u00e7\u00f5es para canal Slack search: terms: - manifesta\u00e7\u00e3o cultural - express\u00e3o cultural - pol\u00edtica cultural report: report: slack: webhook: https://hooks.slack.com/services/XXXXXXXX/XXXXNFDXXX/n6QXXXXrPwxQ71ZXXXXXT9 Exemplo 10 Esta configura\u00e7\u00e3o filtra os resultados por \u00f3rg\u00e3o/unidade selecionados. Por enquanto dispon\u00edvel apenas para as pesquisas no DOU. dag: id: department_example description: DAG de teste (filtro por departamento) search: terms: - dados abertos department: - Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos - Minist\u00e9rio da Defesa report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\" Exemplo 11 Esta configura\u00e7\u00e3o permite m\u00faltiplas buscas utilizando o mesmo arquivo. O Ro-dou permite numa mesma busca juntar resultados do DOU e Querido Di\u00e1rio. dag: id: multiple_searchs_example description: DAG de teste com m\u00faltiplas buscas search: - header: \"Pesquisa no DOU\" sources: - DOU terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o force_rematch: On ignore_signature_match: On - header: \"Pesquisa no QD\" sources: - QD terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o force_rematch: On ignore_signature_match: On - header: \"Pesquisa no DOU e QD (misto)\" sources: - DOU - QD terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o force_rematch: On ignore_signature_match: On report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\" Exemplo 12 Esta configura\u00e7\u00e3o filtra os resultados por tipos de publica\u00e7\u00f5es selecionadas. Dispon\u00edvel para as pesquisas no DOU e INLABS. dag: id: pubtype_example description: DAG de teste (filtro por tipo de publica\u00e7\u00e3o) search: sources: - DOU terms: - programa pubtype: - Ato - Portaria - Edital - Extrato - Ratifica\u00e7\u00e3o - Resolu\u00e7\u00e3o - Retifica\u00e7\u00e3o - Protocolo report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\"","title":"Exemplos"},{"location":"como_funciona/exemplos/#exemplos-de-configuracao-do-arquivo-yaml","text":"Neste segmento, voc\u00ea encontrar\u00e1 uma s\u00e9rie de exemplos pr\u00e1ticos de utiliza\u00e7\u00e3o do Ro-DOU. A leitura dos exemplos ajudar\u00e1 a visualizar de que maneira o Ro-DOU pode ser utilizado.","title":"Exemplos de configura\u00e7\u00e3o do arquivo YAML"},{"location":"como_funciona/exemplos/#exemplo-1","text":"A configura\u00e7\u00e3o a seguir cria uma DAG que realiza a pesquisa di\u00e1ria dos 6 termos listados e envia o relat\u00f3rio para o e-mail fornecido. dag: id: pesquisa_dou_termos_interesse_nitai description: Pesquisa termos de interesse de Nitai. search: terms: - dados abertos - governo aberto - engenharia de dados - software livre - c\u00f3digo aberto - open source report: emails: - endereco@dominio.com","title":"Exemplo 1"},{"location":"como_funciona/exemplos/#exemplo-2","text":"A configura\u00e7\u00e3o a seguir realiza a pesquisa di\u00e1ria de segunda-feira a sexta-feira, 8AM , apenas na Se\u00e7\u00e3o 1 e na Edi\u00e7\u00e3o Suplementar e envia o resultado em formato CSV , anexado ao e-mail. O par\u00e2metro schedule aceita valores CRON. dag: id: dag_id_deve_ser_unico_em_todo_airflow description: DAG exemplo de monitoramento no DOU. schedule: 0 8 * * MON-FRI search: terms: - aloca\u00e7\u00e3o - realoca - permuta - estrutura regimental - organiza\u00e7\u00e3o b\u00e1sica dou_sections: - SECAO_1 - EDICAO_SUPLEMENTAR report: emails: - dest1@gestao.gov.br - dest2@gestao.gov.br attach_csv: True subject: Assunto do Email Note que aqui s\u00e3o utilizados os par\u00e2metros opcionais schedule , dou_section e attach_csv .","title":"Exemplo 2"},{"location":"como_funciona/exemplos/#exemplo-3","text":"A configura\u00e7\u00e3o a seguir utiliza o par\u00e2metro from_db_select em terms , que torna din\u00e2mica a parametriza\u00e7\u00e3o dos termos para pesquisa. Note tamb\u00e9m a inclus\u00e3o de tags que ajudam na organiza\u00e7\u00e3o e na busca das DAGs no Airflow. dag: id: dag_ultra_dinamica description: A pesquisa depende do select SQL. tags: - projeto_a - departamento_x search: terms: from_db_select: sql: SELECT text FROM schema.tabela; conn_id: airflow_conn_id report: emails: - email-destino@gestao.gov.br subject: \"[String] com caracteres especiais deve estar entre aspas\"","title":"Exemplo 3"},{"location":"como_funciona/exemplos/#exemplo-4","text":"A configura\u00e7\u00e3o a seguir utiliza o par\u00e2metro from_airflow_variable em terms , que tamb\u00e9m carrega dinamicamente a lista de termos. Neste caso, h\u00e1 a recupera\u00e7\u00e3o a partir de uma vari\u00e1vel do Airflow . Aqui, tamb\u00e9m \u00e9 utilizado o campo field para limitar as pesquisas ao campo t\u00edtulo das publica\u00e7\u00f5es no Di\u00e1rio Oficial da Uni\u00e3o. dag: id: pesquisa_a_lista_na_variavel description: \u00c9 f\u00e1cil editar a vari\u00e1vel na interface do Airflow. search: terms: from_airflow_variable: nome_da_variavel_no_airflow field: TITULO report: emails: - email-destino@gestao.gov.br skip_null: False Caso n\u00e3o encontre nenhum resultado, ser\u00e1 enviado um e-mail informando que nenhum termo foi encontrado.","title":"Exemplo 4"},{"location":"como_funciona/exemplos/#exemplo-5","text":"A configura\u00e7\u00e3o a seguir produz uma DAG que executa apenas uma vez por m\u00eas , no dia 1 \u00e0s 8 AM, como pode ser visto no schedule . Simultaneamente, a pesquisa no Di\u00e1rio Oficial da Uni\u00e3o \u00e9 realizada nos di\u00e1rios oficiais do \u00faltimo m\u00eas inteiro, atrav\u00e9s do uso do par\u00e2metro date . Aqui, tamb\u00e9m \u00e9 utilizado o par\u00e2metro is_exact_search com valor False para utilizar uma pesquisa aproximada. Apesar do fato de que o termo buscado \"paralelpip i do\" contenha um erro ortogr\u00e1fico, a busca retorna os resultados corretos. Veja! dag: id: relatorio_mensal_do_dou description: Envia um numero menor de emails. schedule: 0 8 1 * * search: terms: - paralelpipido date: MES is_exact_search: False report: emails: - email-destino@gestao.gov.br","title":"Exemplo 5"},{"location":"como_funciona/exemplos/#exemplo-6","text":"A configura\u00e7\u00e3o a seguir produz uma DAG que pesquisa no Querido Di\u00e1rio pelos termos \"pandemia\", \"dados pessoais\" e \"prefeitura\", buscando apenas os resultados do Di\u00e1rio Oficial de Belo Horizonte. Para conhecer o Querido Di\u00e1rio, acesse https://queridodiario.ok.org.br/ . dag: id: dou_qd_example description: DAG de teste search: sources: - QD territory_id: 3106200 # Belo Horizonte terms: - pandemia - dados pessoais - prefeitura report: emails: - destination@gestao.gov.br attach_csv: True subject: \"Teste do Ro-dou\"","title":"Exemplo 6"},{"location":"como_funciona/exemplos/#exemplo-7","text":"A configura\u00e7\u00e3o a seguir produz uma DAG exatamente igual ao exemplo b\u00e1sico, mas adiciona uma descri\u00e7\u00e3o longa do que a DAG faz, usando o par\u00e2metro doc_md . Essa descri\u00e7\u00e3o pode conter formata\u00e7\u00e3o markdown, incluindo t\u00edtulos, listas, links etc. Al\u00e9m disso, acrescenta tamb\u00e9m uma refer\u00eancia ao nome do arquivo que gerou a DAG, bem como os seus par\u00e2metros. dag: id: markdown_docs_example description: DAG com documenta\u00e7\u00e3o em markdown search: terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\" doc_md: >- ## Ola! Esta \u00e9 uma DAG de exemplo com documenta\u00e7\u00e3o em markdown. Esta descri\u00e7\u00e3o \u00e9 opcional e pode ser definida no par\u00e2metro `doc_md`. * Ah, aqui voc\u00ea tamb\u00e9m pode usar *markdown* para * escrever listas, por exemplo, * ou colocar [links](graph)! Para ver essa documenta\u00e7\u00e3o, basta clicar o bot\u00e3o \"DAG Docs\" em qualquer tela de visualiza\u00e7\u00e3o da DAG no Airflow.","title":"Exemplo 7"},{"location":"como_funciona/exemplos/#exemplo-8","text":"Esta configura\u00e7\u00e3o envia as notifica\u00e7\u00f5es para canais Discord. \u00c9 necess\u00e1rio ter permiss\u00f5es de administrador no Discord para gerar o Webhook: dag: id: discord_example description: Envia notifica\u00e7\u00f5es para canal Discord search: terms: - manifesta\u00e7\u00e3o cultural - express\u00e3o cultural - pol\u00edtica cultural report: report: discord: webhook: https://discord.com/api/webhooks/105220xxxxxx811250/Q-XsfdnoHtudTQ-8A6zzzzznitai-vi0bGLE7xxxxxxxxxxxxxxxxxxxmx94R3oZ1h0ngl1","title":"Exemplo 8"},{"location":"como_funciona/exemplos/#exemplo-9","text":"Esta configura\u00e7\u00e3o envia as notifica\u00e7\u00f5es para canais Slack. \u00c9 necess\u00e1rio ter permiss\u00f5es de administrador no Slack para gerar o Webhook: dag: id: slack_example description: Envia notifica\u00e7\u00f5es para canal Slack search: terms: - manifesta\u00e7\u00e3o cultural - express\u00e3o cultural - pol\u00edtica cultural report: report: slack: webhook: https://hooks.slack.com/services/XXXXXXXX/XXXXNFDXXX/n6QXXXXrPwxQ71ZXXXXXT9","title":"Exemplo 9"},{"location":"como_funciona/exemplos/#exemplo-10","text":"Esta configura\u00e7\u00e3o filtra os resultados por \u00f3rg\u00e3o/unidade selecionados. Por enquanto dispon\u00edvel apenas para as pesquisas no DOU. dag: id: department_example description: DAG de teste (filtro por departamento) search: terms: - dados abertos department: - Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos - Minist\u00e9rio da Defesa report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\"","title":"Exemplo 10"},{"location":"como_funciona/exemplos/#exemplo-11","text":"Esta configura\u00e7\u00e3o permite m\u00faltiplas buscas utilizando o mesmo arquivo. O Ro-dou permite numa mesma busca juntar resultados do DOU e Querido Di\u00e1rio. dag: id: multiple_searchs_example description: DAG de teste com m\u00faltiplas buscas search: - header: \"Pesquisa no DOU\" sources: - DOU terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o force_rematch: On ignore_signature_match: On - header: \"Pesquisa no QD\" sources: - QD terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o force_rematch: On ignore_signature_match: On - header: \"Pesquisa no DOU e QD (misto)\" sources: - DOU - QD terms: - dados abertos - governo aberto - lei de acesso \u00e0 informa\u00e7\u00e3o force_rematch: On ignore_signature_match: On report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\"","title":"Exemplo 11"},{"location":"como_funciona/exemplos/#exemplo-12","text":"Esta configura\u00e7\u00e3o filtra os resultados por tipos de publica\u00e7\u00f5es selecionadas. Dispon\u00edvel para as pesquisas no DOU e INLABS. dag: id: pubtype_example description: DAG de teste (filtro por tipo de publica\u00e7\u00e3o) search: sources: - DOU terms: - programa pubtype: - Ato - Portaria - Edital - Extrato - Ratifica\u00e7\u00e3o - Resolu\u00e7\u00e3o - Retifica\u00e7\u00e3o - Protocolo report: emails: - destination@gestao.gov.br subject: \"Teste do Ro-dou\"","title":"Exemplo 12"},{"location":"como_funciona/intro_funcionamento/","text":"Como funciona Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 as seguintes informa\u00e7\u00f5es sobre o Ro-DOU: Compreendendo melhor a pesquisa no Di\u00e1rio Oficial da Uni\u00e3o Recursos e funcionalidades Par\u00e2metros de pesquisa dispon\u00edveis Exemplos de configura\u00e7\u00e3o do arquivo YAML","title":"Introdu\u00e7\u00e3o"},{"location":"como_funciona/intro_funcionamento/#como-funciona","text":"Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 as seguintes informa\u00e7\u00f5es sobre o Ro-DOU: Compreendendo melhor a pesquisa no Di\u00e1rio Oficial da Uni\u00e3o Recursos e funcionalidades Par\u00e2metros de pesquisa dispon\u00edveis Exemplos de configura\u00e7\u00e3o do arquivo YAML","title":"Como funciona"},{"location":"como_funciona/operadores/","text":"Operadores de Pesquisa Avan\u00e7ada Os seguintes operadores de pesquisa avan\u00e7ada no Ro-DOU podem ser configurados nos arquivos YAML: & : Equivalente ao operador l\u00f3gico and (conjun\u00e7\u00e3o \"e\"). | : Equivalente ao operador l\u00f3gico or (conjun\u00e7\u00e3o \"ou\"). ! : Equivalente ao operador l\u00f3gico not (nega\u00e7\u00e3o). O exemplo abaixo demonstra, na pr\u00e1tica, como tais operadores podem ser utilizados no Ro-DOU: dag: id: inlabs_advanced_search_example description: DAG de teste tags: - inlabs schedule: 0 8 * * MON-FRI owner: - cdata search: sources: - INLABS terms: - designar & ( MGI | MINIST\u00c9RIO FAZENDA) - instituto & federal ! paran\u00e1 report: emails: - destination@economia.gov.br attach_csv: True subject: \"Teste do Ro-dou\"","title":"Operadores de pesquisa avan\u00e7ada"},{"location":"como_funciona/operadores/#operadores-de-pesquisa-avancada","text":"Os seguintes operadores de pesquisa avan\u00e7ada no Ro-DOU podem ser configurados nos arquivos YAML: & : Equivalente ao operador l\u00f3gico and (conjun\u00e7\u00e3o \"e\"). | : Equivalente ao operador l\u00f3gico or (conjun\u00e7\u00e3o \"ou\"). ! : Equivalente ao operador l\u00f3gico not (nega\u00e7\u00e3o). O exemplo abaixo demonstra, na pr\u00e1tica, como tais operadores podem ser utilizados no Ro-DOU: dag: id: inlabs_advanced_search_example description: DAG de teste tags: - inlabs schedule: 0 8 * * MON-FRI owner: - cdata search: sources: - INLABS terms: - designar & ( MGI | MINIST\u00c9RIO FAZENDA) - instituto & federal ! paran\u00e1 report: emails: - destination@economia.gov.br attach_csv: True subject: \"Teste do Ro-dou\"","title":"Operadores de Pesquisa Avan\u00e7ada"},{"location":"como_funciona/parametros/","text":"Par\u00e2metros de pesquisa dispon\u00edveis A p\u00e1gina abaixo lista os par\u00e2metros configur\u00e1veis nos arquivos YAML: Par\u00e2metros da DAG id : Nome identificador da DAG a ser gerada. description : Descri\u00e7\u00e3o da DAG de pesquisa. doc_md : Documenta\u00e7\u00e3o em markdown da DAG para uma descri\u00e7\u00e3o mais completa. schedule : Agendamento da periodicidade de execu\u00e7\u00e3o da DAG. Padr\u00e3o cron (0 8 * * MON-FRI) dataset : Agendamento da DAG baseado na atualiza\u00e7\u00e3o de um Dataset do Airflow. Em conjunto com o schedule a execu\u00e7\u00e3o \u00e9 condicionada ao schedule e dataset. tags : Tags para categorizar a DAG. owner : Respons\u00e1vel pela DAG. Par\u00e2metros da Pesquisa (Search) search : Pode ser uma ou uma lista de pesquisas. date : Intervalo de data para busca. Valores: DIA, SEMANA, MES, ANO. Default: DIA department : Lista de unidades a serem filtradas na busca. O nome deve ser id\u00eantico ao da publica\u00e7\u00e3o. dou_sections : Lista de se\u00e7\u00f5es do DOU onde a busca dever\u00e1 ser realizada. Valores aceitos: SECAO_1, SECAO_2, SECAO_3, EDICAO_EXTRA, EDICAO_SUPLEMENTAR, TODOS. field : Campos dos quais os termos devem ser pesquisados. Valores: TUDO, TITULO, CONTEUDO. Default: TUDO force_rematch : Indica que a busca deve ser for\u00e7ada, mesmo que j\u00e1 tenha sido feita anteriormente. Valores: True ou False. full_text : Define se no relat\u00f3rio ser\u00e1 exibido o texto completo, ao inv\u00e9s de um resumo. Valores: True ou False. Default: False. (Funcionalidade dispon\u00edvel apenas no INLABS) use_summary : Define se no relat\u00f3rio ser\u00e1 exibido a ementa, se existir. Valores: True ou False. Default: False. (Funcionalidade dispon\u00edvel apenas no INLABS) ignore_signature_match : Ignora a correspond\u00eancia de assinatura ao realizar a busca. Valores: True ou False. Default: False. is_exact_search : Busca somente o termo exato. Valores: True ou False. Default: True. pubtype : Lista de tipos de publica\u00e7\u00f5es a serem filtradas na busca. Valores: Lista de tipos de publica\u00e7\u00f5es . sources : Fontes de pesquisa dos di\u00e1rios oficiais. Pode ser uma ou uma lista. Op\u00e7\u00f5es dispon\u00edveis: DOU, QD, INLABS. terms : Lista de termos a serem buscados. Para o INLABS podem ser utilizados operadores avan\u00e7ados de busca. territory_id : Lista de identificadores do id do munic\u00edpio. Necess\u00e1rio para buscar no Querido Di\u00e1rio. Par\u00e2metros do Relat\u00f3rio (Report) attach_csv : Anexar no email o resultado da pesquisa em CSV. discord_webhook : URL de Webhook para integra\u00e7\u00e3o com o Discord. emails : Lista de emails dos destinat\u00e1rios. footer_text : Texto em HTML do rodap\u00e9 do relat\u00f3rio. header_text : Texto em HTML de cabe\u00e7alho do relat\u00f3rio. hide_filters : Omite no relat\u00f3rio os filtros de pesquisa. no_results_found_text : Texto padr\u00e3o para quando n\u00e3o h\u00e1 resultados encontrados. Default: Nenhum dos termos pesquisados foi encontrado nesta consulta. report : Par\u00e2metros de notifica\u00e7\u00e3o de relat\u00f3rio. skip_null : Dispensa o envio de email quando n\u00e3o h\u00e1 resultados encontrados em todas as pesquisas. Valores: True ou False. Default: True. slack_webhook : URL de Webhook para integra\u00e7\u00e3o com o Slack. subject : Texto de assunto do email.","title":"Par\u00e2metros de pesquisa"},{"location":"como_funciona/parametros/#parametros-de-pesquisa-disponiveis","text":"A p\u00e1gina abaixo lista os par\u00e2metros configur\u00e1veis nos arquivos YAML:","title":"Par\u00e2metros de pesquisa dispon\u00edveis"},{"location":"como_funciona/parametros/#parametros-da-dag","text":"id : Nome identificador da DAG a ser gerada. description : Descri\u00e7\u00e3o da DAG de pesquisa. doc_md : Documenta\u00e7\u00e3o em markdown da DAG para uma descri\u00e7\u00e3o mais completa. schedule : Agendamento da periodicidade de execu\u00e7\u00e3o da DAG. Padr\u00e3o cron (0 8 * * MON-FRI) dataset : Agendamento da DAG baseado na atualiza\u00e7\u00e3o de um Dataset do Airflow. Em conjunto com o schedule a execu\u00e7\u00e3o \u00e9 condicionada ao schedule e dataset. tags : Tags para categorizar a DAG. owner : Respons\u00e1vel pela DAG.","title":"Par\u00e2metros da DAG"},{"location":"como_funciona/parametros/#parametros-da-pesquisa-search","text":"search : Pode ser uma ou uma lista de pesquisas. date : Intervalo de data para busca. Valores: DIA, SEMANA, MES, ANO. Default: DIA department : Lista de unidades a serem filtradas na busca. O nome deve ser id\u00eantico ao da publica\u00e7\u00e3o. dou_sections : Lista de se\u00e7\u00f5es do DOU onde a busca dever\u00e1 ser realizada. Valores aceitos: SECAO_1, SECAO_2, SECAO_3, EDICAO_EXTRA, EDICAO_SUPLEMENTAR, TODOS. field : Campos dos quais os termos devem ser pesquisados. Valores: TUDO, TITULO, CONTEUDO. Default: TUDO force_rematch : Indica que a busca deve ser for\u00e7ada, mesmo que j\u00e1 tenha sido feita anteriormente. Valores: True ou False. full_text : Define se no relat\u00f3rio ser\u00e1 exibido o texto completo, ao inv\u00e9s de um resumo. Valores: True ou False. Default: False. (Funcionalidade dispon\u00edvel apenas no INLABS) use_summary : Define se no relat\u00f3rio ser\u00e1 exibido a ementa, se existir. Valores: True ou False. Default: False. (Funcionalidade dispon\u00edvel apenas no INLABS) ignore_signature_match : Ignora a correspond\u00eancia de assinatura ao realizar a busca. Valores: True ou False. Default: False. is_exact_search : Busca somente o termo exato. Valores: True ou False. Default: True. pubtype : Lista de tipos de publica\u00e7\u00f5es a serem filtradas na busca. Valores: Lista de tipos de publica\u00e7\u00f5es . sources : Fontes de pesquisa dos di\u00e1rios oficiais. Pode ser uma ou uma lista. Op\u00e7\u00f5es dispon\u00edveis: DOU, QD, INLABS. terms : Lista de termos a serem buscados. Para o INLABS podem ser utilizados operadores avan\u00e7ados de busca. territory_id : Lista de identificadores do id do munic\u00edpio. Necess\u00e1rio para buscar no Querido Di\u00e1rio.","title":"Par\u00e2metros da Pesquisa (Search)"},{"location":"como_funciona/parametros/#parametros-do-relatorio-report","text":"attach_csv : Anexar no email o resultado da pesquisa em CSV. discord_webhook : URL de Webhook para integra\u00e7\u00e3o com o Discord. emails : Lista de emails dos destinat\u00e1rios. footer_text : Texto em HTML do rodap\u00e9 do relat\u00f3rio. header_text : Texto em HTML de cabe\u00e7alho do relat\u00f3rio. hide_filters : Omite no relat\u00f3rio os filtros de pesquisa. no_results_found_text : Texto padr\u00e3o para quando n\u00e3o h\u00e1 resultados encontrados. Default: Nenhum dos termos pesquisados foi encontrado nesta consulta. report : Par\u00e2metros de notifica\u00e7\u00e3o de relat\u00f3rio. skip_null : Dispensa o envio de email quando n\u00e3o h\u00e1 resultados encontrados em todas as pesquisas. Valores: True ou False. Default: True. slack_webhook : URL de Webhook para integra\u00e7\u00e3o com o Slack. subject : Texto de assunto do email.","title":"Par\u00e2metros do Relat\u00f3rio (Report)"},{"location":"como_funciona/pesquisa_dou/","text":"Compreendendo melhor a pesquisa no Di\u00e1rio Oficial da Uni\u00e3o Todos os par\u00e2metros dispon\u00edveis para pesquisa no Di\u00e1rio Oficial da Uni\u00e3o (DOU) foram criados a partir da API da Imprensa Nacional, que por sua vez \u00e9 utilizada pelo buscador oficial do DOU em https://www.in.gov.br/consulta/ . Assim, \u00e9 poss\u00edvel notar que o Ro-DOU consegue automatizar todo, ou quase todo, tipo de pesquisa que pode ser feita no site do Di\u00e1rio Oficial da Uni\u00e3o. A imagem abaixo \u00e9 o painel de pesquisa avan\u00e7ada do site:","title":"Compreendendo a pesquisa no D.O.U."},{"location":"como_funciona/pesquisa_dou/#compreendendo-melhor-a-pesquisa-no-diario-oficial-da-uniao","text":"Todos os par\u00e2metros dispon\u00edveis para pesquisa no Di\u00e1rio Oficial da Uni\u00e3o (DOU) foram criados a partir da API da Imprensa Nacional, que por sua vez \u00e9 utilizada pelo buscador oficial do DOU em https://www.in.gov.br/consulta/ . Assim, \u00e9 poss\u00edvel notar que o Ro-DOU consegue automatizar todo, ou quase todo, tipo de pesquisa que pode ser feita no site do Di\u00e1rio Oficial da Uni\u00e3o. A imagem abaixo \u00e9 o painel de pesquisa avan\u00e7ada do site:","title":"Compreendendo melhor a pesquisa no Di\u00e1rio Oficial da Uni\u00e3o"},{"location":"como_funciona/recursos_funcionalidades/","text":"Recursos e funcionalidades O Ro-DOU possui os seguintes recursos e funcionalidades voltados aos usu\u00e1rios: Resultados com frequ\u00eancias di\u00e1ria , semanal ou mensal ; Relat\u00f3rios em formato .CSV para facilita\u00e7\u00e3o do uso; Busca din\u00e2mica das palavras-chaves de um banco de dados ou de uma vari\u00e1vel ; Pesquisa em se\u00e7\u00e3o espec\u00edfica do di\u00e1rio oficial; Envio de notifica\u00e7\u00f5es para os canais existentes no Discord e no Slack.","title":"Recursos e funcionalidades"},{"location":"como_funciona/recursos_funcionalidades/#recursos-e-funcionalidades","text":"O Ro-DOU possui os seguintes recursos e funcionalidades voltados aos usu\u00e1rios: Resultados com frequ\u00eancias di\u00e1ria , semanal ou mensal ; Relat\u00f3rios em formato .CSV para facilita\u00e7\u00e3o do uso; Busca din\u00e2mica das palavras-chaves de um banco de dados ou de uma vari\u00e1vel ; Pesquisa em se\u00e7\u00e3o espec\u00edfica do di\u00e1rio oficial; Envio de notifica\u00e7\u00f5es para os canais existentes no Discord e no Slack.","title":"Recursos e funcionalidades"},{"location":"como_funciona/tipos_de_publicacoes/","text":"Tipos de publica\u00e7\u00f5es (par\u00e2metro pubtype) A\u00e7\u00e3o Direta de Inconstitucionalidade e A\u00e7\u00e3o Declarat\u00f3ria de Constitucionalidade Ac\u00f3rd\u00e3o Acordo Coletivo de Trabalho Ajuste Alvar\u00e1 Aresto Ata Ato Ato Complementar Ato Concess\u00f3rio Ato Declarat\u00f3rio Ato Declarat\u00f3rio Conjunto Ato Normativo Ato Regimental Ato Regulamentar Auto de Infra\u00e7\u00e3o Autoriza\u00e7\u00e3o Aviso Aviso aos Acionistas Aviso de Adiamento Aviso de Adjudica\u00e7\u00e3o Aviso de Aliena\u00e7\u00e3o Aviso de Altera\u00e7\u00e3o Aviso de Altera\u00e7\u00e3o de Resultado de Habilita\u00e7\u00e3o Aviso de Anula\u00e7\u00e3o Aviso de Audi\u00eancia P\u00fablica Aviso de Cadastramento Aviso de Cancelamento Aviso de Cancelamento de Termo Aditivo Aviso de Chamamento P\u00fablico Aviso de Coleta de Pre\u00e7os Aviso de Consulta P\u00fablica Aviso de Convalida\u00e7\u00e3o Aviso de Credenciamento Aviso de Dispensa de Licita\u00e7\u00e3o Aviso de Elei\u00e7\u00e3o Aviso de Extravio Aviso de Fato Relevante Aviso de Habilita\u00e7\u00e3o Aviso de Homologa\u00e7\u00e3o Aviso de Homologa\u00e7\u00e3o e Adjudica\u00e7\u00e3o Aviso de \u00cdndice T\u00e9cnico Aviso de Inexigibilidade de Licita\u00e7\u00e3o Aviso de Julgamento Aviso de Licen\u00e7a Aviso de Licita\u00e7\u00e3o Aviso de Licita\u00e7\u00e3o-Concorr\u00eancia Aviso de Licita\u00e7\u00e3o-Convite Aviso de Licita\u00e7\u00e3o Deserta Aviso de Licita\u00e7\u00e3o-Leil\u00e3o Aviso de Licita\u00e7\u00e3o-Preg\u00e3o Aviso de Licita\u00e7\u00e3o-RDC Eletr\u00f4nico Aviso de Licita\u00e7\u00e3o-RDC Presencial Aviso de Licita\u00e7\u00e3o-Registro de Pre\u00e7os Aviso de Licita\u00e7\u00e3o-Tomada de Pre\u00e7os Aviso de Nota T\u00e9cnica Aviso de Padroniza\u00e7\u00e3o Aviso de Penalidade Aviso de Pre\u00e7os Registrados Aviso de Pr\u00e9-Qualifica\u00e7\u00e3o Aviso de Processo Seletivo Aviso de Proposta Comercial Aviso de Proposta T\u00e9cnica Aviso de Prorroga\u00e7\u00e3o Aviso de Reabertura de Prazo Aviso de Registro de Chapas Aviso de Registro de Diplomas Aviso de Registro de Pre\u00e7os Aviso de Rela\u00e7\u00e3o de Compras Aviso de Rescis\u00e3o Aviso de Retifica\u00e7\u00e3o Aviso de Revoga\u00e7\u00e3o Aviso de Sele\u00e7\u00e3o Aviso de Servi\u00e7o e Compra Aviso de Sorteio Aviso de Suspens\u00e3o Aviso de Tomada de Subs\u00eddios Balancete Balancete Financeiro Balancete Patrimonial e Financeiro Balan\u00e7o Patrimonial Balan\u00e7o Social Certid\u00e3o Circular Comunicado Consulta P\u00fablica Contrato de Gest\u00e3o Conv\u00eanio Decis\u00e3o Decreto de Pessoal Decreto Legislativo Decreto n\u00e3o numerado Decreto numerado Delibera\u00e7\u00e3o Demonstra\u00e7\u00e3o Cont\u00e1bil Despacho Despacho Interministerial Edital Edital da Justi\u00e7a Gratuita (Art. 32 Portaria 268/2009-IN) Edital de Cita\u00e7\u00e3o Edital de Concurso P\u00fablico Edital de Convoca\u00e7\u00e3o Edital de Credenciamento Edital de Intima\u00e7\u00e3o Edital de Leil\u00e3o Edital de Notifica\u00e7\u00e3o Edital de Processo Seletivo Edital de Vestibular Emenda Emenda Constitucional Estatuto Extrato Extrato da Ata Extrato de Acordo de Coopera\u00e7\u00e3o Extrato de Acordo de Coopera\u00e7\u00e3o Federativa Extrato de Acordo de Coopera\u00e7\u00e3o T\u00e9cnica Extrato de Ades\u00e3o Extrato de Ajuste Extrato de Apostilamento Extrato de Autoriza\u00e7\u00e3o de Fornecimento de Material Extrato de Autoriza\u00e7\u00e3o de Servi\u00e7o Extrato de Autoriza\u00e7\u00e3o de Uso Extrato de Carta Contrato Extrato de Carta Reversal Extrato de Cess\u00e3o Extrato de Cess\u00e3o de Uso Extrato de Comodato Extrato de Compromisso Extrato de Concess\u00e3o de Uso Extrato de Contrato Extrato de Conv\u00eanio Extrato de Coopera\u00e7\u00e3o M\u00fatua Extrato de Credenciamento Extrato de Den\u00fancia Extrato de Dep\u00f3sito Extrato de Dispensa de Chamamento P\u00fablico Extrato de Dispensa de Licita\u00e7\u00e3o Extrato de Distrato Extrato de Doa\u00e7\u00e3o Extrato de Escritura de Compra e Venda Extrato de Extin\u00e7\u00e3o (Lei n\u00ba 8.745 - contrata\u00e7\u00e3o tempor\u00e1ria) Extrato de Fornecimento Extrato de Inexigibilidade de Licita\u00e7\u00e3o Extrato de Instrumento Convocat\u00f3rio Extrato de Instrumentos Contratuais Extrato de Memorando de Entendimento Extrato de Nota de Empenho Extrato de Ordem de Compra Extrato de Ordem de Execu\u00e7\u00e3o de Servi\u00e7o Extrato de Ordem de Fornecimento Extrato de Parceria Extrato de Parecer T\u00e9cnico Extrato de Permiss\u00e3o de Uso Extrato de Permuta Extrato de Prorroga\u00e7\u00e3o de Of\u00edcio Extrato de Protocolo de Coopera\u00e7\u00e3o Extrato de Protocolo de Inten\u00e7\u00e3o Extrato de Recolhimento Extrato de Reconhecimento Extrato de Reconhecimento de D\u00edvida Extrato de Registro de Pre\u00e7os Extrato de Rerratifica\u00e7\u00e3o Extrato de Rescis\u00e3o Extrato de Rescis\u00e3o Contratual Extrato de Resili\u00e7\u00e3o Extrato de Sub-roga\u00e7\u00e3o Extrato de Termo Aditivo Extrato de Termo de Ajustamento de Conduta Extrato de Termo de Coopera\u00e7\u00e3o T\u00e9cnica Extrato de Termo de Entrega Extrato de Termo de Execu\u00e7\u00e3o de Projeto Extrato de Termo de Execu\u00e7\u00e3o Descentralizada Extrato de Termo de Fomento Extrato de Termo de Ocupa\u00e7\u00e3o de Im\u00f3vel Extrato de Termo de Parceria Extrato de Transfer\u00eancia de Posse Extrato Pr\u00e9vio Fato Relevante Instru\u00e7\u00e3o Instru\u00e7\u00e3o Normativa Instru\u00e7\u00e3o Normativa Conjunta Lei Lei Complementar Lista de Antiguidade Medida Provis\u00f3ria Memorando de Entendimento Mensagem Norma Complementar Of\u00edcio circular Ordem de Servi\u00e7o Orienta\u00e7\u00e3o Normativa Pacto Parecer Normativo Pauta Portaria Portaria Conjunta Portaria Intergovernamental Portaria Interministerial Processo Disciplinar Proposta Or\u00e7ament\u00e1ria Protocolo Protocolo de Inten\u00e7\u00f5es Provimento Ratifica\u00e7\u00e3o Recomenda\u00e7\u00e3o Recurso Disciplinar Relat\u00f3rios Republica\u00e7\u00e3o Resolu\u00e7\u00e3o Resolu\u00e7\u00e3o do Senado Federal Resultado de An\u00e1lise Resultado de Avalia\u00e7\u00e3o T\u00e9cnica Resultado de Cadastramento Resultado de Concurso P\u00fablico Resultado de Elei\u00e7\u00e3o Resultado de Habilita\u00e7\u00e3o Resultado de \u00cdndice T\u00e9cnico Resultado de Julgamento Resultado de Julgamento de Licita\u00e7\u00e3o Resultado de Leil\u00e3o Resultado de Proposta T\u00e9cnica Resultado de Qualifica\u00e7\u00e3o Retifica\u00e7\u00e3o Retifica\u00e7\u00e3o (de Edital) Solu\u00e7\u00e3o de Consulta S\u00famula S\u00famula Administrativa Termo de Autoriza\u00e7\u00e3o Termo de Libera\u00e7\u00e3o de Opera\u00e7\u00e3o","title":"Tipos de publicacoes"},{"location":"como_funciona/tipos_de_publicacoes/#tipos-de-publicacoes-parametro-pubtype","text":"A\u00e7\u00e3o Direta de Inconstitucionalidade e A\u00e7\u00e3o Declarat\u00f3ria de Constitucionalidade Ac\u00f3rd\u00e3o Acordo Coletivo de Trabalho Ajuste Alvar\u00e1 Aresto Ata Ato Ato Complementar Ato Concess\u00f3rio Ato Declarat\u00f3rio Ato Declarat\u00f3rio Conjunto Ato Normativo Ato Regimental Ato Regulamentar Auto de Infra\u00e7\u00e3o Autoriza\u00e7\u00e3o Aviso Aviso aos Acionistas Aviso de Adiamento Aviso de Adjudica\u00e7\u00e3o Aviso de Aliena\u00e7\u00e3o Aviso de Altera\u00e7\u00e3o Aviso de Altera\u00e7\u00e3o de Resultado de Habilita\u00e7\u00e3o Aviso de Anula\u00e7\u00e3o Aviso de Audi\u00eancia P\u00fablica Aviso de Cadastramento Aviso de Cancelamento Aviso de Cancelamento de Termo Aditivo Aviso de Chamamento P\u00fablico Aviso de Coleta de Pre\u00e7os Aviso de Consulta P\u00fablica Aviso de Convalida\u00e7\u00e3o Aviso de Credenciamento Aviso de Dispensa de Licita\u00e7\u00e3o Aviso de Elei\u00e7\u00e3o Aviso de Extravio Aviso de Fato Relevante Aviso de Habilita\u00e7\u00e3o Aviso de Homologa\u00e7\u00e3o Aviso de Homologa\u00e7\u00e3o e Adjudica\u00e7\u00e3o Aviso de \u00cdndice T\u00e9cnico Aviso de Inexigibilidade de Licita\u00e7\u00e3o Aviso de Julgamento Aviso de Licen\u00e7a Aviso de Licita\u00e7\u00e3o Aviso de Licita\u00e7\u00e3o-Concorr\u00eancia Aviso de Licita\u00e7\u00e3o-Convite Aviso de Licita\u00e7\u00e3o Deserta Aviso de Licita\u00e7\u00e3o-Leil\u00e3o Aviso de Licita\u00e7\u00e3o-Preg\u00e3o Aviso de Licita\u00e7\u00e3o-RDC Eletr\u00f4nico Aviso de Licita\u00e7\u00e3o-RDC Presencial Aviso de Licita\u00e7\u00e3o-Registro de Pre\u00e7os Aviso de Licita\u00e7\u00e3o-Tomada de Pre\u00e7os Aviso de Nota T\u00e9cnica Aviso de Padroniza\u00e7\u00e3o Aviso de Penalidade Aviso de Pre\u00e7os Registrados Aviso de Pr\u00e9-Qualifica\u00e7\u00e3o Aviso de Processo Seletivo Aviso de Proposta Comercial Aviso de Proposta T\u00e9cnica Aviso de Prorroga\u00e7\u00e3o Aviso de Reabertura de Prazo Aviso de Registro de Chapas Aviso de Registro de Diplomas Aviso de Registro de Pre\u00e7os Aviso de Rela\u00e7\u00e3o de Compras Aviso de Rescis\u00e3o Aviso de Retifica\u00e7\u00e3o Aviso de Revoga\u00e7\u00e3o Aviso de Sele\u00e7\u00e3o Aviso de Servi\u00e7o e Compra Aviso de Sorteio Aviso de Suspens\u00e3o Aviso de Tomada de Subs\u00eddios Balancete Balancete Financeiro Balancete Patrimonial e Financeiro Balan\u00e7o Patrimonial Balan\u00e7o Social Certid\u00e3o Circular Comunicado Consulta P\u00fablica Contrato de Gest\u00e3o Conv\u00eanio Decis\u00e3o Decreto de Pessoal Decreto Legislativo Decreto n\u00e3o numerado Decreto numerado Delibera\u00e7\u00e3o Demonstra\u00e7\u00e3o Cont\u00e1bil Despacho Despacho Interministerial Edital Edital da Justi\u00e7a Gratuita (Art. 32 Portaria 268/2009-IN) Edital de Cita\u00e7\u00e3o Edital de Concurso P\u00fablico Edital de Convoca\u00e7\u00e3o Edital de Credenciamento Edital de Intima\u00e7\u00e3o Edital de Leil\u00e3o Edital de Notifica\u00e7\u00e3o Edital de Processo Seletivo Edital de Vestibular Emenda Emenda Constitucional Estatuto Extrato Extrato da Ata Extrato de Acordo de Coopera\u00e7\u00e3o Extrato de Acordo de Coopera\u00e7\u00e3o Federativa Extrato de Acordo de Coopera\u00e7\u00e3o T\u00e9cnica Extrato de Ades\u00e3o Extrato de Ajuste Extrato de Apostilamento Extrato de Autoriza\u00e7\u00e3o de Fornecimento de Material Extrato de Autoriza\u00e7\u00e3o de Servi\u00e7o Extrato de Autoriza\u00e7\u00e3o de Uso Extrato de Carta Contrato Extrato de Carta Reversal Extrato de Cess\u00e3o Extrato de Cess\u00e3o de Uso Extrato de Comodato Extrato de Compromisso Extrato de Concess\u00e3o de Uso Extrato de Contrato Extrato de Conv\u00eanio Extrato de Coopera\u00e7\u00e3o M\u00fatua Extrato de Credenciamento Extrato de Den\u00fancia Extrato de Dep\u00f3sito Extrato de Dispensa de Chamamento P\u00fablico Extrato de Dispensa de Licita\u00e7\u00e3o Extrato de Distrato Extrato de Doa\u00e7\u00e3o Extrato de Escritura de Compra e Venda Extrato de Extin\u00e7\u00e3o (Lei n\u00ba 8.745 - contrata\u00e7\u00e3o tempor\u00e1ria) Extrato de Fornecimento Extrato de Inexigibilidade de Licita\u00e7\u00e3o Extrato de Instrumento Convocat\u00f3rio Extrato de Instrumentos Contratuais Extrato de Memorando de Entendimento Extrato de Nota de Empenho Extrato de Ordem de Compra Extrato de Ordem de Execu\u00e7\u00e3o de Servi\u00e7o Extrato de Ordem de Fornecimento Extrato de Parceria Extrato de Parecer T\u00e9cnico Extrato de Permiss\u00e3o de Uso Extrato de Permuta Extrato de Prorroga\u00e7\u00e3o de Of\u00edcio Extrato de Protocolo de Coopera\u00e7\u00e3o Extrato de Protocolo de Inten\u00e7\u00e3o Extrato de Recolhimento Extrato de Reconhecimento Extrato de Reconhecimento de D\u00edvida Extrato de Registro de Pre\u00e7os Extrato de Rerratifica\u00e7\u00e3o Extrato de Rescis\u00e3o Extrato de Rescis\u00e3o Contratual Extrato de Resili\u00e7\u00e3o Extrato de Sub-roga\u00e7\u00e3o Extrato de Termo Aditivo Extrato de Termo de Ajustamento de Conduta Extrato de Termo de Coopera\u00e7\u00e3o T\u00e9cnica Extrato de Termo de Entrega Extrato de Termo de Execu\u00e7\u00e3o de Projeto Extrato de Termo de Execu\u00e7\u00e3o Descentralizada Extrato de Termo de Fomento Extrato de Termo de Ocupa\u00e7\u00e3o de Im\u00f3vel Extrato de Termo de Parceria Extrato de Transfer\u00eancia de Posse Extrato Pr\u00e9vio Fato Relevante Instru\u00e7\u00e3o Instru\u00e7\u00e3o Normativa Instru\u00e7\u00e3o Normativa Conjunta Lei Lei Complementar Lista de Antiguidade Medida Provis\u00f3ria Memorando de Entendimento Mensagem Norma Complementar Of\u00edcio circular Ordem de Servi\u00e7o Orienta\u00e7\u00e3o Normativa Pacto Parecer Normativo Pauta Portaria Portaria Conjunta Portaria Intergovernamental Portaria Interministerial Processo Disciplinar Proposta Or\u00e7ament\u00e1ria Protocolo Protocolo de Inten\u00e7\u00f5es Provimento Ratifica\u00e7\u00e3o Recomenda\u00e7\u00e3o Recurso Disciplinar Relat\u00f3rios Republica\u00e7\u00e3o Resolu\u00e7\u00e3o Resolu\u00e7\u00e3o do Senado Federal Resultado de An\u00e1lise Resultado de Avalia\u00e7\u00e3o T\u00e9cnica Resultado de Cadastramento Resultado de Concurso P\u00fablico Resultado de Elei\u00e7\u00e3o Resultado de Habilita\u00e7\u00e3o Resultado de \u00cdndice T\u00e9cnico Resultado de Julgamento Resultado de Julgamento de Licita\u00e7\u00e3o Resultado de Leil\u00e3o Resultado de Proposta T\u00e9cnica Resultado de Qualifica\u00e7\u00e3o Retifica\u00e7\u00e3o Retifica\u00e7\u00e3o (de Edital) Solu\u00e7\u00e3o de Consulta S\u00famula S\u00famula Administrativa Termo de Autoriza\u00e7\u00e3o Termo de Libera\u00e7\u00e3o de Opera\u00e7\u00e3o","title":"Tipos de publica\u00e7\u00f5es (par\u00e2metro pubtype)"},{"location":"como_utilizar/instalacao/","text":"Instala\u00e7\u00e3o e configura\u00e7\u00e3o Configurando o ambiente local 'Hello World' O c\u00f3digo-fonte est\u00e1 disponibilizado no perfil do GitHub do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos . Neste t\u00edtulo, fornecemos abaixo uma configura\u00e7\u00e3o demonstrativa para que voc\u00ea possa executar o Ro-DOU no seu computador. Para isso, \u00e9 necess\u00e1rio ter o Docker Compose na vers\u00e3o 1.29 ou maior instalado. Os passos para a instala\u00e7\u00e3o est\u00e3o dispon\u00edveis em https://docs.docker.com/compose/install/ ou em tutoriais no YouTube. Ap\u00f3s clonar o reposit\u00f3rio do Ro-DOU para o seu computador com o comando git clone , acesse o diret\u00f3rio pelo terminal e execute os comandos a seguir: make run Este comando baixa as imagens Docker necess\u00e1rias, efetua o build do container Docker do Ro-DOU e executa todos os demais passos necess\u00e1rios. O Apache Airflow, que tamb\u00e9m \u00e9 usado para rodar o Ro-DOU, pode demorar alguns minutos para se configurar na primeira vez. Posteriormente, ele estar\u00e1 dispon\u00edvel em http://localhost:8080/. Para se autenticar e acessar o Apache Airflow, entre no link e utilize login airflow e senha airflow . Na p\u00e1gina sobre o que \u00e9 o Ro-DOU , explicamos o que \u00e9 um grafo ac\u00edclico dirigido (DAG) do Airflow e como obter mais informa\u00e7\u00f5es sobre este conceito. Na tela inicial do Airflow, s\u00e3o fornecidos clippings de exemplo. A partir dos arquivos YAML (.yaml) do diret\u00f3rio dag_confs/ , \u00e9 poss\u00edvel manipular e customizar as pesquisas de clipping desejadas nos di\u00e1rios oficiais. Dentro dos arquivos YAML, \u00e9 poss\u00edvel, por exemplo, definir palavras-chave de busca e um endere\u00e7o de e-mail para recebimento de uma mensagem com os resultados da busca no(s) di\u00e1rio(s) oficial(is). Para executar qualquer DAG do Airflow, \u00e9 necess\u00e1rio lig\u00e1-la. Inicialmente, todas as DAGs ficam pausadas por padr\u00e3o. Sugerimos come\u00e7ar testando o clipping all_parameters_example . Utilize o bot\u00e3o toggle para lig\u00e1-lo. Ap\u00f3s ativ\u00e1-lo, o Airflow executar\u00e1 a DAG uma \u00fanica vez. Clique no nome da DAG para visualizar o detalhe da execu\u00e7\u00e3o. Voc\u00ea observar\u00e1 que, tanto na visualiza\u00e7\u00e3o em \u00e1rvore ( Tree ) como na visualiza\u00e7\u00e3o em Grafo ( Graph ) dentro do Apache Airflow, \u00e9 poss\u00edvel constatar se houve algum resultado encontrado na API da Imprensa Nacional para os termos e demais par\u00e2metros deste clipping. Se a tarefa chamada \"send_report\" estiver na cor verde, significa que foi encontrado um resultado e que uma mensagem de e-mail foi enviada para o endere\u00e7o configurado no arquivo YAML. Para visualizar a mensagem de e-mail, acesse o endere\u00e7o http://localhost:5001/. Este \u00e9 um servi\u00e7o que simula uma caixa de e-mail (servidor SMTP) para fins de experimenta\u00e7\u00e3o. Voil\u00e0! . Lembre-se que o arquivo de configura\u00e7\u00e3o deste clipping est\u00e1 na pasta dag_confs/ . Confira aqui no GitHub o conte\u00fado do arquivo YAML. Agora, faremos um segundo teste: o clipping terms_from_variable , seguindo os mesmo passos. Neste caso, os termos pesquisados est\u00e3o listados em uma vari\u00e1vel do Airflow e podem ser modificados pela interface gr\u00e1fica. Acesse no menu Admin >> Variables ou pela URL http://localhost:8080/variable/list/. Leia a se\u00e7\u00e3o Configurando em Produ\u00e7\u00e3o para instalar o Ro-dou utilizando um provedor SMTP real que enviar\u00e1 os e-mails para os destinat\u00e1rios verdadeiros. Observa\u00e7\u00e3o: Para utilizar o source: - INLABS , \u00e9 necess\u00e1rio alterar a conex\u00e3o inlabs_portal no Apache Airflow, apontando o usu\u00e1rio e senha de autentica\u00e7\u00e3o do portal. Um novo usu\u00e1rio pode ser cadastrado pelo portal INLABS . A DAG que realiza o download dos arquivos do INLABS \u00e9 a ro-dou_inlabs_load_pg . Quando tiver terminado de utilizar o ambiente de teste do Ro-DOU, desligue-o por meio do seguinte comando: make down Configurando o ambiente de produ\u00e7\u00e3o Para utilizar o Ro-DOU em ambiente de produ\u00e7\u00e3o, \u00e9 necess\u00e1rio que o servidor tenha dispon\u00edvel um servi\u00e7o SMTP que ser\u00e1 utilizado pelo Apache Airflow para envio de mensagens de e-mail pela Internet. Siga os seguintes passos: Utilize as credenciais do servi\u00e7o SMTP (host, usu\u00e1rio, senha, porta etc.) para editar o arquivo docker-compose.yml , substituindo as vari\u00e1veis referentes ao servi\u00e7o SMTP, a exemplo de AIRFLOW__SMTP__SMTP_HOST . Ao final do arquivo docker-compose.yml , remova as linhas que declaram o servi\u00e7o smtp4dev , uma vez que ele n\u00e3o ser\u00e1 mais necess\u00e1rio. Uma vez executados esses passos, basta agora inicializar o Ro-DOU por meio do comando: make run","title":"Instala\u00e7\u00e3o e configura\u00e7\u00e3o"},{"location":"como_utilizar/instalacao/#instalacao-e-configuracao","text":"","title":"Instala\u00e7\u00e3o e configura\u00e7\u00e3o"},{"location":"como_utilizar/instalacao/#configurando-o-ambiente-local-hello-world","text":"O c\u00f3digo-fonte est\u00e1 disponibilizado no perfil do GitHub do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos . Neste t\u00edtulo, fornecemos abaixo uma configura\u00e7\u00e3o demonstrativa para que voc\u00ea possa executar o Ro-DOU no seu computador. Para isso, \u00e9 necess\u00e1rio ter o Docker Compose na vers\u00e3o 1.29 ou maior instalado. Os passos para a instala\u00e7\u00e3o est\u00e3o dispon\u00edveis em https://docs.docker.com/compose/install/ ou em tutoriais no YouTube. Ap\u00f3s clonar o reposit\u00f3rio do Ro-DOU para o seu computador com o comando git clone , acesse o diret\u00f3rio pelo terminal e execute os comandos a seguir: make run Este comando baixa as imagens Docker necess\u00e1rias, efetua o build do container Docker do Ro-DOU e executa todos os demais passos necess\u00e1rios. O Apache Airflow, que tamb\u00e9m \u00e9 usado para rodar o Ro-DOU, pode demorar alguns minutos para se configurar na primeira vez. Posteriormente, ele estar\u00e1 dispon\u00edvel em http://localhost:8080/. Para se autenticar e acessar o Apache Airflow, entre no link e utilize login airflow e senha airflow . Na p\u00e1gina sobre o que \u00e9 o Ro-DOU , explicamos o que \u00e9 um grafo ac\u00edclico dirigido (DAG) do Airflow e como obter mais informa\u00e7\u00f5es sobre este conceito. Na tela inicial do Airflow, s\u00e3o fornecidos clippings de exemplo. A partir dos arquivos YAML (.yaml) do diret\u00f3rio dag_confs/ , \u00e9 poss\u00edvel manipular e customizar as pesquisas de clipping desejadas nos di\u00e1rios oficiais. Dentro dos arquivos YAML, \u00e9 poss\u00edvel, por exemplo, definir palavras-chave de busca e um endere\u00e7o de e-mail para recebimento de uma mensagem com os resultados da busca no(s) di\u00e1rio(s) oficial(is). Para executar qualquer DAG do Airflow, \u00e9 necess\u00e1rio lig\u00e1-la. Inicialmente, todas as DAGs ficam pausadas por padr\u00e3o. Sugerimos come\u00e7ar testando o clipping all_parameters_example . Utilize o bot\u00e3o toggle para lig\u00e1-lo. Ap\u00f3s ativ\u00e1-lo, o Airflow executar\u00e1 a DAG uma \u00fanica vez. Clique no nome da DAG para visualizar o detalhe da execu\u00e7\u00e3o. Voc\u00ea observar\u00e1 que, tanto na visualiza\u00e7\u00e3o em \u00e1rvore ( Tree ) como na visualiza\u00e7\u00e3o em Grafo ( Graph ) dentro do Apache Airflow, \u00e9 poss\u00edvel constatar se houve algum resultado encontrado na API da Imprensa Nacional para os termos e demais par\u00e2metros deste clipping. Se a tarefa chamada \"send_report\" estiver na cor verde, significa que foi encontrado um resultado e que uma mensagem de e-mail foi enviada para o endere\u00e7o configurado no arquivo YAML. Para visualizar a mensagem de e-mail, acesse o endere\u00e7o http://localhost:5001/. Este \u00e9 um servi\u00e7o que simula uma caixa de e-mail (servidor SMTP) para fins de experimenta\u00e7\u00e3o. Voil\u00e0! . Lembre-se que o arquivo de configura\u00e7\u00e3o deste clipping est\u00e1 na pasta dag_confs/ . Confira aqui no GitHub o conte\u00fado do arquivo YAML. Agora, faremos um segundo teste: o clipping terms_from_variable , seguindo os mesmo passos. Neste caso, os termos pesquisados est\u00e3o listados em uma vari\u00e1vel do Airflow e podem ser modificados pela interface gr\u00e1fica. Acesse no menu Admin >> Variables ou pela URL http://localhost:8080/variable/list/. Leia a se\u00e7\u00e3o Configurando em Produ\u00e7\u00e3o para instalar o Ro-dou utilizando um provedor SMTP real que enviar\u00e1 os e-mails para os destinat\u00e1rios verdadeiros. Observa\u00e7\u00e3o: Para utilizar o source: - INLABS , \u00e9 necess\u00e1rio alterar a conex\u00e3o inlabs_portal no Apache Airflow, apontando o usu\u00e1rio e senha de autentica\u00e7\u00e3o do portal. Um novo usu\u00e1rio pode ser cadastrado pelo portal INLABS . A DAG que realiza o download dos arquivos do INLABS \u00e9 a ro-dou_inlabs_load_pg . Quando tiver terminado de utilizar o ambiente de teste do Ro-DOU, desligue-o por meio do seguinte comando: make down","title":"Configurando o ambiente local 'Hello World'"},{"location":"como_utilizar/instalacao/#configurando-o-ambiente-de-producao","text":"Para utilizar o Ro-DOU em ambiente de produ\u00e7\u00e3o, \u00e9 necess\u00e1rio que o servidor tenha dispon\u00edvel um servi\u00e7o SMTP que ser\u00e1 utilizado pelo Apache Airflow para envio de mensagens de e-mail pela Internet. Siga os seguintes passos: Utilize as credenciais do servi\u00e7o SMTP (host, usu\u00e1rio, senha, porta etc.) para editar o arquivo docker-compose.yml , substituindo as vari\u00e1veis referentes ao servi\u00e7o SMTP, a exemplo de AIRFLOW__SMTP__SMTP_HOST . Ao final do arquivo docker-compose.yml , remova as linhas que declaram o servi\u00e7o smtp4dev , uma vez que ele n\u00e3o ser\u00e1 mais necess\u00e1rio. Uma vez executados esses passos, basta agora inicializar o Ro-DOU por meio do comando: make run","title":"Configurando o ambiente de produ\u00e7\u00e3o"},{"location":"como_utilizar/intro_utilizacao/","text":"Como utilizar Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 as seguintes informa\u00e7\u00f5es sobre o Ro-DOU: Instala\u00e7\u00e3o e configura\u00e7\u00e3o Ambiente local e ambiente de produ\u00e7\u00e3o Usu\u00e1rios internos e externos ao Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos Notifica\u00e7\u00e3o de erros na execu\u00e7\u00e3o das DAGs do Apache Airflow","title":"Introdu\u00e7\u00e3o"},{"location":"como_utilizar/intro_utilizacao/#como-utilizar","text":"Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 as seguintes informa\u00e7\u00f5es sobre o Ro-DOU: Instala\u00e7\u00e3o e configura\u00e7\u00e3o Ambiente local e ambiente de produ\u00e7\u00e3o Usu\u00e1rios internos e externos ao Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos Notifica\u00e7\u00e3o de erros na execu\u00e7\u00e3o das DAGs do Apache Airflow","title":"Como utilizar"},{"location":"como_utilizar/notificacao_de_erros/","text":"Notifica\u00e7\u00e3o de erros na execu\u00e7\u00e3o das DAGs \u00c9 importante recordar que o Ro-DOU permite o envio de mensagens via Slack quando ocorre alguma falha na execu\u00e7\u00e3o da DAG no Apache Airflow. Para usar essa funcionalidade, efetue as seguintes configura\u00e7\u00f5es: Criar o app no Slack conforme orienta\u00e7\u00f5es do v\u00eddeo How to Add Slack Notifications to Your Airflow DAG's with Airflow Notifiers . Criar uma conex\u00e3o no Apache Airflow com a seguinte configura\u00e7\u00e3o: Connection Id = slack_notify_rodou_dagrun Connection Type = Slack API Description = {\"channel\": \"nome-do-channel-para-mandar-mensagem\"} Slack API Token = obtido no passo 1","title":"Notifica\u00e7\u00e3o de erros"},{"location":"como_utilizar/notificacao_de_erros/#notificacao-de-erros-na-execucao-das-dags","text":"\u00c9 importante recordar que o Ro-DOU permite o envio de mensagens via Slack quando ocorre alguma falha na execu\u00e7\u00e3o da DAG no Apache Airflow. Para usar essa funcionalidade, efetue as seguintes configura\u00e7\u00f5es: Criar o app no Slack conforme orienta\u00e7\u00f5es do v\u00eddeo How to Add Slack Notifications to Your Airflow DAG's with Airflow Notifiers . Criar uma conex\u00e3o no Apache Airflow com a seguinte configura\u00e7\u00e3o: Connection Id = slack_notify_rodou_dagrun Connection Type = Slack API Description = {\"channel\": \"nome-do-channel-para-mandar-mensagem\"} Slack API Token = obtido no passo 1","title":"Notifica\u00e7\u00e3o de erros na execu\u00e7\u00e3o das DAGs"},{"location":"como_utilizar/usuarios/","text":"Usu\u00e1rios internos e externos Usu\u00e1rios do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos Para as unidades do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos que desejem solicitar a utiliza\u00e7\u00e3o de clippings via Ro-DOU, a Secretaria de Gest\u00e3o e Inova\u00e7\u00e3o do MGI est\u00e1 dispon\u00edvel para auxili\u00e1-las a configurar o servi\u00e7o. \u00c9 preciso que a unidade interessada encaminhe as seguintes informa\u00e7\u00f5es para o endere\u00e7o seges.cginf@gestao.gov.br : texto do assunto do e-mail que conter\u00e1 o relat\u00f3rio do Ro-DOU; lista de termos (palavras-chaves) para a pesquisa, separadas linha a linha; se\u00e7\u00e3o ou se\u00e7\u00f5es do DOU que dever\u00e1(\u00e3o) ser pesquisada(s); inclus\u00e3o ou exclus\u00e3o da edi\u00e7\u00e3o extra e/ou suplementar do DOU na pesquisa; necessidade ou dispensa de que um arquivo de planilha .CSV seja anexado ao e-mail com os resultados; interesse em receber o e-mail, mesmo se nenhum resultado da pesquisa no DOU for encontrado para um dia espec\u00edfico; hor\u00e1rio e dias da semana para realiza\u00e7\u00e3o da pesquisa e envio do relat\u00f3rio (por padr\u00e3o, ocorre \u00e0s 9h da manh\u00e3, de segunda-feira a sexta-feira); e lista com os endere\u00e7os de e-mail que receber\u00e3o o relat\u00f3rio do Ro-DOU. Os termos de pesquisa devem ser registrados no Git ou em uma tabela no banco de dados? Depende. Se os termos de pesquisa s\u00e3o relativamente poucos e t\u00eam a expectativa de mudan\u00e7as infrequentes, deixar no yaml (Git). Se os termos de pesquisa s\u00e3o muito numerosos e t\u00eam a expectativa de mudarem constantemente, usar uma tabela no banco de dados. Assim, uma outra DAG ou processo pode manter essa tabela sempre atualizada, sem que nada precise mudar no Git. Usu\u00e1rios externos (de fora do MGI) Usu\u00e1rios de \u00f3rg\u00e3os p\u00fablicos que n\u00e3o sejam unidades do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos poder\u00e3o enviar d\u00favidas ou coment\u00e1rios ao endere\u00e7o seges.cginf@gestao.gov.br .","title":"Usu\u00e1rios internos e externos"},{"location":"como_utilizar/usuarios/#usuarios-internos-e-externos","text":"","title":"Usu\u00e1rios internos e externos"},{"location":"como_utilizar/usuarios/#usuarios-do-ministerio-da-gestao-e-da-inovacao-em-servicos-publicos","text":"Para as unidades do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos que desejem solicitar a utiliza\u00e7\u00e3o de clippings via Ro-DOU, a Secretaria de Gest\u00e3o e Inova\u00e7\u00e3o do MGI est\u00e1 dispon\u00edvel para auxili\u00e1-las a configurar o servi\u00e7o. \u00c9 preciso que a unidade interessada encaminhe as seguintes informa\u00e7\u00f5es para o endere\u00e7o seges.cginf@gestao.gov.br : texto do assunto do e-mail que conter\u00e1 o relat\u00f3rio do Ro-DOU; lista de termos (palavras-chaves) para a pesquisa, separadas linha a linha; se\u00e7\u00e3o ou se\u00e7\u00f5es do DOU que dever\u00e1(\u00e3o) ser pesquisada(s); inclus\u00e3o ou exclus\u00e3o da edi\u00e7\u00e3o extra e/ou suplementar do DOU na pesquisa; necessidade ou dispensa de que um arquivo de planilha .CSV seja anexado ao e-mail com os resultados; interesse em receber o e-mail, mesmo se nenhum resultado da pesquisa no DOU for encontrado para um dia espec\u00edfico; hor\u00e1rio e dias da semana para realiza\u00e7\u00e3o da pesquisa e envio do relat\u00f3rio (por padr\u00e3o, ocorre \u00e0s 9h da manh\u00e3, de segunda-feira a sexta-feira); e lista com os endere\u00e7os de e-mail que receber\u00e3o o relat\u00f3rio do Ro-DOU. Os termos de pesquisa devem ser registrados no Git ou em uma tabela no banco de dados? Depende. Se os termos de pesquisa s\u00e3o relativamente poucos e t\u00eam a expectativa de mudan\u00e7as infrequentes, deixar no yaml (Git). Se os termos de pesquisa s\u00e3o muito numerosos e t\u00eam a expectativa de mudarem constantemente, usar uma tabela no banco de dados. Assim, uma outra DAG ou processo pode manter essa tabela sempre atualizada, sem que nada precise mudar no Git.","title":"Usu\u00e1rios do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos"},{"location":"como_utilizar/usuarios/#usuarios-externos-de-fora-do-mgi","text":"Usu\u00e1rios de \u00f3rg\u00e3os p\u00fablicos que n\u00e3o sejam unidades do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos poder\u00e3o enviar d\u00favidas ou coment\u00e1rios ao endere\u00e7o seges.cginf@gestao.gov.br .","title":"Usu\u00e1rios externos (de fora do MGI)"},{"location":"definicao/rodou/","text":"O que \u00e9 Ro-DOU? Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 as seguintes informa\u00e7\u00f5es sobre o Ro-DOU: Defini\u00e7\u00e3o Arquitetura Defini\u00e7\u00e3o Conforme dito na p\u00e1gina inicial, o Ro-DOU \u00e9 uma ferramenta que efetua um clipping do Di\u00e1rio Oficial da Uni\u00e3o ( D.O.U. ) e dos Di\u00e1rios Oficiais de munic\u00edpios, por meio do Querido Di\u00e1rio . O Ro-DOU permite o recebimento de notifica\u00e7\u00f5es (via e-mail, Slack, Discord ou outros) de todas as publica\u00e7\u00f5es que contenham as palavras-chaves que voc\u00ea definir. O Ro-DOU gera dinamicamente grafos ac\u00edclicos dirigidos (DAGs) no Apache Airflow . Uma DAG nada mais \u00e9 que um fluxo de tarefas executadas em sequ\u00eancia ou de maneira paralela, a partir de um c\u00f3digo Python. Para entender com mais detalhes t\u00e9cnicos como uma DAG do Airflow funciona, clique aqui . Nos arquivos YAML, \u00e9 poss\u00edvel configurar os detalhes dos termos de pesquisa desejado (as palavras-chaves) e os contatos (e.g. endere\u00e7os de e-mail) para recebimento dos resultados da pesquisa. Arquitetura A maneira como os diferentes componentes do Ro-DOU se relacionam pode ser sintetizada no diagrama abaixo. Para ampliar a imagem, clique aqui .","title":"O que \u00e9 Ro-DOU?"},{"location":"definicao/rodou/#o-que-e-ro-dou","text":"Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 as seguintes informa\u00e7\u00f5es sobre o Ro-DOU: Defini\u00e7\u00e3o Arquitetura","title":"O que \u00e9 Ro-DOU?"},{"location":"definicao/rodou/#definicao","text":"Conforme dito na p\u00e1gina inicial, o Ro-DOU \u00e9 uma ferramenta que efetua um clipping do Di\u00e1rio Oficial da Uni\u00e3o ( D.O.U. ) e dos Di\u00e1rios Oficiais de munic\u00edpios, por meio do Querido Di\u00e1rio . O Ro-DOU permite o recebimento de notifica\u00e7\u00f5es (via e-mail, Slack, Discord ou outros) de todas as publica\u00e7\u00f5es que contenham as palavras-chaves que voc\u00ea definir. O Ro-DOU gera dinamicamente grafos ac\u00edclicos dirigidos (DAGs) no Apache Airflow . Uma DAG nada mais \u00e9 que um fluxo de tarefas executadas em sequ\u00eancia ou de maneira paralela, a partir de um c\u00f3digo Python. Para entender com mais detalhes t\u00e9cnicos como uma DAG do Airflow funciona, clique aqui . Nos arquivos YAML, \u00e9 poss\u00edvel configurar os detalhes dos termos de pesquisa desejado (as palavras-chaves) e os contatos (e.g. endere\u00e7os de e-mail) para recebimento dos resultados da pesquisa.","title":"Defini\u00e7\u00e3o"},{"location":"definicao/rodou/#arquitetura","text":"A maneira como os diferentes componentes do Ro-DOU se relacionam pode ser sintetizada no diagrama abaixo. Para ampliar a imagem, clique aqui .","title":"Arquitetura"},{"location":"oficinas_midias/oficinas_midias/","text":"Oficinas e demais m\u00eddias sobre o Ro-DOU Conhe\u00e7a o Ro-DOU - p\u00e1gina institucional do Minist\u00e9rio de Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos. V\u00eddeo de apresenta\u00e7\u00e3o - v\u00eddeo institucional do MGI sobre o Ro-DOU. Ro-DOU - Rob\u00f4 de minera\u00e7\u00e3o do Di\u00e1rio Oficial da Uni\u00e3o - apresenta\u00e7\u00e3o completa no canal da ENAP no YouTube, feita na Semana de Inova\u00e7\u00e3o de 2021. Ro-DOU - Rob\u00f4 de minera\u00e7\u00e3o do Di\u00e1rio Oficial da Uni\u00e3o - palestra sobre o Ro-DOU no evento Python Brasil 2024 - Rio de Janeiro.","title":"Conte\u00fados sobre o Ro-DOU"},{"location":"oficinas_midias/oficinas_midias/#oficinas-e-demais-midias-sobre-o-ro-dou","text":"Conhe\u00e7a o Ro-DOU - p\u00e1gina institucional do Minist\u00e9rio de Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos. V\u00eddeo de apresenta\u00e7\u00e3o - v\u00eddeo institucional do MGI sobre o Ro-DOU. Ro-DOU - Rob\u00f4 de minera\u00e7\u00e3o do Di\u00e1rio Oficial da Uni\u00e3o - apresenta\u00e7\u00e3o completa no canal da ENAP no YouTube, feita na Semana de Inova\u00e7\u00e3o de 2021. Ro-DOU - Rob\u00f4 de minera\u00e7\u00e3o do Di\u00e1rio Oficial da Uni\u00e3o - palestra sobre o Ro-DOU no evento Python Brasil 2024 - Rio de Janeiro.","title":"Oficinas e demais m\u00eddias sobre o Ro-DOU"},{"location":"outros/contato/","text":"Contato O Ro-DOU \u00e9 desenvolvido e mantido pela Coordena\u00e7\u00e3o-Geral de Gest\u00e3o da Informa\u00e7\u00e3o, \u00f3rg\u00e3o do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos: https://www.gov.br/gestao/pt-br . D\u00favidas, sugest\u00f5es e demais coment\u00e1rios sobre o Ro-DOU podem ser enviados ao endere\u00e7o de e-mail seges.cginf@gestao.gov.br . Intera\u00e7\u00f5es de car\u00e1ter t\u00e9cnico e sugest\u00f5es de melhoria no c\u00f3digo-fonte e nas funcionalidades do Ro-DOU podem ser enviadas diretamente via GitHub, por meio da abertura de issues : https://github.com/gestaogovbr/Ro-dou .","title":"Contato"},{"location":"outros/contato/#contato","text":"O Ro-DOU \u00e9 desenvolvido e mantido pela Coordena\u00e7\u00e3o-Geral de Gest\u00e3o da Informa\u00e7\u00e3o, \u00f3rg\u00e3o do Minist\u00e9rio da Gest\u00e3o e da Inova\u00e7\u00e3o em Servi\u00e7os P\u00fablicos: https://www.gov.br/gestao/pt-br . D\u00favidas, sugest\u00f5es e demais coment\u00e1rios sobre o Ro-DOU podem ser enviados ao endere\u00e7o de e-mail seges.cginf@gestao.gov.br . Intera\u00e7\u00f5es de car\u00e1ter t\u00e9cnico e sugest\u00f5es de melhoria no c\u00f3digo-fonte e nas funcionalidades do Ro-DOU podem ser enviadas diretamente via GitHub, por meio da abertura de issues : https://github.com/gestaogovbr/Ro-dou .","title":"Contato"},{"location":"outros/faq/","text":"FAQ e problemas frequentes Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 perguntas e respostas comuns e solu\u00e7\u00e3o de problemas mais frequentes na utiliza\u00e7\u00e3o do Ro-DOU. Do que \u00e9 preciso para instalar o Ro-DOU? As instru\u00e7\u00f5es detalhadas de instala\u00e7\u00e3o est\u00e3o neste link . Como configurar os par\u00e2metros de pesquisa do Ro-DOU? Os par\u00e2metros devem ser editados no arquivo em formato yml. Qual a configura\u00e7\u00e3o m\u00ednima para a instala\u00e7\u00e3o do Ro-DOU? \u00c9 recomendado 4 Gb de mem\u00f3ria RAM e 2 Gb de espa\u00e7o em disco pelo menos. Posso rodar o Ro-DOU no meu computador pessoal? Sim. O Ro-DOU pode ser instalado em qualquer sistema operacional com suporte ao Docker. Quais s\u00e3o as fontes de dados do Ro-DOU? Os dados s\u00e3o obtidos via INLABS, API da Imprensa Nacional e API do Querido Di\u00e1rio. De que forma o Ro-DOU \u00e9 capaz de enviar relat\u00f3rios? Via e-mail, Slack, Discord. Preciso pagar pra usar o Ro-DOU? N\u00e3o, ele \u00e9 gratuito. Posso usar o Ro-DOU para fazer buscas nas edi\u00e7\u00f5es mais antigas do DOU? Sim, basta indicar a data desejada no campo \"trigger_date\" ao disparar manualmente a DAG. Como receber atualiza\u00e7\u00f5es de vers\u00e3o do Ro-DOU? Sim, basta acompanhar o change log (log de atualiza\u00e7\u00f5es) dispon\u00edvel aqui . Posso utilizar o Ro-dou em meu \u00f3rg\u00e3o? Sim. Confira as instru\u00e7\u00f5es aqui . Posso utilizar o Ro-dou na minha empresa privada? Sim. N\u00e3o s\u00e3o cobrados direitos autorais ou de exclusividade. Existe um limite de acessos di\u00e1rio para buscas com o Ro-DOU? N\u00e3o. Os acessos s\u00e3o ilimitados. \u00c9 necess\u00e1rio fazer alguma configura\u00e7\u00e3o de fuso hor\u00e1rio para o Ro-DOU? Sim. O padr\u00e3o \u00e9 Am\u00e9rica-S\u00e3o Paulo para o ambiente Airflow que d\u00e1 sustenta\u00e7\u00e3o ao Ro-DOU atrav\u00e9s da vari\u00e1vel de ambiente chamada AIRFLOW__CORE__DEFAULT__TIMEZONE. Posso usar o Ro-DOU no exterior? Sim. O Ro-DOU pode ser executado em qualquer lugar desde que tenha acesso \u00e0 internet.","title":"FAQ"},{"location":"outros/faq/#faq-e-problemas-frequentes","text":"Nesta se\u00e7\u00e3o, voc\u00ea encontrar\u00e1 perguntas e respostas comuns e solu\u00e7\u00e3o de problemas mais frequentes na utiliza\u00e7\u00e3o do Ro-DOU. Do que \u00e9 preciso para instalar o Ro-DOU? As instru\u00e7\u00f5es detalhadas de instala\u00e7\u00e3o est\u00e3o neste link . Como configurar os par\u00e2metros de pesquisa do Ro-DOU? Os par\u00e2metros devem ser editados no arquivo em formato yml. Qual a configura\u00e7\u00e3o m\u00ednima para a instala\u00e7\u00e3o do Ro-DOU? \u00c9 recomendado 4 Gb de mem\u00f3ria RAM e 2 Gb de espa\u00e7o em disco pelo menos. Posso rodar o Ro-DOU no meu computador pessoal? Sim. O Ro-DOU pode ser instalado em qualquer sistema operacional com suporte ao Docker. Quais s\u00e3o as fontes de dados do Ro-DOU? Os dados s\u00e3o obtidos via INLABS, API da Imprensa Nacional e API do Querido Di\u00e1rio. De que forma o Ro-DOU \u00e9 capaz de enviar relat\u00f3rios? Via e-mail, Slack, Discord. Preciso pagar pra usar o Ro-DOU? N\u00e3o, ele \u00e9 gratuito. Posso usar o Ro-DOU para fazer buscas nas edi\u00e7\u00f5es mais antigas do DOU? Sim, basta indicar a data desejada no campo \"trigger_date\" ao disparar manualmente a DAG. Como receber atualiza\u00e7\u00f5es de vers\u00e3o do Ro-DOU? Sim, basta acompanhar o change log (log de atualiza\u00e7\u00f5es) dispon\u00edvel aqui . Posso utilizar o Ro-dou em meu \u00f3rg\u00e3o? Sim. Confira as instru\u00e7\u00f5es aqui . Posso utilizar o Ro-dou na minha empresa privada? Sim. N\u00e3o s\u00e3o cobrados direitos autorais ou de exclusividade. Existe um limite de acessos di\u00e1rio para buscas com o Ro-DOU? N\u00e3o. Os acessos s\u00e3o ilimitados. \u00c9 necess\u00e1rio fazer alguma configura\u00e7\u00e3o de fuso hor\u00e1rio para o Ro-DOU? Sim. O padr\u00e3o \u00e9 Am\u00e9rica-S\u00e3o Paulo para o ambiente Airflow que d\u00e1 sustenta\u00e7\u00e3o ao Ro-DOU atrav\u00e9s da vari\u00e1vel de ambiente chamada AIRFLOW__CORE__DEFAULT__TIMEZONE. Posso usar o Ro-DOU no exterior? Sim. O Ro-DOU pode ser executado em qualquer lugar desde que tenha acesso \u00e0 internet.","title":"FAQ e problemas frequentes"},{"location":"outros/links/","text":"Links relevantes O Di\u00e1rio Oficial da Uni\u00e3o (D.O.U.) \u00e9 publicado pela Imprensa Nacional: Di\u00e1rio Oficial da Uni\u00e3o Para operar, o Ro-DOU utiliza diferentes tecnologias, ferramentas e depend\u00eancias. Podem ser destacadas as seguintes: Python Apache Airflow Docker Docker Compose Pandas YAML O Ro-DOU tamb\u00e9m utiliza as funcionalidades das ferramentas INLABS e Querido Di\u00e1rio: INLABS Querido Di\u00e1rio Este site de documenta\u00e7\u00e3o do Ro-DOU foi elaborado com a ajuda do MkDocs: MkDocs","title":"Links relevantes"},{"location":"outros/links/#links-relevantes","text":"O Di\u00e1rio Oficial da Uni\u00e3o (D.O.U.) \u00e9 publicado pela Imprensa Nacional: Di\u00e1rio Oficial da Uni\u00e3o Para operar, o Ro-DOU utiliza diferentes tecnologias, ferramentas e depend\u00eancias. Podem ser destacadas as seguintes: Python Apache Airflow Docker Docker Compose Pandas YAML O Ro-DOU tamb\u00e9m utiliza as funcionalidades das ferramentas INLABS e Querido Di\u00e1rio: INLABS Querido Di\u00e1rio Este site de documenta\u00e7\u00e3o do Ro-DOU foi elaborado com a ajuda do MkDocs: MkDocs","title":"Links relevantes"}]} \ No newline at end of file diff --git a/search/worker.js b/search/worker.js new file mode 100644 index 0000000..8628dbc --- /dev/null +++ b/search/worker.js @@ -0,0 +1,133 @@ +var base_path = 'function' === typeof importScripts ? '.' : '/search/'; +var allowSearch = false; +var index; +var documents = {}; +var lang = ['en']; +var data; + +function getScript(script, callback) { + console.log('Loading script: ' + script); + $.getScript(base_path + script).done(function () { + callback(); + }).fail(function (jqxhr, settings, exception) { + console.log('Error: ' + exception); + }); +} + +function getScriptsInOrder(scripts, callback) { + if (scripts.length === 0) { + callback(); + return; + } + getScript(scripts[0], function() { + getScriptsInOrder(scripts.slice(1), callback); + }); +} + +function loadScripts(urls, callback) { + if( 'function' === typeof importScripts ) { + importScripts.apply(null, urls); + callback(); + } else { + getScriptsInOrder(urls, callback); + } +} + +function onJSONLoaded () { + data = JSON.parse(this.responseText); + var scriptsToLoad = ['lunr.js']; + if (data.config && data.config.lang && data.config.lang.length) { + lang = data.config.lang; + } + if (lang.length > 1 || lang[0] !== "en") { + scriptsToLoad.push('lunr.stemmer.support.js'); + if (lang.length > 1) { + scriptsToLoad.push('lunr.multi.js'); + } + if (lang.includes("ja") || lang.includes("jp")) { + scriptsToLoad.push('tinyseg.js'); + } + for (var i=0; i < lang.length; i++) { + if (lang[i] != 'en') { + scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); + } + } + } + loadScripts(scriptsToLoad, onScriptsLoaded); +} + +function onScriptsLoaded () { + console.log('All search scripts loaded, building Lunr index...'); + if (data.config && data.config.separator && data.config.separator.length) { + lunr.tokenizer.separator = new RegExp(data.config.separator); + } + + if (data.index) { + index = lunr.Index.load(data.index); + data.docs.forEach(function (doc) { + documents[doc.location] = doc; + }); + console.log('Lunr pre-built index loaded, search ready'); + } else { + index = lunr(function () { + if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { + this.use(lunr[lang[0]]); + } else if (lang.length > 1) { + this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility + } + this.field('title'); + this.field('text'); + this.ref('location'); + + for (var i=0; i < data.docs.length; i++) { + var doc = data.docs[i]; + this.add(doc); + documents[doc.location] = doc; + } + }); + console.log('Lunr index built, search ready'); + } + allowSearch = true; + postMessage({config: data.config}); + postMessage({allowSearch: allowSearch}); +} + +function init () { + var oReq = new XMLHttpRequest(); + oReq.addEventListener("load", onJSONLoaded); + var index_path = base_path + '/search_index.json'; + if( 'function' === typeof importScripts ){ + index_path = 'search_index.json'; + } + oReq.open("GET", index_path); + oReq.send(); +} + +function search (query) { + if (!allowSearch) { + console.error('Assets for search still loading'); + return; + } + + var resultDocuments = []; + var results = index.search(query); + for (var i=0; i < results.length; i++){ + var result = results[i]; + doc = documents[result.ref]; + doc.summary = doc.text.substring(0, 200); + resultDocuments.push(doc); + } + return resultDocuments; +} + +if( 'function' === typeof importScripts ) { + onmessage = function (e) { + if (e.data.init) { + init(); + } else if (e.data.query) { + postMessage({ results: search(e.data.query) }); + } else { + console.error("Worker - Unrecognized message: " + e); + } + }; +} diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..0f8724e --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 0000000..18c6e92 Binary files /dev/null and b/sitemap.xml.gz differ