Ferramentas do usuário

Ferramentas do site


wiki:manual

Manual de Publicação

Este artigo trata das boas práticas de publicação na FEAGRI.wiki. Estas orientações tem como objetivo manter uma uniformidade na apresentação dos artigos, mantendo assim um senso de identidade e de estética. Este artigo não tratará de questões relacionadas a conteúdo e escopo. Caso haja alguma dúvida com relação às regras que concernem ao conteúdo, favor consultar a página sobre o código de conduta. Também é importante conhecer a filosofia do trabalho cooperativo que orienta a forma de se trabalhar nos artigos da FEAGRI.wiki.

Orientações Gerais

De maneira geral, é importante se familiarizar com a sintaxe dos comandos no editor de texto, muito embora ele possua uma barra de ferramentas simplificada. A sintaxe para a maioria dos comandos do editor de texto poderá ser consultada no artigo de referência na página de sintaxe de comandos (página em português). Todo o trabalho de edição é realizado no editor de texto. Caso o usuário deseje testar alguma ferramenta específica, fazer um rascunho de artigo ou ter um espaço livre para criar, deverá criar uma página para este fim no diretório playground.

Por se tratar de uma ferramenta para trabalhos colaborativos, é importante manter a rastreabilidade das edições para que todos consigam saber o que foi editado por outros colaboradores. Desta forma, toda vez que se faz qualquer tipo de edição é importante que se reporte do que se trata a edição, de maneira a facilitar o trabalho cooperativo. Para reportar a edição, basta preencher o campo Resumo da edição, logo abaixo da área de texto com uma frase geral sobre o que foi editado. Caso a edição seja mínima (e.g. correção de ortografia e pontuação, troca de palavras, etc.), também deve-se assinalar o campo Alterações mínimas também localizado abaixo da área de texto.

Pede-se também o bom senso de consultar as páginas já publicadas, de maneira a reproduzir o estilo dos textos, mantendo assim uma uniformidade estética e estilística nos artigos. Neste manual é possível encontrar várias diretrizes e sugestões de formatação e estilo, mas sempre é importante comparar o formato com os artigos já escritos. Qualquer usuário pode alterar qualquer artigo sempre que julgar que um texto precise de revisão, seja para melhorar, incluir ou excluir conteúdo, ou seja para adequar o artigo as recomendações desse manual.

Acesso

Janela de autenticação

O acesso à FEAGRI.wiki é livre para consultas, não sendo necessária qualquer tipo de autenticação. No entanto, o acesso para edição é restrito à comunidade da FEAGRI. Para acessar o modo de edição, o usuário deve entrar no link entrar, localizado no canto superior direito da página. Uma vez na janela de autenticação é necessário realizar o login. O nome de usuário e a senha são os mesmos que os utilizados para acesso em quaisquer computadores da FEAGRI. Somente alunos, docentes e funcionários com algum vínculo com a FEAGRI poderão editar e criar páginas. Caso haja problemas no processo de autenticação, o usuário interessado deverá contactar a Seção de Informática da FEAGRI.

Editor de Textos

O editor de textos possuí uma interface bem simples. Ele não é um editor do tipo WYSIWYG, sendo que o texto digitado não assume automaticamente a formatação desejada. Embora o editor conte com uma barra de ferramentas simplificada na parte superior da área de texto, qualquer edição avançada requer conhecimento sobre as sintaxes de códigos para a criação e edição de conteúdos na página de sintaxe de comandos de texto. Os códigos dos plugins utilizados na FEAGRI.wiki sempre serão explicados nesse manual. Uma vez que a edição é realizada em texto plano, para visualizar o efeito das edições realizadas no artigo basta acionar o botão Visualizar, localizado na parte inferior da área de texto, e então será mostrada a aparência final do artigo criado e/ou editado.

Editor de textos


