Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- suporte:attena [2019/07/05 14:07]
riufpe
+++ suporte:attena [2019/07/10 11:39] (atual)
riufpe
@@ Linha 2: / Linha 2: @@
 ===== Repositório ATTENA - Universidade Federal de Pernambuco - UFPE =====
 =====Apresentação=====
-Este manual tem como principal objetivo apresentar configurações que podem ser aplicadas em repositórios Dspace. Tais modificações foram aplicadas e testadas para o contexto do Repositório ATTENA da Universidade Federal de Pernambuco - UFPE, porém podem ser replicadas em quaisquer repositório Dspace com versão e configurações similares. Para as demais versões pode ser necessário a realização de adaptações. \\ Atualmente, o Repositório ATTENA encontra-se na versão 5.6 JSPUI do Dspace, instalado no servidor com as seguintes configurações:
+Este manual tem como objetivo apresentar algumas configurações que podem ser aplicadas em repositórios Dspace, visando a melhoria do layout. Tais modificações foram aplicadas e testadas para o contexto do Repositório ATTENA da Universidade Federal de Pernambuco - UFPE, porém podem ser replicadas em quaisquer repositório Dspace que esteja utilizando o JSPUI na versão 5.x. Para as demais versões pode ser necessário a realização de adaptações.
 | Dspace | 5.6 JSPUI |
@@ Linha 13: / Linha 13: @@
 =====Configurações Dspace=====
 ====Controle de Versão - GitLab====
-Devido ao desejo de realizar a implantação de uma nova identidade visual para o ATTENA, verificou-se a necessidade de uma ferramenta que possibilitasse o controle de versões e  registro do histórico de edições dos documentos do Dspace. \\ Para isso, optou-se por utilizar os serviços do GitLab da UFPE, no qual foi criado um diretório para o projeto ATTENA permitindo a continuidade e desenvolvimento do projeto. Contudo, as ferramentas de Git são fundamentais e poderão auxiliar para o controle de versões e manutenibilidade do sistema, dessa forma recomenda-se o registro através de ferramentas como Gitlab ou similares.
+Devido a crescente número de customizações no código fonte do Dspace, verificou-se a necessidade de uma ferramenta que possibilitasse o controle de versões e  registro do histórico de edições dos documentos do Dspace.
-====Modificaçoes de Layout====
+\\ Para isso, optou-se por utilizar os serviços do GitLab, no qual foi criado um diretório para o projeto ATTENA permitindo a continuidade e desenvolvimento do projeto. Contudo, as ferramentas de Git são fundamentais e poderão auxiliar para o controle de versões e manutenibilidade do sistema, dessa forma recomenda-se o registro através de ferramentas como Gitlab ou similares.
-  * **Alterar Logo**
+=====Modificaçoes de Layout=====
-Para realizar a alteração da logo, deve-se adicionar a nova imagem no diretório de imagens, por exemplo, **[dspace-base]/webapps/jspui/image/ufpe**, para o repositório ATTENA adicionamos a imagem denominada por attena-logo.png, sendo uma imagem com fundo transparente e dimensões de **272 pixels x 120 pixels**. Caso esteja utilizando uma versão limpa do Dspace, a logo padrão compreende no arquivo **dspace-logo-only.png**, que possui sua chamada nos arquivos indicados abaixo. \\ Sua chamada é realizada em três arquivos do diretório **[dspace-base]/webapps/jspui/layout**:
+====Alterar Logo====
+Para realizar a alteração da logo, deve-se adicionar a nova imagem no diretório de imagens, por exemplo, **[dspace-base]/webapps/jspui/image/ufpe**, para o repositório ATTENA adicionamos a imagem denominada por attena-logo.png, sendo uma imagem com fundo transparente e dimensões de **272 pixels x 120 pixels**. Caso esteja utilizando uma versão limpa do Dspace, a logo padrão compreende no arquivo **dspace-logo-only.png**, que possui sua chamada nos arquivos indicados abaixo.
+\\ Sua chamada é realizada em três arquivos do diretório **[dspace-base]/webapps/jspui/layout**:
 \\
 \\ - navbar-admin.jsp;
@@ Linha 24: / Linha 26: @@
 \\ Após a alteração do nome do arquivo padrão, será possível visualizar a alteração e realizar as adaptações necessárias no arquivo de css.
 \\
