🌐 ARK Plugin for OJS 3.5.x

Escolha seu idioma / Elija su idioma / Choose your language :
🇧🇷 Português | 🇪🇸 Español | 🇺🇸 English

---

🇧🇷 Português

Plugin ARK para OJS 3.5.x

Funcionalidades

• Gera identificadores ARK para Artigos e Edições
• Formato: ark:NAAN/SUASIGLAxxxx-yyyy
• Prefixo personalizado (2-6 letras maiúsculas)
• Geração automática ao acessar a aba de identificadores
• Botão "Gerar Novo ARK" com confirmação para substituição
• Detecção e prevenção automática de duplicatas
• Resolvedor integrado (funciona sem editar o .htaccess principal)
• Suporte a metadados ERC para artigos e edições
• Pronto para registro NAAN (n2t.net)
• Resolvedor inteligente que detecta se o ARK é de artigo ou edição
• Verificação de propriedade do NAAN via n2t.net para recuperar acesso

Instalação

1. Baixe o plugin do GitHub
2. Renomeie a pasta para ark
3. Copie a pasta ark para plugins/pubIds/
4. Vá para Configurações > Website > Plugins
5. Encontre o plugin de identificador público "ARK" e ative-o
6. Configure o plugin:

Configuração	Valor
Habilitar ARK para Artigos	✓ (opcional)
Habilitar ARK para Edições	✓ (opcional)
Prefixo ARK	Seu prefixo NAAN (ex.: ark:12345)
Prefixo Personalizado	2-6 letras maiúsculas (ex.: SIGLA)
URL do Resolvedor	https://n2t.net/ (ou seu próprio resolvedor)
Compartilhamento de dados	Básico (apenas dados técnicos) ou Completo (compartilha dados da revista)

Exemplo de Configuração

• Habilitar ARK para Artigos: Marcado
• Habilitar ARK para Edições: Marcado
• Prefixo ARK: ark:12345
• Prefixo Personalizado: SIGLA
• URL do Resolvedor: https://n2t.net/
• Compartilhamento de dados: Básico

ARK resultante para artigo: https://n2t.net/ark:12345/SIGLA1234-ABCD

ARK resultante para edição: https://n2t.net/ark:12345/SIGLA5678-EFGH

Ao fim da configuração, você verá um pré-visualizador.

Compartilhamento de Dados

O plugin recolhe dados de publicação para caso de bugs na versão usada. O plugin oferece duas opções de compartilhamento de dados para ajudar na melhoria do serviço:

Nível	Dados compartilhados
Básico	Apenas identificador NAAN, quantidade de ARKs gerados, versão do plugin e URL do site
Completo	Todos os dados do nível básico, mais o nome da revista, país, e-mail e idioma principal

Seus dados são protegidos em conformidade com a LGPD (Lei Geral de Proteção de Dados - Brasil) e o GDPR (Regulamento Geral de Proteção de Dados - União Europeia). Não recolhemos nenhum outro dado além destes nem usaremos seus dados para outros serviços.

O modo completo permite que sua revista apareça nas estatísticas públicas do ecossistema. Disponível em Estatísticas do plugin ARK

Como Funciona a Telemetria (Modelo Pull)

O plugin utiliza um sistema de telemetria baseado em pull onde o servidor central coleta dados das revistas de forma mensal programada:

1. Quando você salva as configurações do plugin, sua revista se registra no servidor central
2. O servidor atribui sua revista a um dia específico do mês (1-30) para coleta de dados
3. Nesse dia, o servidor puxa automaticamente os dados de telemetria da sua revista
4. Nenhum cron job ou tarefa agendada é necessária no seu servidor!

Benefícios para gestores de revistas:

• Configuração zero além das configurações do plugin
• Sem impacto no desempenho do seu servidor
• Seus dados ajudam a melhorar o ecossistema do plugin

Verificação de Propriedade (Área de Segurança)

Se você reinstalar o plugin ou migrar de servidor e receber a mensagem de que seu NAAN já está em uso, utilize a Área de Segurança nas configurações do plugin:

