Templates

Entenda e use os Templates

Templates são blocos de código reutilizável usados pelo HyperFluxCMS para padronizar e otimizar o site e facilitar alterações no visual das páginas.

O HyperFluxCMS é baseado em "templates", modelos de código que são reutilizáveis.

Há várias vantagens de se utilizar templates:

Código reutilizável:
Por exemplo, na lista de resultados da Busca, cada resultado é mostrado em uma "caixinha" que segue um mesmo template. Ou ainda nas postagens, quem as escreve não precisa ficar se preocupando com coisas repetitivas, como colocar uma imagem de capa ou menu de navegação ou data e hora da postagem. Basta escolher um template que já tenha esses elementos e focar simplesmente no texto e conteúdo da postagem.

Padronização:
Todas as páginas baseadas em um mesmo template tem uma aparência consistente e familiar.

Fácil modificação:
Se você ou um web designer decidir mudar a aparência de um template (por exemplo, mudando a logomarca do site ou as cores), basta alterar o template e automaticamente todas as postagens baseadas nesse template serão atualizadas.

Existem dois tipos de templates: Os "top-level" e os que não são "top-level".

Os template top-level são os que podem ser usados como base para postagens. Por exemplo, a página de busca, a página inicial e páginas de conteúdo.

Os templates que não são top-level são usados como partes de páginas. Por exemplo, cada quadro que contém um resultado na página de busca, ou o quadro de "Postagens mais recentes" são templates não-top-level.

Somente usuários que tem permissão de "Alterar a aparência e configuração do site" tem acesso à listagem de templates. Se para você não aparece essa opção, o administrador do site não lhe deu essa permissão. O que é normal, já que normalmente, o recomendável é que só o administrador do site e, às vezes, algum web designer profissional, tenham acesso a essas funções.

Um template é um trecho de código que normalmente é escrito em HTML ou em HyperCode, ou uma mistura dos dois.

Além do código HTML e HyperCode, o template pode conter referências a Parâmetros informados em tempo de execução pela página que o carregou. Veja Usando Variáveis e Parâmetros.

O que estiver dentro dessas marcações será substituído, em tempo de execução, por conteúdo gerado na hora. Por exemplo, dentro de um template de Postagens Mais Recentes, a marcação @p:list é substituída por uma lista, gerada automaticamente, contendo links e texto para as publicações mais recentes do site.

Para se editar ou criar templates, é necessário um bom conhecimento em HTML ou HyperCode. Mexer neles sem ter certeza do que se está fazendo pode fazer com que o site fique com a aparência totalmente desconfigurada e difícil de consertar. Portanto, NÃO MEXA SE NÃO TIVER CERTEZA DO QUE ESTÁ FAZENDO . Deixe para web designers experientes.

Editando Templates

Se você tiver permissão de Alterar a aparência e configuração do site, você verá no menu a opção "Templates". Clique nela para ver uma lista dos templates do site.

Clicando em um dos templates, você terá acesso ao código-fonte dele e às propriedades dele.

Nome do Template:
O primeiro campo é o nome do template. Somente mude o nome dos templates que você criar. Não mude os nomes dos templates do Sistema. Fazer isso pode fazer seu site deixar de funcionar.

Tome também muito cuidado ao mudar o nome de um template. Se ele já estiver sendo usado por alguma página e tiver o nome mudado, quando essa página for acessada por um visitante, ela não carregará corretamente.

Também configure as opções do template:

• Template do Sistema: indica que o template é do sistema HyperFluxCMS e é indispensável para o sistema funcionar corretamente. Se ele for excluído ou corrompido ou tiver o nome mudado, seu site deixará de funcionar corretamente;
• Protegido contra exclusão acidental: evita que o template seja apagado acidentalmente;
• Template Top Level: indica que o template pode ser usado como quadro base para as postagens publicados.

Código do template:
Contém o código do template, em HTML, HyperCode ou uma mistura dos dois. Edite como desejar, mas lembre-se: SÓ MEXA SE TIVER CERTEZA DO QUE ESTÁ FAZENDO. Um template mal editado, nem que seja só faltando um símbolo como ">" pode fazer com que seu site fique desconfigurado, esquisito e poderá ser difícil encontrar o problema.