-  * **Alterar o favicon**
+ ====Alterar o favicon====
 O favicon do repositório, é a imagem que é mostrada na aba do navegador, se encontra no diretório **[dspace-base]/webapps/jspui/** denominada por **favicon.ico**. Caso deseje alterar o nome do arquivo, deve ser realizado alterações nos seguintes arquivos do diretório **[dspace-base]/src/main/webapp/layout**:
 \\
@@ Linha 33: / Linha 35: @@
 \\ Caso não, basta criar sua imagem nomear de “favicon.ico” e substituir o arquivo principal, conforme local indicado acima.
 \\
-  * **Alterar/Adicionar imagem ao background do menu**
+====Alterar/Adicionar imagem ao background do menu====
 Para realizar a inclusão da imagem no menu superior do repositório ATTENA, realizamos a adição da imagem a ser utilizada no diretório de imagens **[dspace-base]/webapps/jspui/image/ufpe/**, para o ATTENA o arquivo denomina-se ** bg-topo.jpg**.
 \\ Sua chamada é realizada dentro do diretório **[dspace-base]/webapps/jspui/layout** nos arquivos:
@@ Linha 42: / Linha 44: @@
 \\ Além disso, o navbar possui suas classes do CSS que podem ser configuradas no arquivo **dspace-theme.css** presente no diretório **[dspace-base]/webapps/jspui/static/css/boostrap/**.
 \\
-  * **Adicionar barra de serviços do governo**
+====Adicionar barra de serviços do governo====
 Acima do menu do ATTENA foi adicionado a barra de serviços do governo, através dela encontra-se informações e acesso direto a canais do governo brasileiro.
 \\ Para incluí-la deve ser adicionado o script externo fornecido pelo governo no Manual de Identidade Visual do Governo Federal, no arquivo no arquivo **header-default.jsp** presente no diretório **[dspace-base]/webapps/jspui/layout** e adicionar o script a seguir:
@@ Linha 71: / Linha 73: @@
 \\ Após a adição dessas configurações a barra do governo estará disponível.
 \\
-  * **Ativar/Desativar carrossel de submissões recentes**
+====Alterar Informações do rodapé do repositório====
-O Dspace permite a adição do carrossel com as submissões recentes na página inicial Repositório da UFPE. Para o Attena foi configurado para que apenas os últimos 5 itens ficassem com tal destaque.
-\\ Para ativá-lo deve-se alterar os seguintes arquivos no diretório **[dspace-base]/config/:**
-\\
-\\ - dspace.cfg.
-\\
-\\ Realizar a seguinte modificação **“recent.submissions.count”** de **0** para **5**. Para verificar as modificações o serviço do Tomcat (Servidor Web) deve ser reinicializado.
-\\
-  * **Alterar Informações do rodapé do repositório**
 As configurações do rodapé do repositório encontram-se no diretório **[dspace-base]/webapps/jspui/layout** no arquivo **footer-default.jsp**. Além desses arquivos pode-se encontrar configurações nos arquivos de folha de estilo no diretório **[dspace-base]/webapps/jspui/static/css/boostrap/.**
 \\
-  * **Adicionar função “Compartilhe esta página”**
+====Adicionar função “Compartilhe esta página”====
 Esta funcionalidade trata-se de um script externo fornecido pelo “https://www.addthis.com” que fornece suporte para o compartilhar informações e páginas do repositório. Além disso, permite uma forma de estatística de acesso ao repositório como pode ser visto na imagem abaixo:
 \\ Para configurá-la deve-se criar um acesso no site do Addthis, selecionar a forma visual que deseja incluir no seu repositório e salvar. Ao final do processo de criação será fornecido um script que pode ser adicionado onde desejar.
 \\
-  * **Barra do governo no rodapé**
+====Barra do governo no rodapé====
 Para adicionar a barra de rodapé do governo, deve-se adicionar as configurações no arquivo **footer-default.jsp.**
 \\
-  * **Adicionar páginas estáticas**
+====Adicionar páginas estáticas====
 Para apresentar informações sobre o repositório, disponibilizar manuais e FAQ, optou-se pela inclusão de páginas estáticas criadas dentro dos diretórios do Dspace. Através delas pode-se adicionar qualquer conteúdo desejado. Atualmente, o ATTENA possui as seguintes páginas no diretório criado **[dspace-base]/jspui/webapps/static/jsp:**
 \\
@@ Linha 101: / Linha 95: @@
 \\ Para a sua criação, cada arquivo deverá contém a estrutura base, similar aos outros arquivos .jsp, ou seja, deve-se iniciar importando as classes e barra de localização.
 \\
-  * **Adicionar filtros de busca**
+====Adicionar/Gerenciar arquivos do contraste====
+A funcionalidade de contraste compreende na modificação do estilo e cores do ATTENA para garantir a usabilidade de pessoas com baixa visão e necessidades especiais. No ATTENA, ela pode ser ativada/desativada ao clicar no ícone presente no menu superior.
+\\ Para adicionar a funcionalidade deve-se realizar um cópia do arquivo de CSS utilizado para configurar estilos presente no diretório [**dspace-base]/webapps/jspui/static/css/bootstrap**, renomear para um nome indicativo, por exemplo, **dspace-theme-contraste.css** e realizar as configurações na folha de estilo.
+\\ Para criar a funcionalidade no botão utilizou-se um script para realizar a troca da chamada do arquivo CSS e assim permitir a visualização das modificações.
+\\ Para o ATTENA foram adotadas as seguintes recomendações, de acordo com o **Modelo de Acessibilidade em Governo Eletrônico**:
+\\
+\\ - **Cor de fundo:** independente da cor utilizada, ela deve ser alterada para preto (#000000);
+\\ - **Cor de texto:** independente da cor utilizada, ela deve ser alterada para branco (#FFFFFF);
+\\ - **Links:** O modo normal do link deve ser sublinhado (para que ele se diferencie do texto normal), assim como o modo hover e o modo active. O link deve ser alterado para amarelo (#FFF333);
+\\ - **Ícones:** Todos os ícones devem ser brancos;
+\\ - **Linhas e Contornos:** As linhas e os contornos de elementos devem ser alterados para branco.
+\\
+ ====Modificar forma visual das estatísticas====
+A fim de melhorar a forma visual dos dados estatísticos do Repositório ATTENA, utilizou-se uma biblioteca JavaScript para desenhar gráficos a partir de elementos de tela em HTML5, o **ChartJS** (https://www.chartjs.org/).
+\\ Diante dessa nova forma visual os dados coletados pelo Dspace possuem agora uma forma mais atrativa e de fácil interpretação. Atualmente são coletados os seguintes dados:
+\\
+\\ - Número total de visitas;
+\\ - Número total de visitas por mês;
+\\ - Ranking de visitas por países;
+\\ - Ranking de visitas por cidades.
+\\
+\\ Para realizar tal modificação deve-se incluir as configurações recomendadas pelo ChartJs e criar adaptações no arquivo  **display-statistics.jsp**.
+\\
+=====Funcionalidades=====
+====Ativar/Desativar carrossel de submissões recentes====
+O Dspace permite a adição do carrossel com as submissões recentes na página inicial Repositório da UFPE. Para o Attena foi configurado para que apenas os últimos 5 itens ficassem com tal destaque.
+\\ Para ativá-lo deve-se alterar os seguintes arquivos no diretório **[dspace-base]/config/:**
+\\
+\\ - dspace.cfg.
+\\
+\\ Realizar a seguinte modificação **“recent.submissions.count”** de **0** para **5**. Para verificar as modificações o serviço do Tomcat (Servidor Web) deve ser reinicializado.
+\\
+====Adicionar filtros de busca====
 As configurações dos filtros de busca são encontrados no diretório **[dspace-base]/config/spring/api/** no arquivo** discovery.xml**.
 \\ Deve-se incluir nos dois campos **<property name="searchFilters">** o filtro que deseja-se incluir, por exemplo: **<ref bean="searchFilterType" />** e adicionar a referência ao final do arquivo:
@@ Linha 115: / Linha 141: @@
 \\ Por fim, para que as modificações sejam aplicadas, deve-se realizar uma reindexação completa dos itens, para que os filtros consigam recuperar os itens. Para isso, deve-se executar dentro do diretório **[dspace-base]/bin** o seguinte comando:
 <code> ./dspace index-discovery -f </code>
-// *Este procedimento em repositório com muitos itens pode demorar cerca de 5-6 horas. //
+// *Este procedimento poderá levar várias horas de execução pois dependerá da quantidade de itens armazenados no repositório. //
 \\
-  * **Modificar a saída dos resultados da busca**
+====Modificar a saída dos resultados da busca====
 Por padrão o Dspace apresenta como retorno das buscas os seguintes campos: **data de defesa/data do documento, título e todos os resultados relacionados ao metadado dc.contributor**, ou seja, informações dos metadados **dc.contributor.author, dc.contributor.advisor, dc.contributor.authorLattes**, entre outros. Para alterar esse retorno e deixar apenas o autor (dc.contributor.author) do item, deve-se modificar o arquivo **[dspace-base]/config/dspace.cfg** nas linhas:
 <code> webui.browse.link.1 = author:dc.contributor.* </code>
@@ Linha 128: / Linha 154: @@
 Para verificar as modificações o serviço do Tomcat (Servidor Web) deve ser reinicializado.
 \\
-  * **Adicionar forma de navegação**
+====Adicionar forma de navegação====
 O Dspace por padrão vem com 4 formas de navegação: **data de documento, título, autor e assunto**. Para adicionar novas formas de navegação deve-se incluir novos índices. Dessa forma, deve-se adicionar no arquivo **dspace.cfg** as seguintes modificações abaixo do bloco com outros índices “**webui.browse.index.x**”:
 <code>
@@ Linha 136: / Linha 162: @@
 Assim como os filtros de busca, para que as modificações sejam aplicadas, deve-se realizar uma reindexação completa dos itens, para que os filtros consigam recuperar os itens. Sendo assim, deve-se executar dentro do diretório **[dspace-base]/bin** o seguinte comando:
 <code> ./dspace index-discovery -f </code>
-\\ *Este procedimento em repositório com muitos itens pode demorar cerca de 5-6 horas.
+\\ *Este procedimento poderá levar várias horas de execução pois dependerá da quantidade de itens armazenados no repositório.
 \\
-  * **Adicionar arquivos ao Repositório**
+====Adicionar arquivos ao Repositório====
 Assim como as páginas estáticas, o servidor permite a inclusão de documentos.  Para isso, optou-se em criar um diretório para adicionar os arquivos do ATTENA, [dspace-base]/jspui/webapps/static/files, para organizar e reunir todos os arquivos adicionados.
 \\ Para disponibilizar um arquivo .pdf, por exemplo, basta adicionar o arquivo no diretório e fazer a sua chamada no arquivo desejado:
 <code html><a href="/static/files/marcos-legais.pdf">Marcos Legais ATTENA</a></code>
-  * **Adicionar/Gerenciar arquivos do contraste**
+====Configurar Creative Commons====
-A funcionalidade de contraste compreende na modificação do estilo e cores do ATTENA para garantir a usabilidade de pessoas com baixa visão e necessidades especiais. No ATTENA, ela pode ser ativada/desativada ao clicar no ícone presente no menu superior.
-\\ Para adicionar a funcionalidade deve-se realizar um cópia do arquivo de CSS utilizado para configurar estilos presente no diretório [**dspace-base]/webapps/jspui/static/css/bootstrap**, renomear para um nome indicativo, por exemplo, **dspace-theme-contraste.css** e realizar as configurações na folha de estilo.
-\\ Para criar a funcionalidade no botão utilizou-se um script para realizar a troca da chamada do arquivo CSS e assim permitir a visualização das modificações.
-\\ Para o ATTENA foram adotadas as seguintes recomendações, de acordo com o **Modelo de Acessibilidade em Governo Eletrônico**:
-\\
-\\ - **Cor de fundo:** independente da cor utilizada, ela deve ser alterada para preto (#000000);
-\\ - **Cor de texto:** independente da cor utilizada, ela deve ser alterada para branco (#FFFFFF);
-\\ - **Links:** O modo normal do link deve ser sublinhado (para que ele se diferencie do texto normal), assim como o modo hover e o modo active. O link deve ser alterado para amarelo (#FFF333);
-\\ - **Ícones:** Todos os ícones devem ser brancos;
-\\ - **Linhas e Contornos:** As linhas e os contornos de elementos devem ser alterados para branco.
-\\
-  * **Modificar forma visual das estatísticas**
-A fim de melhorar a forma visual dos dados estatísticos do Repositório ATTENA, utilizou-se uma biblioteca JavaScript para desenhar gráficos a partir de elementos de tela em HTML5, o **ChartJS** (https://www.chartjs.org/).
-\\Diante dessa nova forma visual os dados coletados pelo Dspace possuem agora uma forma mais atrativa e de fácil interpretação. Atualmente são coletados os seguintes dados:
-\\
-\\ - Número total de visitas;
-\\ - Número total de visitas por mês;
-\\ - Ranking de visitas por países;
-\\ - Ranking de visitas por cidades.
-\\
-\\ Para realizar tal modificação deve-se incluir as configurações recomendadas pelo ChartJs e criar adaptações no arquivo  **display-statistics.jsp**.
-\\
-  * **Configurar Creative Commons**
 Para configurar o Creative Commons deve-se acessar o arquivo **item-submission.xml** no diretório **[dspace-base]/config/** e retirar os comentários no **step 6** como no trecho de código abaixo:
 <code xml>
@@ Linha 184: / Linha 187: @@
 *Após a aplicação das configurações acima recomenda-se realizar a atualização do serviço do tomcat.
 \\
-  * **Configurar o embargo simples**
+====Configurar o embargo simples====
 Para configurar apenas o embargo simples deve-se acessar o arquivo **item-submission.xml** no diretório** [dspace-base]/config/** e deixar **step 3** comentado como por padrão, assim como indicado trecho de código abaixo:
 <code xml>

suporte/attena.1562335654.txt.gz · Última modificação: 2019/07/05 14:07 por riufpe

Rede Nordeste de Repositórios Institucionais

Conteúdo

Ferramentas do site

Ferramentas do usuário

Diferenças

Conteúdo

Ferramentas do site

Ferramentas da página

Ferramentas do usuário

Diferenças