É importante ressaltar que o texto deverá ser salvo sempre após a inclusão de novo conteúdo ou quaisquer edições realizadas, para evitar a perda de conteúdo. Após qualquer alternância, o editor irá fechar, de maneira que o usuário deverá abrir o modo de edição novamente para carregar o editor desejado. Uma estratégia interessante para a criação de conteúdo é digitar todo o conteúdo, sem qualquer formatação, em um editor de textos comum (e.g. bloco de notas, word, etc…) e depos copiar o conteúdo para a área de textos da FEAGRI.wiki. Abaixo, seguem alguns vídeos curtos sobre edição de textos e comandos básicos (vídeos em inglês, com legenda em português disponível):

  • Vídeo de instruções básicas sobre como construir e editar o primeiro artigo:


  • Vídeo sobre como criar links:


Identidade Visual

Logotipo da FEAGRI.wiki

De maneira a reforçar a identidade visual do projeto, toda vez que se desejar mencionar este repositório nos artigos e documentos aqui publicados, deverá fazê-lo com a miniatura do logotipo contendo um link apontando para a página inicial. Basta adicionar o seguinte código no texto, no lugar de FEAGRI.wiki:

{{:feagri.wiki_txt.png?:feagri.wiki|FEAGRI.wiki}}

Sinalizadores

Caso o colaborador deseje somente assinalar incorreções ou problemas de formatação, mas julga que não está apto a realizar as alterações ou mesmo não tem tempo para realizá-las, poderá marcar o texto com os emojis FIXME ou DELETEME . A tabela abaixo mostra os sinalizadores e as finalidades deles na edição de textos.

Emoji ou SinalizadorCódigoFinalidade
FIXME
FIXME
Sinalizar incorreções ou problemas de formatação que devem ser revistas e corrigidas)
DELETEME
DELETEME
Marcar texto para deleção (caso haja incorreções ou redundâncias que devem ser removidas)
([:todo])
[(:todo)]
Assinalar trecho do texto que precisa ter uma referência como base. É necessário citar adequadamente a referência.

Carregamento de Arquivos

O carregamento (upload) prévio os arquivos de mídia para serem utilizados no artigo é fundamental para facilitar a inclusão dessas mídias. Para carregar arquivos na FEAGRI.wiki, basta o usuário ir no link Gerenciador de mídias, localizado abaixo da ferramenta de busca, situado no canto superior direito da FEAGRI.wiki. O diretório para salvar as mídias definitivas que serão utilizadas nos artigos deverá ser sempre o wiki. O diretório playground serve para armazenamento de mídias para testes, enquanto o diretório [raiz] tem o propósito de armazenar as mídias somente para as páginas principais do projeto. A animação abaixo mostra o passo-a-passo de como deve-se proceder para fazer esse carregamento de arquivos. Instruções para carregamento (upload) de arquivos Uma vez que este repositório possuí controle de versão de tudo que é carregado, sempre que houver necessidade de se carregar uma atualização do aquivo na FEAGRI.wiki deve-se utilizar o mesmo nome que a versão anterior, e sobrescrever os arquivos existentes. É importante reforçar que todos os arquivos aqui disponibilizados se tornam públicos.

É muito importante reforçar que os arquivos disponibilizados devem ser preferencialmente autorais e compartilhados pela licença creative commons atribuição-compartilha igual 4.0. Caso haja necessidade de disponibilizar arquivos de outras fontes, é fundamental que estes artigos sejam livres e abertos (copyleft), e devidamente citados conforme a licença de uso.

Imagens

Janela para carregamento e seleção de imagem a ser incluída no texto