1. Clique no botão "Verificar Minha Propriedade"
2. O sistema consulta os metadados do seu NAAN no n2t.net
3. Compara o domínio registrado com o domínio atual do seu site
4. Se forem iguais, seu acesso é restaurado automaticamente
5. Se forem diferentes, você precisará atualizar o cadastro do seu NAAN na ARK Alliance

Esta verificação só pode ser feita uma vez por hora, por segurança.

Uso

Para Artigos

• Acesse o formulário do artigo, aba "Identificadores"
• Clique no botão "Gerar ARK" para gerar um novo identificador
• ARKs duplicados ou inválidos são prevenidos automaticamente

Para Edições

• Acesse Edições > Editar uma edição
• Vá para a aba "Identificadores"
• O ARK é gerado automaticamente ao carregar a página
• Se precisar de um novo ARK, clique em "Gerar Novo ARK" (um alerta de confirmação será exibido)
• ARKs duplicados são prevenidos automaticamente

Resolver e Registro NAAN (se você usa n2t.net) IMPORTANTE

Após instalar o plugin, configure seu target NAAN para: https://seudominio.com/plugins/pubIds/ark/resolver.php?ark=${value}

O plugin inclui um resolvedor integrado que funciona sem editar seu arquivo .htaccess principal. O resolvedor:

1. Recebe o identificador ARK via parâmetro ?ark=
2. Detecta automaticamente se o ARK pertence a um artigo ou uma edição
3. Redireciona para a página correspondente (302 Found)

Suporte a Metadados ERC (Inflexões ARK)

O resolvedor suporta inflexões ARK para artigos e edições:

Inflexão	Comportamento	Exemplo
(nenhuma)	Redireciona para o artigo/edição	?ark=SIGLA0001-ABCD
?	Retorna metadados ERC resumidos*	?ark=SIGLA0001-ABCD?
??	Retorna metadados ERC completos	?ark=SIGLA0001-ABCD??
.info	Retorna metadados ERC completos	?ark=SIGLA0001-ABCD.info
&info	Retorna metadados ERC completos	?ark=SIGLA0001-ABCD&info
?info	Retorna metadados ERC completos	?ark=SIGLA0001-ABCD?info

Exemplo:

• https://n2t.net/ark:16081/CRL0001-LURY?? → Retorna metadados ERC

*Nota: A inflexão ? (metadados resumidos) funciona apenas no acesso direto ao resolvedor, pois em "https://n2t.net/ark:16081/CRL0001-LURY?" o resolver da n2t.net entrega apenas o link sem a inflexão, levando à página do artigo.

Data de Implementação do ARK

Nas configurações do plugin, você pode definir uma data de implementação fixa para o seu periódico:

• Esta data representa quando seu periódico começou a suportar identificadores ARK
• Será exibida no campo erc-support.when dos metadados ERC
• A data deve estar no formato AAAAMMDD (exemplo: 20260215)
• Se não for definida, a data de publicação será usada como fallback

Exibição no Frontend

O ARK é exibido automaticamente em:

• Página da edição (issue view)
• Lista de edições (issue archive)
• Página do artigo (article view)

Solução de Problemas

Resolvedor retorna 403 Forbidden/Acesso negado?

O plugin inclui um arquivo .htaccess que concede acesso ao resolver.php. Se você ainda receber 403, verifique se seu .htaccess principal tem regras conflitantes ou se o arquivo .htaccess do plugin foi removido acidentalmente.

Resolvedor redireciona para página 404?

Verifique se o ARK está corretamente salvo no banco de dados e se o prefixo NAAN configurado corresponde ao utilizado no ARK.

ARK não aparece no formulário?

Certifique-se de que a opção correspondente (Artigos ou Edições) está marcada nas configurações do plugin e que o plugin está ativo.

Erro de ARK duplicado ao salvar?

O plugin previne automaticamente duplicatas verificando tanto artigos quanto edições. Se você encontrar este erro, clique no botão "Gerar Novo ARK" ao lado do campo para criar um identificador único.

O botão "Gerar Novo ARK" não aparece?

Recarregue a página (F5) e acesse diretamente a aba para gerar ARK.

Metadados ERC retornam data incorreta?

A data de implementação do ARK pode ser configurada nas opções do plugin. Certifique-se de que o campo "Data de Implementação" está preenchido corretamente no formato AAAAMMDD.