Depois de conferir tudo, clique em "Enviar".

Se houver algum erro, volte para consertar. Caso contrário, o template terá sido editado e estará pronto para uso. Se ele já for usado, seja ele top-level ou não, as mudanças já deverão ser refletidas automaticamente nas postagens que usam esse template.

Criando Templates

Na listagem de Templates, crie em "Criar Novo".

Escolha um nome para o novo template. O nome somente deve conter somente números, letras não acentuadas e os sinais "-" e "_".

Configure as opções do Template.

Edite o código-fonte do template.

Depois de conferir tudo, clique em "Enviar".

Se houver algum erro, volte para consertar. Caso contrário, o template terá sido editado e estará pronto para uso.

Excluindo um Template

Na listagem de Templates, clique no botão "Excluir" referente ao template que você deseja excluir.

Pode ser que o template que você deseja excluir apareça como "protegido" e não seja possível excluí-lo. Isso é intencional para prevenir a exclusão acidental de templates importantes.

Para fazer isso, você primeiro precisa EDITAR o template, desmarcar a opção "protegido contra exclusão acidental" e depois voltar à listagem de templates. Dessa vez o botão "Excluir" deverá estar disponível.

Notas importantes:

Tome MUITO cuidado ao excluir um template. Se você excluir um template que é usado em uma ou mais páginas, elas podem deixar de funcionar ou aparecer desfiguradas, com elementos fora do lugar.

Pense mil vezes antes de excluir ou renomar ou editar um template marcado como "Template do Sistema". Eles são essenciais para o funcionamento do HyperFluxCMS. Sem eles, coisas como a página de busca, o cabeçalho das páginas, a lista de postagens sugeridas e muito mais podem deixar de funcionar.

Variáveis e propriedades de templates

Se template fossem simplesmente pedaços de código fixo, seriam úteis, mas teriam sua aplicação limitada.

No HyperFluxCMS, os Templates são mais poderosos do que isso. Parte do código pode ser alterada dinamicamente com valores que variem de caso a caso.

Uma das formas de se fazer isso é utilizando Parâmetros e Variáveis no código do template.

Por exemplo, um template para o cabeçalho de uma página deve conter o nome do site. Em vez de editar o template para que ele fique igual ao valor configurado nas propriedades do site, o template pode usar a variável site.name, que será inserida automaticamente de acordo com o valor que estiver configurado no momento em que a página for acessada.

Mas além disso, um template pode conter Parâmetros de Template.

Esses propriedades são acessados pela sequência especial @p:nome-do-parametro.

Por exemplo, @p:container-class insere naquele ponto do código o valor que foi passado como "container-class" na inserção do template.

Supondo que exista um template chamado borderbox para mostrar uma caixa de texto com bordas e determinado texto, e esse template tenha o código:

Em alguma página ou outro template, pode-se incluir este template e passar o texto desejado no parâmewtro @p:text.

Isso gerará na página sendo acessada o código HTML referente ao template borderbox substituindo o @p:text por "Olá, Mundo".

Veja mais em Templates em HyperCode.

A propriedade @p:list

A propriedade @p:list é um parâmetro especial que foge à regra comum dos parâmetros templates. São usados em templates especiais que são usados para exibir uma lista de resumos de postagens, em uma página de resultado de busca, na página inicial do site ou em quadros de postagens sugeridas para o visitante.

A propriedade @p:list indica onde, em um template, deve aparecer a listagem dos itens obtidos através de uma postlist. Ele só deve ser usado em templates que são usados como templates container para uma postlist. Em outros casos não faz sentido utilizá-lo.

A propriedade @p:page.content

A propriedade @p:page.content é um parâmetro especial que foge à regra comum dos parâmetros templates. São usados em templates especiais que são "Top-level", usados para exibir uma postagem inteira.

A propriedade @p:page.content indica onde, em um template, deve aparecer o conteúdo principal da página. Ele só deve ser usado em templates que são usados como templates marcados como sendo do tipo "Top-Level".