editoramoan/moan-ark
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Rafael Tavares Juliani 2023-10-19 02:18:03 -03:00
parent ddad9a2c91
commit 5f66831738
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -1,13 +1,12 @@
# moan-ark # moan-ark
Todos os identificadores ARK gerados pela Editora Moan Todos os identificadores ARK gerados pela Editora Moan e um sistema de geração e direcionamento de identificadores ARK.
## O que você vai encontrar aqui? ## O que você vai encontrar aqui?
Aqui, você encontrará: Aqui, você encontrará:
- 2 arquivos (ark_lista.yml e ark_lista.json) contendo uma lista de todos os identificadores ARK gerados pela Editora Moan. Nesses, arquivos há o identificador, o título, o tipo de objeto (formato), o autor e um link para o arquivo com os metadados completos. Substitua pelos seus ARK; - 2 arquivos (ark_lista.yml e ark_lista.json) contendo uma lista de todos os identificadores ARK gerados pela Editora Moan. Nesses, arquivos há o identificador, o título, o tipo de objeto (formato), o autor e um link para o arquivo com os metadados completos. Substitua pelos seus ARK;
- O arquivo gerar_ark.py para poder gerar os identificadores ARK da Editora Moan. Você poderá personalizar para o seu uso. - O arquivo gerar_ark.py para poder gerar os identificadores ARK da Editora Moan. Você poderá personalizar para o seu uso site_base para o endereço web que você vai colocar este repositório. Outro ponto importante é colocar um redirecionamento no seu servidor para cair no seu site_base toda vez que alguém estiver buscando um ARK. Colocamos o seguinte redirecionamento para funcionar com o index.php: "^/ark:(.*)$" o que captura tudo que começa com "/ark:" após o seu domínio. E redirecionamos para "$site_base/?ark=$1". Isto é, o ARK, sem o rótulo, estará no parâmetro "ark". Mais um detalhe importante... Se você não usar nenhum tratamento para quando os seus ARK forem acessados por leitura de um qr code, retire essa importação e todas as chamadas da função registrarAcessoQrCode. O arquivo "funcaoQRCode.php" não está neste repositório Github, pois é de uso interno da Editora Moan;
- O arquivo index.php faz o direcionamento dos ARK. Nele, você deve trocar a variável $pasta_json se você não estiver o padrão deste repositório que é "json". Você deve trocar também, este é importante, a variável $site_base para o endereço web que você vai colocar este repositório. Outro ponto importante é colocar um redirecionamento no seu servidor para cair no seu $site_base toda vez que alguém estiver buscando um ARK. Colocamos o seguinte redirecionamento para funcionar com o index.php: "^/ark:(.*)$" o que captura tudo que começa com "/ark:" após o seu domínio. E redirecionamos para "$site_base/?ark=$1". Isto é, o ARK, sem o rótulo, estará no parâmetro "ark". Mais um detalhe importante... Se você não usar nenhum tratamento para quando os seus ARK forem acessados por leitura de um qr code, retire essa importação e todas as chamadas da função registrarAcessoQrCode. O arquivo "funcaoQRCode.php" não está neste repositório Github, pois é de uso interno da Editora Moan;
- Os demais arquivos são os ARK com todos os seus metadados. Cada ARK possui um único arquivo YAML e uma cópia na versão JSON. Substitua pelos seus ARK. - Os demais arquivos são os ARK com todos os seus metadados. Cada ARK possui um único arquivo YAML e uma cópia na versão JSON. Substitua pelos seus ARK.
Os arquivos ark_lista estão na raiz do repositório, mas cada ARK YAML completo está na pasta yaml e os JSON, na pasta json. Os arquivos ark_lista estão na raiz do repositório, mas cada ARK YAML completo está na pasta yaml e os JSON, na pasta json.