Recebi a mensagem "Este NAAN já está em uso" após reinstalar o plugin?

Utilize a Área de Segurança nas configurações do plugin. Clique em "Verificar Minha Propriedade" para restaurar seu acesso automaticamente. A verificação é feita via n2t.net e compara o domínio registrado no seu NAAN.

Desinstalar

1. Desative o plugin em Configurações > Website > Plugins
2. Remova a pasta ark de plugins/pubIds/

Voltar ao topo

Licença e créditos

---

🇪🇸 Español

Plugin ARK para OJS 3.5.x

Características

• Genera identificadores ARK para Artículos y Ediciones
• Formato: ark:NAAN/SUSIGLAxxxx-yyyy
• Prefijo personalizado (2-6 letras mayúsculas)
• Generación automática al acceder a la pestaña de identificadores
• Botón "Generar Nuevo ARK" con confirmación para reemplazar
• Detección y prevención automática de duplicados
• Resolvedor integrado (funciona sin editar el .htaccess principal)
• Soporte de metadatos ERC para artículos y ediciones
• Listo para registro NAAN (n2t.net)
• Resolvedor inteligente que detecta si el ARK es de artículo o edición
• Verificación de propiedad del NAAN vía n2t.net para recuperar acceso

Instalación

1. Descargue el plugin de GitHub
2. Renombre la carpeta a ark
3. Copie la carpeta ark a plugins/pubIds/
4. Vaya a Configuraciones > Sitio > Plugins
5. Encuentre el plugin de identificador público "ARK" y actívelo
6. Configure el plugin:

Configuración	Valor
Habilitar ARK para Artículos	✓ (opcional)
Habilitar ARK para Ediciones	✓ (opcional)
Prefijo ARK	Su prefijo NAAN (ej.: ark:12345)
Prefijo Personalizado	2-6 letras mayúsculas (ej.: SIGLA)
URL del Resolvedor	https://n2t.net/ (o su propio resolvedor)
Compartir datos	Básico (solo datos técnicos) o Completo (comparte datos de la revista)

Ejemplo de Configuración

• Habilitar ARK para Artículos: Marcado
• Habilitar ARK para Ediciones: Marcado
• Prefijo ARK: ark:12345
• Prefijo Personalizado: SIGLA
• URL del Resolvedor: https://n2t.net/
• Compartir datos: Básico

ARK resultante para artículo: https://n2t.net/ark:12345/SIGLA1234-ABCD

ARK resultante para edición: https://n2t.net/ark:12345/SIGLA5678-EFGH

Al finalizar la configuración, podrá ver una vista previa de ejemplo de sus recursos.

Compartir Datos

El plugin recopila datos de publicación para casos de errores en la versión utilizada. El plugin ofrece dos opciones de intercambio de datos para ayudar a mejorar el servicio:

Nivel	Datos compartidos
Básico	Solo identificador NAAN, cantidad de ARKs generados, versión del plugin y URL del sitio
Completo	Todos los datos del nivel básico, más el nombre de la revista, país, correo electrónico e idioma principal

Sus datos están protegidos en cumplimiento con la LGPD (Ley General de Protección de Datos - Brasil) y el RGPD (Reglamento General de Protección de Datos - Unión Europea). No recopilamos ningún otro dato además de estos ni usaremos sus datos para otros servicios.

El modo completo permite que su revista aparezca en las estadísticas públicas del ecosistema. Disponible en Estadísticas del plugin ARK

Cómo Funciona la Telemetría (Modelo Pull)

El plugin utiliza un sistema de telemetría basado en pull donde el servidor central recopila datos de las revistas de forma mensual programada:

1. Cuando guarda la configuración del plugin, su revista se registra en el servidor central
2. El servidor asigna su revista a un día específico del mes (1-30) para la recolección de datos
3. Ese día, el servidor extrae automáticamente los datos de telemetría de su revista
4. ¡No necesita crons ni tareas programadas en su servidor!

Beneficios para los gestores de revistas:

• Configuración cero más allá de los ajustes del plugin
• Sin impacto en el rendimiento de su servidor
• Sus datos ayudan a mejorar el ecosistema del plugin

Verificación de Propiedad (Área de Seguridad)

