Você está aqui: Página Inicial › Cheatsheets

Cheatsheets

Guias de referência rápida para o Plone, em português.

Justificativa

A maior parte do trabalho de desenvolvimento para Plone possui execução relativamente simples. Existe, porém, um alto grau de complexidade devido à grande quantidade de partes que compõem o sistema:

  • tipos de conteúdo
  • formulários
  • geradores de código
  • buildout
  • utilitários variados

Além, claro, de combinar dois frameworks com conceitos parecidos, mas pouco código em comum: Zope 2 e Zope 3.

Proposta

  • Objetivo: Produzir guias de referência rápida para o Plone.
  • Formatos: Cada cheatsheet contemplará, para determinado grupo de conhecimentos sobre o Plone, um dos seguintes formatos:
    • API/Comandos básicos
    • Definições de conceitos e/ou links
    • Checklists
    • Receitas comuns
    • Exemplos de código
  • Contexto de uso:
    • Licenciadas livremente, serviriam como aceleradores de aprendizado, podendo ser usadas em cursos e oficinas de Plone.
  • Ideias para o futuro:
    • Tradução para o idioma inglês pode alavancar a relevância e o alcance do projeto.

Materiais já existentes

A SixFeetUp, consultoria especializada em Plone, distribui cheatsheets focadas em Plone licenciadas livremente: http://www.sixfeetup.com/quickref. Isso permite sua tradução desde que mantidas fonte e licença. Alguns exemplos:

Referências de design
jquery-cheatsheet.gif rails-cheatsheet.gif

Ao contrário dos exemplos acima, a maioria das cheatsheets para software não possui grande apelo visual. Muitas são úteis, poucas são bem diagramadas. Confira uma coleção de cheatsheets mais ou menos famosas: vim, git etc.

Precisamos de um projeto gráfico que contemple mais de um tipo de cheatsheets, conforme os formatos de conteúdo apresentados no item anterior. Visualmente queremos algo didático e descontraído, inspirado em revistas de games ao ensinar sequências de comandos, golpes especiais etc. Cheatsheets sobre tópicos semelhantes poderiam ser aproximados por cor.

TODO: Sprint Cheatsheets[+] : coletar referências a partir de publicações da área de games ou outros materiais visualmente destacados.

 

Tópicos

Clique em uma cheatsheet para editar seu conteúdo. A  Cheatsheet Archetypes[+] apresenta uma sugestão inicial de modelo. Veja também a nova  Cheatsheet Archetypes Avancado[+] :

  • Cheatsheet Virtualenv[+]
  • Cheatsheet Buildout[+]
  • Cheatsheet Screen
  • Cheatsheet GenericSetup[+]
  • Cheatsheet ZMI[+] : tools, objetos de conteúdo, find, undo, security
  • Cheatsheet ZPT[+] : TAL e METAL
  • Cheatsheet Catalogo[+] : índices e metadados
  • Cheatsheet Archetypes[+] : fields & widgets
  • Cheatsheet Archetypes Avancado[+] : modificando comportamentos
  • Cheatsheet ZCA[+] : ZCML, componentes principais e seus registros
  • Cheatsheet Browser Views[+] :  conceito e registro (contextos, layers e personalização)
  • Cheatsheet Viewlets[+] :  registro, personalização, atribuição
  • Cheatsheet Portlets[+] : registro, personalização,  atribuição
  • Cheatsheet Paster[+] : gerador de código multi-funcional
  • Cheatsheet Formularios[+] : zope.formlib e z3c.form
  • Cheatsheet Workflow[+] : estados, transições, eventos
  • Cheatsheet Seguranca[+] : permissões e condições para publicação e acesso
  • Cheatsheet ACL[+] : API, métodos
  • Cheatsheet Membership[+] : API, métodos
  • Cheatsheet Quickinstaller[+] : API, métodos
  • Cheatsheet Diazo : namespaces, regras, condições, seletores CSS3 e XPath
  • Cheatsheet ZODB[+] : transações, rollback, packing

    •  

    Próximos Passos

    1. Sprint Cheatsheets[+]
      Objetivos: Definição de cheatsheet-piloto e elencação de prioridades.
      Etapas:
      - Produção de conteúdo para cada cheatsheet
      - Ilustração e diagramação
      - Revisão final
      - Publicação: lançamento e licenças
    2. ???