Uma vez que os arquivos já se encontrem carregados, as imagens podem ser colocadas no texto utilizando o botão para adicionar a imagem. O botão para inserir imagens no artigo inserir imagem se encontra na barra de ferramentas do editor de textos, na parte superior da área de edição. Ao pressionar o botão, uma janela aparecerá para a seleção da imagem desejada. É importante reforçar que o carregamento de arquivos também pode ser realizado por meio dessa janela, de maneira alternativa à descrita na seção carregamento de arquivos. As diretrizes para carregamento de arquivos devem ser obedecidas, tal que o carregamento sempre ocorra no diretório wiki (exceto para testes no diretório playground). Após a seleção do arquivo a ser incluído, uma nova janela irá se abrir para definir a orientação no texto, o tamanho e se a imagem trará links. É importante testar várias vezes as diferentes configurações de tamanho e orientação, de maneira que a imagem fique bem representada no texto. Após a seleção de todas as características desejáveis para a imagem, um código irá aparecer no texto, representando a imagem, que poderá ser visualizada pressinoando o botão Visualizar, na parte inferior da área de edição de texto. A exemplo de todos os comandos, após a barra vertical | deverá ser inserido um descritivo para a imagem.

Janela de seleção para orientação, tamanho e links referente a imagem á ser inserida do artigo

A FEAGRI.wiki possuí um plugin para transformar a descrição da imagem em uma legenda e também colocar a imagem em uma moldura. Maiores detalhes poderão ser verificados na documentação do plugin imagebox. A utilização do plugin é bem simples, bastando por o código de imagem gerado entre colchetes. Como recomendações gerais, o plugin deve ser utilizado para todas as imagens estáticas, e não ser utilizado para imagens no formato GIF animado. Imagens animadas deverão ser inseridas sempre em seu tamanho original, pois tanto o redimensionamento quanto o uso do plugin imagebox faz com que a imagem fique estática). Caso seja necessário redimensionar o a imagem em GIF para um novo tamanho mais adequado, pode-se utilizar um editor on-line pare este fim, como o site I Love Img. Outra recomendação é que sempre que possível colocar a imagem com a orientação à direita. Mas cabe ao usuário editor e/ou criador de conteúdo verificar se este posicionamento atende seus objetivos, tanto de informação quanto de estética.

Documentos

Todo o documento na FEAGRI.wiki deverá estar no formato de documento portável (portable document format - pdf). O plugin instalado para a apresentação desses documentos é o pdfjs. Sempre que houver a necessidade de inserir algum documento, o link para download do mesmo documento deverá ser disponibilizado. A grande maioria dos documentos estarão em formato carta/A4 orientado como retrato (e.g. artigos científicos e documentos do Word convertidos em pdf, ou similares) ou em formato 4:3/16:9 orientado como paisagem (e.g. apresentações do PowerPoint, ou similares). Para a exibição desses documentos nas páginas, são recomendadas as seguintes sintaxes de comando:

  • Documentos orientados em retrato
{{diretório:nome do arquivo.pdf|Rótulo do arquivo}}
{{pdfjs 500px>:diretório:nome do arquivo.pdf?75|Rótulo do arquivo}}
  • Documentos orientados em paisagem
{{diretório:nome do arquivo.pdf|Rótulo do arquivo}}
{{pdfjs 400px,300px> :diretório:nome do arquivo.pdf?75|Rótulo do arquivo}}

Os arquivos já deverão estar no diretório do repositório. Para saber como fazer o upload de arquivos na FEAGRI.wiki, consulte a seção de orientação de como carregar arquivos.

Vídeos

Vídeos também podem ser exibidos nos artigos. Os vídeos podem ser internos, carregados por meio do Gerenciador de mídias, conforme descrito no tópico carregamento de arquivos. Estes vídeos podem ser adicionados ao artigo da mesma maneira que uma imagem, portanto, deve-se consultar o tópico imagens. É importante ressaltar que o plugin imagebox não funciona em vídeos. Para inserir um vídeo de origem externa, como uma plataforma de compartilhamento de vídeos (e.g. YouTube, Vimeo, etc.), deve-se acionar o botão de vídeo Botão para inserir vídeo de site de compartilhamento, e inserir a URL do vídeo a ser inserido.

Sistema de Notas e Referências