Si reinstala el plugin o migra de servidor y recibe el mensaje de que su NAAN ya está en uso, utilice el Área de Seguridad en la configuración del plugin:

1. Haga clic en el botón "Verificar Mi Propiedad"
2. El sistema consulta los metadatos de su NAAN en n2t.net
3. Compara el dominio registrado con el dominio actual de su sitio
4. Si son iguales, su acceso se restaura automáticamente
5. Si son diferentes, deberá actualizar el registro de su NAAN en ARK Alliance

Esta verificación solo se puede realizar una vez por hora, por seguridad.

Uso

Para Artículos

• Acceda al formulario del artículo, pestaña "Identificadores"
• Haga clic en el botón "Generar ARK" para generar un nuevo identificador
• Los ARK duplicados o inválidos se previenen automáticamente

Para Ediciones

• Acceda a Ediciones > Editar una edición
• Vaya a la pestaña "Identificadores"
• El ARK se genera automáticamente al cargar la página
• Si necesita un nuevo ARK, haga clic en "Generar Nuevo ARK" (se mostrará una alerta de confirmación)
• Los ARKs duplicados se previenen automáticamente

Resolvedor y Registro NAAN (si usa n2t.net) IMPORTANTE

Después de instalar el plugin, configure su target NAAN en: https://sudominio.com/plugins/pubIds/ark/resolver.php?ark=${value}

El plugin incluye un resolvedor integrado que funciona sin editar su archivo .htaccess principal. El resolvedor:

1. Recibe el identificador ARK mediante el parámetro ?ark=
2. Detecta automáticamente si el ARK pertenece a un artículo o una edición
3. Redirige a la página correspondiente (302 Found)

Soporte de Metadatos ERC (Inflexiones ARK)

El resolvedor soporta inflexiones ARK para artículos y ediciones:

Inflexión	Comportamiento	Ejemplo
(ninguna)	Redirige al artículo/edición	?ark=SIGLA0001-ABCD
?	Devuelve metadatos ERC resumidos*	?ark=SIGLA0001-ABCD?
??	Devuelve metadatos ERC completos	?ark=SIGLA0001-ABCD??
.info	Devuelve metadatos ERC completos	?ark=SIGLA0001-ABCD.info
&info	Devuelve metadatos ERC completos	?ark=SIGLA0001-ABCD&info
?info	Devuelve metadatos ERC completos	?ark=SIGLA0001-ABCD?info

Ejemplo:

• https://n2t.net/ark:16081/CRL0001-LURY?? → Devuelve metadatos ERC

*Nota: La inflexión ? (metadatos resumidos) funciona solo en acceso directo al resolvedor, ya que en https://n2t.net/ark:16081/CRL0001-LURY? el resolvedor de n2t.net entrega solo el enlace sin la inflexión, llevando a la página del artículo.

Fecha de Implementación del ARK

En la configuración del plugin, puede definir una fecha de implementación fija para su revista:

• Esta fecha representa cuándo su revista comenzó a soportar identificadores ARK
• Se mostrará en el campo erc-support.when de los metadatos ERC
• La fecha debe estar en formato AAAAMMDD (ejemplo: 20260215)
• Si no se define, se usará la fecha de publicación como fallback

Visualización en el Frontend

El ARK se muestra automáticamente en:

• Página de la edición (issue view)
• Lista de ediciones (issue archive)
• Página del artículo (article view)

Solución de Problemas

¿El resolvedor devuelve 403 Forbidden/Acceso denegado?

El plugin incluye un archivo .htaccess que concede acceso a resolver.php. Si aún recibe 403, verifique si su .htaccess principal tiene reglas conflictivas o si el archivo .htaccess del plugin fue eliminado accidentalmente.

¿El resolvedor redirige a página 404?

Verifique que el ARK esté correctamente guardado en la base de datos y que el prefijo NAAN configurado coincida con el utilizado en el ARK.

¿El ARK no aparece en el formulario?

Asegúrese de que la opción correspondiente (Artículos o Ediciones) esté marcada en la configuración del plugin y que el plugin esté activo.

¿Error de ARK duplicado al guardar?

