PHP Coupé

VISÃO GERAL

A função do módulo News é buscar dentro de sua pasta Contents os documentos de notícias e exibi-los em uma área de seu site. As notícias podem ser exibidas na íntegra (como em um blog) ou apenas um preview do conteúdo das mesmas.

- "Mas como o módulo sabe quais são os documento à serem exibidos como notícias?"

Para isso existe um parâmetro chamado parent. Através dele você indica qual conteúdo é o pai de seus documentos de notícias, e assim ele buscará por seus filhos e usará esses conteúdos como se fossem notícias.

Para controlar o formato HTML de tudo que o script do Módulo retorna, resolvi abstrair essa parte colocando tudo que é HTML dentro de um Bloco de Conteúdo que é chamado pelo Módulo. Assim, se quiser alterar o formato HTML dos resultados desse módulo, edite o Bloco de Conteúdo news_preview que acompanha o download do Módulo.

Você observará que dentro do bloco existe algumas palavras-chave que indicam ao Módulo onde inserir, no meio do HTML, os dados que ele gera dinâmicamente. A lista completa das palavras-chave, e a função de cada uma é:

• %title% - Título da notícia
• %date% - Data de criação/alteração do arquivo da notícia
• %link% - Link para o documento da notícia
• %title% - Exibe no local da marcação o título do documento
• %preview% - Exibe o texto ou preview da notícia
• %more% - Somente se a notícia tiver o BREAK, exibe "Leia mais"
• %category% - Categorias em que a notícia está

Os documentos podem ser organizados em categorias de forma hierárquica. Para isso, basta criá-los como netos do documento que agrupa suas noticias e como filhos da categoria escolhida. Por exemplo: Ao invés de criar o documento noticia.minha_noticia.cnt.php, crie o documento como noticia.tecnologia.minha_noticia.cnt.php. Somente isso é suficiente para que o Módulo entenda que sua notícia está categorizada em "Tecnologia". Se criar o documento como noticia.tecnologia.robotica.minha_noticia.cnt.php o documento será categorizado como "Tecnologia" e "Robotica".

Por último, e não menos importante, vale dizer que os previews das notícias podem ser quebrados, ou melhor, resumidos e exibir apenas até certo trecho da notícia. Para isso, basta inserir o comentário HTML <!--preview_break--> no código fonte do HTML da notícia, exatamente onde quer que o texto seja interrompido. Dessa forma, o usuário poderá ler a notícia completa clicando no link "Leia mais", gerado pela já dita marcação {%more%}.

Se quiser exibir um trecho da notícia no preview, use <!--preview_break--> para definir até onde será exibido, e <!--preview_start--> para informar de onde começará a exibição da notícia no preview.

MODOS DE EXECUÇÃO (MODES)

Esse módulo não possui modos de execução.

PARÂMENTROS

• parent - pai dos documentos que são notícias
• max - quantidade máxima de notícias a ser exibida
• orderby - ordenar notícas por data ou título?
• date_format - formato da data (em formato PHP para datas)
• news_preview - customiza a exibição das notícias
• paginate - quer que as notícias sejam paginadas? (recebe 'paginate' ou 'navigate')

EXEMPLOS DE USO

[[news]] - Exibe no local da marcação o conteúdo dos documentos filhos do documento news. Se a notícia possuir em seu codigo HTML o comentário <!--preview_break-->, o conteúdo do documento será exibido apenas até esse ponto, funcionando assim como um preview de notícias. Se ele tiver também o comentário <!--preview_start-->, o preview da notícia será tudo que estiver entre as duas marcações.

[[news?parent=noticias]] - Exibe no local o conteúdo dos documentos filhos do documento chamado noticias.

[[news?parent=noticias&orderby=title]] - Exibe no local da marcação a lista de documentos filhos do documento notícias, ordenado pelo título ao invés da data de alteração do arquivo de Conteúdo. Se não for definido, o padrão é sempre ordenar por data de alteração.

[[news?parent=noticias&date_format=d/m/Y]] - Exibe a data de criação (ou útlima alteração) do documento no formato escolhido. O formato segue o padrão de datas do PHP. Se um formato não for indicado d/m/Y H:i:s assume como formato padrão.

[[news?parent=noticias&max=5]] - Usando o parâmetro max indicamos quantas notícias devem ser listadas. Se o parâmetro não for informado, sempre será exibidas as últimas 3 notícias.

[[news?parent=noticias&news_preview=<p><a href="{%link%}">{%title%}</a></p>]] - O parâmentro news_preview permite configurar o formato HTML da exibição do preview. Se a propriedade não for definida, o módulo tentará usar o HTML definido dentro do Bloco de Conteúdo [#news_preview#]. Se o módulo não achar um Bloco de Conteúdo com esse nome, usará um formato HTML definido dentro do seu próprio código. Deve-se utilizar palavras coringas para exibir as respectivas propriedades de cada notícia. Veja a lista completa de coringa na Visão Geral.

[[news?max=4&paginate=paginate]] - Setando o parâmentro paginate para paginate ou navigate habilitamos a paginação das notícias. Dessa forma, aonde for encontrada a marcação [%news_paginate%] no layout do seu site, será exibido o menu que permitirá navegar entre as notícias. Caso o valor dado para paginatefor navigate será gerado um menu de navegação do tipo "Anteriror e Próximo". Se for definido como paginate será gerada uma paginação numérica. Importante observar que se o parâmentro paginate não for passado, mesmo que o usuário tente paginar passando o parâmentro via GET, ele não irá conseguir ver as notícias anteriores.