/brasil.gov.tiles

Blocos de Conteúdo (Tiles) para sites do Governo Brasileiro

Primary LanguagePython

.gov.br: Blocos de Conteúdo

Conteúdo

Introdução

Este complemento provê tiles (Blocos de conteúdo) para uso em sites Plone do Governo da República Federativa do Brasil.

Estado deste complemento

O brasil.gov.tiles tem testes automatizados e, a cada alteração em seu código os testes são executados pelo serviço Travis CI.

O estado atual dos testes pode ser visto na imagem a seguir:

Instalação

Para habilitar a instalação deste produto em um ambiente que utilize o buildout:

  1. Editar o arquivo buildout.cfg (ou outro arquivo de configuração) e adicionar o pacote brasil.gov.tiles à lista de eggs da instalação:
[buildout]
...
eggs =
    brasil.gov.tiles
  1. Após alterar o arquivo de configuração é necessário executar ''bin/buildout'', que atualizará sua instalação.
  2. Reinicie o Plone
  3. Acesse o painel de controle e na opção tiles você verá os tiles providos por este pacote listados.

Atualização de 1.x a 2.x

Warning

Só atualize para a versão 2.x do complemento depois de atualizar à versão mais recente da branch 1.x. O processo de migração remove os tiles descontinuados das capas existentes.

As atualizações da versão 1.x à 2.x só são suportadas das versões mais recentes de cada branch. Antes de atualizar confira que você está efetivamente utilizando a última versão da branch 1.x e que não existem upgrade steps pendentes de serem aplicados.

Esta versão remove os tiles Banner rotativo, Carrossel de mídia, Destaque, Em destaque e Social dos layouts existentes pois eles não são utilizados no IDG v2. Esses tiles serão removidos das capas existentes.

Esta versão também remove os overrides dos tiles padrão do collective.cover e collective.nitf. Esses tiles serão migrados das capas existentes. O processo de migração atualiza o atributo alt_text nesses tiles (o atributo variacao_titulo e simplesmente ignorado por ser um recurso que também não existe mais).

Tiles do pacote

Citação

Mostra uma citação de uma matéria.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/quote.png

Foto do Dia

Mostra uma foto excepcional selecionada diariamente.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/potd.png

Galeria de fotos

Mostra uma galeria de fotos.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/photogallery.png

Navegação

Mostra um menu de navegação exibindo os conteúdos como itens de menu a partir do caminho que foi adicionado.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/navigation.png

Carrossel de vídeos

Mostra um carrossel de vídeos.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/videocarousel.png

Carrossel de grupo

Mostra um carrossel de itens com imagens.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/groupcarousel.png

Carrossel de destaques

Mostra um carrossel de imagens em destaques.

https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/highlightscarousel.png

Compartilhamento nas redes sociais

Uma funcionalidade de compartilhamento nas redes sociais pode ser habilitada em alguns tiles seguindo os seguintes critérios:

Tile NITF
Seu primeiro link aponte para um conteúdo interno.
Tile Rich Text
É necessário que adicione o estilo Box Colorido na configuração do tile (aba layout), e seu primeiro link aponte para um conteúdo interno.
https://raw.github.com/plonegovbr/brasil.gov.tiles/master/docs/tileshare.png

Desenvolvimento

Utilizamos webpack para gerenciar o conteúdo estático do tema, tomando vantagem das diversas ferramentas e plugins disponíveis para suprir nossas necessidades.

Utilizamos a receita de buildout sc.recipe.staticresources para integrar o webpack no Plone.

Ao desenvolver os temas iniciamos o watcher do webpack e trabalhamos somente na pasta "webpack" alterando os arquivos; o webpack se encarrega de processar e gerar os arquivos em seu endereço final.

Este pacote adiciona os seguintes comandos na pasta bin do buildout para processar automaticamente os recursos estáticos:

$ bin/env-brasilgovtiles

Este comando adiciona no terminal o node do buildout no PATH do sistema, dessa forma voce pode trabalhar com webpack conforme a documentação oficial.

$ bin/watch-brasilgovtiles

Este comando instrui ao Webpack para esperar por qualquer mudança nos arquivos SASS e gera a versão minificada do CSS para a aplicação.

$ bin/debug-brasilgovtiles

Este comando faz o mesmo que o comando watch, mas não minifica o CSS final. Utilizado para debugar a geração do CSS.

$ bin/build-brasilgovtiles

Este comando cria o CSS minificado, mas não espera por mudanças.

Fazendo releases com o zest.releaser

Os recursos estáticos do pacote são gerados usando o webpack e não são inclusos no VCS. Se você está fazendo release usando o zest.releaser, você precisa fazer upload manual dos arquivos no PyPI ou você vai criar uma distribuição quebrada:

  • execute longtest, como de costume
  • execute fullrelease, como de costume, respondendo "não" a pergunta "Check out the tag?" para evitar o upload ao PyPI
  • faça checkout na tag do release que você está liberando
  • execute bin/build-brasilgovtiles para criar os recursos estáticos
  • crie os arquivos da distribuição usando python setup.py sdist bdist_wheel, como de costume
  • faça o upload manual dos arquivos usando twine upload dist/*

Em caso de erro você terá que criar um novo release pois o PyPI Warehouse não permite reutilizar um nome de arquivo.