Embora os textos da wiki tenham que ser autorais e originais, é muito importante que as fontes das informações sejam adequadamente referenciadas. Para referências de páginas da própria FEAGRI.wiki, deve-se utilizar o botão para link interno botão para link interno, situado na barra de ferramentas do editor de textos. Para referências de outras wikis, deve-se utilizar os códigos para referências do tipo interwiki, conforme a sintaxe de comandos mostrada no link. Além do sistema de notas nativo, o sistema conta com o plugin refnotes para organizar as notas e referências no texto. Para apresentar as notas e referências, os artigoss poderão contar com as seguintes seções finais que sempre deverão ser apresentados na ordem abaixo:

Ver Também

A seção Ver Também se destina a postagem de material complementar, que sejam artigos da própria FEAGRI.wiki ou de qualquer outra wiki, e que não esteja relacionado diretamente as referências abordadas no texto. Os links nesta seção podem ser ou não redundantes com os links para material complementar disponíveis no corpo do artigo, no entanto todos os links deste tipo que constarem no corpo do artigo deverão ser novamente referenciados nesse tópico.

Ligações Externas

A seção de ligações externas elenca páginas da internet que já foram citadas no corpo do artigo da FEAGRI.wiki. Sempre que na elaboração de um artigo alguma informação tenha sido obtida por meio de página da internet, esta página deverá ser referenciada somente na seção Ligações Externas, não sendo adequado realizar citação no texto. A forma de citação deverá ser a seguinte:

  * [[http://site|Nome do site]] - Descrição - Visitado em Data

Exemplo:

  * [[https://www.turnitin.com/pt/blog/como-criar-comunidade-sala-aula-online|Blog
do Turn it in]] - Como criar uma comunidade em sala de aula on-line - Visitado
em 23/08/2020.

Referências

Aqui são apresentadas as referências que foram citadas ao longo do artigo. Salienta-se que caso alguma informação não estiver disponível (e.g. Referência online), ela pode ser omitida desde que não comprometa a rastreabilidade da citação. Caso exista alguma informação que necessite ser citada e não está citada por alguma razão o autor ou editor do texto deverá inserir código relativo ao sinalizador adequado, ao fim do texto que necessita de citação. Para fazer uma citação no corpo do artigo, digite o seguinte código após o texto a ser referenciado:

[(cite:>Referência)]

Caso a referência seja um artigo, deverá ter o seguinte formato:

Autores (ano). «Nome do artigo». Nome da revista Número da revista(fascículo):
página inicial-página final. [[Referência online|Nome da referência online]]

Exemplo:

[(cite:>Abegg, I.; Bastos, F.P.; Müller, F.M. (2010). «Ensino-aprendizagem
colaborativo mediado pelo Wiki do Moodle».Educar em Revista 38: 205-18.
[[http://doi.org/10.1590/S0104-40602010000300014|DOI 10.1590/S0104-40602010000300014]])]

Se a referência for um livro, deverá ter o formato conforme mostrado abaixo:

Autores (ano da edição). «Nome do livro». Editora, Edição. Número de páginas.

Exemplo:

[(cite:>Sagan, C. (2006). «O mundo assombrado pelos demônios». Companhia de Bolso,
1ª Edição. 509p.)]

Após inserir a referência no texto, não é mais necessário citá-la integralmente se houver necessidade de recorrer à mesma citação. Basta inserir o seguinte código:

[(#1)]

No qual o número é o número de ordem no qual a referência se apresenta no texto.

Para apresentar a seção referências, basta colocar o código abaixo no final do artigo:

===== Referências =====
~~REFNOTES~~

Notas

Para anotações, comentários e explicações realizadas pelo próprio autor ou pelo editor, deve-se elaborar notas. O comando para elaboração de notas está mostrado abaixo:

((Esta é uma nota.))

As notas irão aparecer ao final do texto, porém sem nenhum cabeçalho. Portanto, caso haja necessidade de utilizar as notas, deve-se criar um cabeçalho ao final do texto para localizar as notas no artigo, conhorme o código abaixo:

===== Notas =====

Notas



wiki/manual.txt · Última modificação: 03/06/2020 15:00 por 177.87.77.156