https://github.com/lexml/lexml-linker
Parser de remissões entre normas legislativas
https://github.com/lexml/lexml-linker
Last synced: 9 months ago
JSON representation
Parser de remissões entre normas legislativas
- Host: GitHub
- URL: https://github.com/lexml/lexml-linker
- Owner: lexml
- License: gpl-2.0
- Created: 2013-09-05T19:42:54.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2023-07-14T16:17:35.000Z (almost 3 years ago)
- Last Synced: 2025-07-31T17:50:33.967Z (11 months ago)
- Language: Haskell
- Size: 211 KB
- Stars: 10
- Watchers: 11
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LexML Linker
Parser de remissões entre normas legislativas
## Exemplos de uso
Nesta seção aprsentamos exemplos de uso do Linker, em ambiente Linux, usando a imagem docker. Os exemplos podem ser facilmente adaptados para outros ambientes, como MacOS ou Windows.
Para tornar mais os exemplos mais sucintos, usaremos o seguinte *alias* do Bash:
```bash
alias linker='docker run -i --rm lexmlbr/lexml-linker:latest /usr/bin/linkertool'
```
Primeiramente, para obter ajuda sobre as opções de comando do linker, basta usar a opção padrão `--help`
```bash
linker --help
```
Saída:
```
Common flags:
-f --frase=FRASE Frase a ser analisada
--entrada=FILE Arquivo de entrada. Se omitido ou
especificado "-", então será usada a entrada
padrão.
-s --saida=ITEM Arquivo de saída. Se omitido ou especificado
"-", então será usada a saída padrão.
-t --text Texto de entrada sem mark-up (default)
--hxml Texto de entrada com mark-up (XML/HTML)
-u --urns Gera lista de URNs reconhecidas (default)
--html Gera HTML decorado com links para o resolver
do LexML
-x --xml Gera XML decorado com as URNs reconhecidas
--enderecoresolver[=ITEM] Endereço do LexML Resolver, a string URNLEXML
será substituída pela URN. Usado quando com o
tipo de saída HTML
--contexto[=URN] URN Lex ML de contexto. Podem ser usados os
apelidos 'federal' e 'senado' para o contexto
de leis federais e resoluções do senado,
respectivamente, ou INLINE para ser lido
alternadamente às linhas de entrada
--logaregras Loga a execução das regras
--logatokens Loga a saída da análise léxica
--calculamd5 Calcula o MD5 da entrada
-d --debug Mostra mensagens de debug
-? --help Display help message
-V --version Print version information
```
Os parâmetros do linker estão nas seguintes categorias:
| Categoria | Parâmetro | Descrição | Exemplos |
|----|----|----|----|
| Fonte de Entrada | `-f` {texto}, `--frase=`{texto} | texto de entrada especificado diretamente na linha de comando | `linker -f 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011'` |
| | `--entrada=`FILE | o arquivo no caminho `FILE` é usado como entrada. Porém, ao usar o linker via container, o caminho precisa ser um caminho de dentro do container, o que torna essa opção pouco útil. Mas a mesma função pode ser obtida através do uso da entrada padrão como fonte. | |
| | `--entrada=-` | o texto é obtido à partir da entrada padrão do programa. Esse é o comportamento padrão caso nenhuma opção de fonte de entrada seja especificada. | `echo 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011' \| linker` |
|Formato da entrada|`-t`, `--text`|A entrada é um aquivo texto simples. Este é o formato de entrada padrão caso nenhuma opção de formato de entrada seja especificada.| `echo 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011' \| linker` |
| |`--hxml`|A entrada é um aquivo XML (formato LexML) ou X/HTML. | `echo '
Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011
' \| linker --hxml` |
| Formato de Saída | `-u`, `--urns` | Gera na saída a lista de URNs de referências encontradas no texto. Este é o formato de saída padrão caso nenhuma opção de formato de saída seja especificada. | `echo 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011' \| linker` |
| | `--html` | Gera na saída o HTML de entrada decorado com hiperlinks para o site LexML. O endereço base para as URLs é dado pela opção --enderecoresolver`. | `echo 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011
' \| linker --hxml --html` |
| | `-x`, `--xml` | Saída no formato XML do LexML com links anotados com URNs. | `echo 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011
' \| linker --hxml --xml` |
| | --enderecoresolver={URL template} | Especifica o template para construir os URLs na opção `--html`. O template deve ser uma URL contendo a string `URNLEXML`, que será substituida pela URN identificada. | ``echo 'Os incisos I e III do par. 3o do art. 8o da Lei n.o. 12.527, de 18 de novembro de 2011
' \| linker --hxml --html --enderecoresolver="https://normas.leg.br/?urn=URNLEXML"`` |