El plugin previene automáticamente duplicados verificando tanto artículos como ediciones. Si encuentra este error, haga clic en el botón "Generar Nuevo ARK" junto al campo para crear un identificador único.

¿El botón "Generar Nuevo ARK" no aparece?

Recargue la página (F5) y acceda directamente a la pestaña para generar el ARK.

¿Los metadatos ERC devuelven fecha incorrecta?

La fecha de implementación del ARK se puede configurar en las opciones del plugin. Asegúrese de que el campo "Fecha de Implementación" esté correctamente completado en el formato AAAAMMDD.

¿Recibí el mensaje "Este NAAN ya está en uso" después de reinstalar el plugin?

Utilice el Área de Seguridad en la configuración del plugin. Haga clic en "Verificar Mi Propiedad" para restaurar su acceso automáticamente. La verificación se realiza vía n2t.net y compara el dominio registrado en su NAAN.

Desinstalar

1. Desactive el plugin en Configuraciones > Sitio > Plugins
2. Elimine la carpeta ark de plugins/pubIds/

Volver al principio

Licencia y créditos

---

🇺🇸 English

Archival Resource Key (ARK) Plugin for OJS 3.5.x

Features

• Generates ARK identifiers for Articles and Issues
• Format: ark:NAAN/YOURPREFIXxxxx-yyyy
• Customizable prefix (2-6 uppercase letters)
• Automatic generation when accessing the identifiers tab
• "Generate New ARK" button with confirmation for replacement
• Automatic duplicate detection and prevention
• Built-in resolver (works without editing main .htaccess)
• ERC metadata support for articles and issues
• Ready for NAAN registration (n2t.net)
• Smart resolver that detects whether the ARK belongs to an article or issue
• NAAN Ownership verification via n2t.net to recover access

Installation

1. Download the plugin from GitHub
2. Rename the folder to ark
3. Copy the ark folder to plugins/pubIds/
4. Go to Settings > Website > Plugins
5. Find the "ARK" Public Identifier Plugin and enable it
6. Configure the plugin:

Setting	Value
Enable ARK for Articles	✓ (optional)
Enable ARK for Issues	✓ (optional)
ARK Prefix	Your NAAN prefix (e.g., ark:12345)
Custom Prefix	2-6 uppercase letters (e.g., PREFIX)
Resolver URL	https://n2t.net/ (or your own resolver)
Data sharing	Basic (technical data only) or Complete (shares journal data)

Configuration Example

• Enable ARK for Articles: Checked
• Enable ARK for Issues: Checked
• ARK Prefix: ark:12345
• Custom Prefix: PREFIX
• Resolver URL: https://n2t.net/
• Data sharing: Basic

Resulting ARK for article: https://n2t.net/ark:12345/PREFIX1234-ABCD

Resulting ARK for issue: https://n2t.net/ark:12345/PREFIX5678-EFGH

At the end of the configuration, you will be able to see an example preview for your resources.

Data Sharing

The plugin collects publication data for bug tracking purposes regarding the version used. The plugin offers two data sharing options to help improve the service:

Level	Data shared
Basic	Only NAAN identifier, number of ARKs generated, plugin version and site URL
Complete	All Basic level data, plus journal name, country, email and primary language

Your data is protected in compliance with LGPD (Brazilian General Data Protection Law) and GDPR (General Data Protection Regulation - European Union). We do not collect any other data beyond these nor will we use your data for other services.

Complete mode allows your journal to appear in public ecosystem statistics. Available at ARK Plugin Statistics

How Telemetry Works (Pull Model)

The plugin uses a pull-based telemetry system where the central server collects data from journals on a scheduled monthly basis:

1. When you save the plugin settings, your journal registers with the central server
2. The server assigns your journal to a specific day of the month (1-30) for data collection
3. On that day, the server automatically pulls telemetry data from your journal
4. No cron jobs or scheduled tasks are needed on your server!

Benefits for journal managers:

• Zero configuration required beyond plugin settings
• No impact on your server's performance
• Your data helps improve the plugin ecosystem

Ownership Verification (Security Area)

If you reinstall the plugin or migrate servers and receive a message that your NAAN is already in use, use the Security Area in the plugin settings:

1. Click the "Verify My Ownership" button
2. The system queries your NAAN metadata on n2t.net
3. Compares the registered domain with your current site domain
4. If they match, your access is restored automatically
5. If they differ, you need to update your NAAN registration with ARK Alliance

This verification can only be performed once per hour for security reasons.

Usage

For Articles

• Access the article form, "Identifiers" tab
• Click the "Generate ARK" button to create a new identifier
• Duplicate or invalid ARKs are automatically prevented

For Issues

• Access Issues > Edit an issue
• Go to the "Identifiers" tab
• The ARK is automatically generated when the page loads
• If you need a new ARK, click the "Generate New ARK" button (a confirmation alert will be shown)
• Duplicate ARKs are automatically prevented

Resolver and NAAN Registration (if using n2t.net) IMPORTANT

After installing the plugin, configure your NAAN target to: https://yourdomain.com/plugins/pubIds/ark/resolver.php?ark=${value}

The plugin includes a built-in resolver that works without editing your main .htaccess file. The resolver:

1. Receives the ARK identifier via the ?ark= parameter
2. Automatically detects whether the ARK belongs to an article or an issue
3. Redirects to the corresponding page (302 Found)

ERC Metadata Support (ARK Inflections)

The resolver supports ARK inflections for articles and issues:

Inflection	Behavior	Example
(none)	Redirects to article/issue	?ark=PREFIX0001-ABCD
?	Returns brief ERC metadata*	?ark=PREFIX0001-ABCD?
??	Returns full ERC metadata	?ark=PREFIX0001-ABCD??
.info	Returns full ERC metadata	?ark=PREFIX0001-ABCD.info
&info	Returns full ERC metadata	?ark=PREFIX0001-ABCD&info
?info	Returns full ERC metadata	?ark=PREFIX0001-ABCD?info

Example:

• https://n2t.net/ark:16081/CRL0001-LURY?? → Returns ERC metadata

*Note: The ? inflection (brief metadata) only works when accessing your resolver directly, because at https://n2t.net/ark:16081/CRL0001-LURY? the n2t.net resolver delivers only the link without the inflection, leading to the article page.

ARK Implementation Date

In the plugin settings, you can set a fixed implementation date for your journal:

• This date represents when your journal started supporting ARK identifiers
• It will be displayed in the erc-support.when field of the ERC metadata
• The date must be in YYYYMMDD format (e.g., 20260215)
• If not set, the publication date is used as fallback

Frontend Display

The ARK is automatically displayed on:

• Issue page (issue view)
• Issue archive list (issue archive)
• Article page (article view)

Troubleshooting

Does the resolver return 403 Forbidden/Access denied?

The plugin includes a .htaccess file that grants access to resolver.php. If you still get 403, check if your main .htaccess has conflicting rules or if the plugin's .htaccess file was accidentally removed.

Does the resolver redirect to a 404 page?

Verify that the ARK is correctly saved in the database and that the configured NAAN prefix matches the one used in the ARK.

Does the ARK not appear in the form?

Make sure the corresponding option (Articles or Issues) is checked in the plugin settings and that the plugin is active.

Getting a duplicate ARK error when saving?

The plugin automatically prevents duplicates by checking both articles and issues. If you encounter this error, click the "Generate New ARK" button next to the field to create a unique identifier.

Does the "Generate New ARK" button not appear?

Refresh the page (F5) and directly access the tab to generate the ARK.

Does ERC metadata return the wrong date?

The ARK implementation date can be configured in the plugin options. Make sure the "Implementation Date" field is correctly filled in YYYYMMDD format.

Did I receive the message "This NAAN is already in use" after reinstalling the plugin?

Use the Security Area in the plugin settings. Click "Verify My Ownership" to restore your access automatically. Verification is done via n2t.net and compares the domain registered in your NAAN.

Uninstallation

1. Disable the plugin in Settings > Website > Plugins
2. Remove the ark folder from plugins/pubIds/

Back to top

---

Licença / Licencia / License

GNU General Public License v2.0

LICENSE

---

Créditos / Credits

Baseado no | Basado en el | Based on

plugin pkp-ark-pubid © Yasiel Pérez Vera (2021)

---

Carnaubais Revista de Literatura

---

_{Lury Morais © 2026}