This is a draft cheat sheet. It is a work in progress and is not finished yet.
Features
GENÉRICA |
componente |
padrão |
exemplo |
label |
BB - [funcionalidade] |
BB - Notícias |
nome de máquina |
ft_bb_[funcionalidade] |
ft_bb_noticias |
ESPECÍFICA |
componente |
padrão |
exemplo |
label |
[projeto] - [funcionalidade] |
NECCT - Notícias |
nome de máquina |
ft_bb_[funcionalidade]_[projeto] |
ft_bb_noticias_necct |
Atenção:
- Não se embala menu já existente (ex. Menu Principal) na features, somente links de menu. A não ser que seja um novo menu (específico da feature).
Tipos de conteudo
componente |
padrão |
exemplo |
label |
[Tipo-conteudo] |
Página Básica (sempre no singular) |
nome de máquina |
[tipo-conteudo] |
pagina_basica |
Atenção:
- Sempre apagar campo body
- Desabilitar exibição de autoria (submitted)
- Fechar comentários
- Desmarcar opção "Promover à página principal"
- Caso multilingual, deixar obrigatório a seleção do idioma
- Definir pattern de url (artigos/[title]) Atenção para o plural
- Não há pattern para páginas básicas, formado pelo título na base do site (exemplo: /[title])
Fields
componente |
padrão |
exemplo |
label |
[nome-campo] |
Telefone celular |
nome de máquina |
[tipo-conteudo]_[nome-campo] |
artigo_telefone_cel |
opção de ajuda (help text) |
Sempre preencher e colocar ponto final, quando possível, colocar exemplo. |
Insira o número de telefone celular. (Ex.: (xx) xxxxx-xxxx) |
|
|
Insira as tags de notícias. Para utilizar mais de uma tag, separe-as por vírgula ",". (Ex.: esporte, política, economia) |
caminho de arquivos |
|
/artigo/arquivos/ |
|
|
/artigo/imagens/ |
|
|
/artigo/videos/ |
campos de usuários |
usuario_[nome-campo] |
usuario_nome_completo |
Atenção:
- Sempre configurar o caminho dos arquivos
- Permissões: sempre setar as permissões ao criar um novo campo
Views
componente |
padrão |
exemplo |
nome da view |
[nome-feature] |
noticias |
nome do display |
[tipo-display] - [título] |
Bloco - Próximas notícias |
|
|
Página - Próximas notícias |
classes do display |
[nome-display] [tipo-exibição*] |
proximos-cursos tabela |
Comportamento sem resultado |
Sempre preencher |
Nenhum item encontrado |
Paginação |
Sempre usar ajax |
Filtros |
Reparar na ordenação (performance) |
Contadores (header) |
Sempre que possível inserir |
Publicações (23), Número de inscritos: 34 |
Path pattern |
[nome-feature] |
noticias |
Atenção:
- Filtros expostos:
Habilitar botão Reset (texto do botão: "Redefinir")
Alterar texto do botão Apply: "Filtrar"
* Tipos de display para classes:
- Unformatted list / Order list - lista
- Table - tabela
- Slideshow - slideshow
- Grid - grade
Image Style (imagecache)
componente |
padrão |
exemplo |
label |
[nome-seção] - [info] - [dimensões] |
Home - Destaque Principal - 400x250 |
nome de máquina |
[nome-seção]_[info] |
home_destaque_principal |
Atenção:
- Fazer um imagecache para cada seção.
- Label: não adicionar px se for pixel, se for porcentagem, utilizar %
Idioma
- Habilitar idioma Português como padrão
- Mover peso |
Flags
GLOBAL |
componente |
padrão |
exemplo |
label |
[ação] (sempre no infinitivo) |
Revisar Conteúdo |
nome de máquina |
[ação] (sempre no infinitivo) |
revisar_conteudo |
ESPECÍFICA |
componente |
padrão |
exemplo |
label |
|
Trabalho - Revisar |
nome de máquina |
|
trabalho_revisar |
Atenção:
- Sempre categorizar a flag.
Contextos
componente |
padrão |
exemplo |
Tag |
[nome-feature] |
Notícias |
Descrição |
[nome-feature] - [nome-display ou nome-bloco] |
Notícias - Mais recentes |
Nome de máquina |
[nome-feature]_[nome-display ou nome-bloco] |
noticias_mais_recentes |
Atenção:
- Sempre criar um contexto para cada bloco.
Blocos
componente |
padrão |
exemplo |
nome de máquina |
[nome-feature]_[nome-bloco] |
inscricao_status |
description |
[Nome-feature] - [Nome-bloco] |
Inscrição - Status |
Panels
componente |
padrão |
exemplo |
nome |
[nome-feature]_[funcionalidade] |
Submissão - Revisão de trabalhos |
nome de máquina |
[nome-feature]_[funcionalidade] |
submissao_revisar_trabalhos |
Atenção:
- Sempre lembrar de colocar o ID geral no painel (ex. #home)
Cadastro de usuario (redirecionamento)
- Quando o usuário se cadastrar, redireciona para uma página de sucesso de cadastro.
- Quando o usuário logar, redireciona para o dashboard. |
Atenção:
user pattern: usuarios/username
Mensagens de sistema (messages)
Desabilitar mensagens padrões e exibi-las somente em caso específicos (via Rules) |
Taxonomia
componente |
padrão |
exemplo |
label |
[Nome-feature] - [Vocabulário] |
Notícias - Tags |
nome de máquina |
[nome-feature]_[vocabulário] |
noticias_tags |
path pattern |
[nome-feature]/[vocabulário]/[cat-title] |
noticias/tags/tag-1 |
Workflow de desenvolvimento
Git |
Não possui site local |
git clone url_do_git |
Possui local desatualizado |
git status |
git fetch --all |
git pull origin dev |
Banco de Dados |
Faça um backup pelo Backup and Migrate do site em Produção Importe o arquivo do banco (por comando por byte, phpmyadmin, Backup and Migrate ou drush) |
Files |
scp do site em Produção para seus /sites/default/files |
Working... |
git add [arquivos modificados] |
git commit -m "Comentário descritivo no infinitivo" |
git push origin dev (sempre enviando para a branch dev do repositório remoto) |
Comandos byte
lsft |
Para listar todas as features |
dl [nome-feature] |
Para baixar uma feature do Byte2b e instalá-la no diretório custom |
create [nome-feature] |
Para subir sua feature no Byte2b |
setp |
Para executar chown e chmod automaticamente nas pastas (execute da raiz, ex.:/var/www/site1) |
rename [nome-antigo] [nome-novo] |
Para renomear uma feature previamente criada. Ex.: byte rename ft_bb_noticias ft_bb_novidades |
backup |
Para realizar um backup com a data atual |
install [nome-site] |
Para fazer uma instalação completa com os módulos padrões |
starter [nome-site] |
Para fazer uma instalação padrão básica |
updatedb |
Pareia o banco local com o da produção, sentido produção > local |
updateme |
Para fazer update automático do comando byte |
|