A seguir uma lista de macros frequentemente utilizadas no Foswiki. Para obter a lista completa, visite o tópico Macros da web System.

  • GMTIME -- tempo GM
    • Sintaxe: %GMTIME%
    • Expande para: 19 May 2007 - 20:30
    • Relacionados: DISPLAYTIME, GMTIME{"format"}, SERVERTIME

  • GMTIME{"format"} -- tempo GM formatado
    • Sintaxe: %GMTIME{"format"}%
    • Variáveis suportadas:
    • Exemplo: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expande para 19 May, 2007 - 20:30:33
    • Relacionados: DISPLAYTIME, GMTIME, SERVERTIME

Variável Unidade Exemplo
$seconds segundos 59
$minutes minutos 59
$hours horas 23
$day dia do mês 31
$wday dia da semana (Sun, Mon, Tue, Wed, Thu, Fri, Sat) Thu
$month mês em formato ISO Dec
$mo mês em 2 dígitos 12
$year ano em 4 dígitos 1999
$ye ano em 2 dígitos 99
$tz ambos "GMT" (se configurado no gmtime), ou "Local" (se configurado no servertime) GMT
$iso tempo no padrão ISO 2007-05-19T20:30:33Z
$rcs tempo no padrão RCS 2007/05/19 20:30:33
$http tempo no formato E-mail & http Sat, 19 May 2007 20:30:33 GMT
$epoch Números de segundos desde 00:00 de 1º de Janeiro de 1970 1184261004

  • INCLUDE{"page"} -- inclui outros tópicos ou páginas Web
    • Sintaxe: %INCLUDE{"page" ...}%
    • Relacionados: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, IncludeTopicsAndWebPages, STARTINCLUDE, STOPINCLUDE
    • Parâmetros suportados:
Parâmetro Descrição Exemplo
"SomeTopic" Nome de um tópico na web corrente %INCLUDE{"WebNotify"}%
"Web.Topic" Um tópico em outra web %INCLUDE{"System.WikiName"}%
pattern="..." Uma expressão regular para incluir um sub-conjunto de tópicos ou páginas none
rev="1.2" Inclui uma revisão anterior do tópico; N/A para URLs top revision
warn="off" Aviso de atenção se houve erro de inclusão do tópico: Falha oculta, se "off"; saída padrão, se "on"; caso contrário, a saída será um texto especificado (use $topic para o nome do tópico) %INCLUDE- WARNING% preferences setting

  • INCLUDINGTOPIC -- nome do tópico que inclui o tópico corrente
    • O nome do tópico que inclue o tópico corrente - como o %TOPIC% em caso de não existir inclusão
    • Sintaxe: %INCLUDINGTOPIC%
    • Relacionados: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC

  • INCLUDINGWEB -- web que inclui o tópico corrente
    • O nome da web do tópico que inclui o tópico corrente - como o %WEB% se não existir inclusão
    • Sintaxe: %INCLUDINGWEB%
    • Relacionados: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB

  • PUBURL -- base da URL dos anexos
    • Sintaxe: %PUBURL%
    • Expande para: http://wiki.colivre.net/pub
    • Exemplo: Você pode referenciar o arquivo anexado de outro tópico com %PUBURL%/%WEB%/OtherTopic/image.gif
    • Relacioandos: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments

  • REVINFO{"format"} -- informações sobre a revisão do tópico
    • Sintaxe: %REVINFO{"format"}%
    • Parâmetros suportados:
Parâmetro Descrição Padrão
"format" Formato das informações das revisões, veja abaixo as variáveis suportadas "r1.$rev - $date - $wikiusername"
web="..." Nome da web web corrente
topic="..." Nome do tópico tópico corrente
rev="1.5" Número da revisão Última revisão

Variáveis suportadas em format:

Variável Unidade Exemplo
$web Nome da web web corrente
$topic Nome do tópico tópico corrente
$rev Número da revisão. Prefixo r1. para ter o formato usual r1.5 5
$date Data da revisão 11 Jul 2004
$username username de login do revisor jsmith
$wikiusername WikiName com o prefixo da web Main Main.JohnSmith
  • Exemplo: %REVINFO{"$date - $wikiusername" rev="1.1"}% retorna informações sobre a primeira revisão
  • Relacionados: REVINFO

Parâmetros Descrição Padrão
"text" Termo da pesquisa. É a palavra-chave ou expressão regular, depende do tipo de parâmetro. VarSEARCH tem mais informações exigido
search="text" Alternativa (Alternativa à de cima) N/A
web="Name" web="Main, Know" web="all" Wiki web para busca: uma web, uma lista de webs separadas por vírgulas, ou todas as webs. web corrente
topic="WebPreferences" topic="*Bug" Limite de busca por tópicos: um tópico, um tópico com asterisco coringa representando um conjunto tópicos com sufixo ou prefixo semelhante, ou uma lista de tópicos separados por vírgula. Todos os tópicos da web
excludetopic="Web*" excludetopic="WebHome, WebChanges" Exclui tópicos da busca: Um tópico, um tópico com asterisco coringa representando um conjunto tópicos com sufixo ou prefixo semelhante, ou uma lista de tópicos separados por vírgulas. Nada
type="keyword" type="literal" type="regex" Faz uma busca por palavra chave como "web service" -shampoo; uma busca literal como web service; ou busca por Expressão Regular como web service;!shampoo %SEARCHVAR- DEFAULTTYPE% configuração de preferências (literal)
scope="topic" scope="text" scope="all" Busca por nome de tópico (título); texto (corpo) do tópico; ou ambos "text"
order="topic" order="created" order="modified" order="editby" order= "formfield(name)" Ordenação dos resultados da busca por nomes, datas de criação do tópico, última edição, ou nome do campo do DataForm. A ordenação é feita web por web; caso você queira ordenar dentre webs, crie uma tabela formatada e a ordene com o initsort do TablePlugin Ordenação por nome do tópico
limit="all" limit="16" Limite do número de resultados retornados. Isto é feito depois da ordenação se o tipo dessa ordenação for especificado Todos os resultados
reverse="on" Inverte a direção da busca Busca ascendente
casesensitive="on" Busca case-sensitive, ou seja, diferencia letras minúsculas e maiúsculas Ignora a diferença
nosummary="on" Mostra apenas o título do tópico Mostra o resumo do tópico
bookview="on" Busca BookView, ou seja, mostra o texto completo do tópico Mostra sumário do tópico
nosearch="on" Suprimir a string de busca Mostra a string da pesquisa
noheader="on" Suprimir cabeçalho da busca Topics: Changed: By: Mostra o cabeçalho da busca
nototal="on" Não mostrar o números de tópicos achados Mostra o número
header="..." format="..." Formato de resultados customizados: veja FormattedSearch para forma de uso, variavéis e exemplos Resultados em tabela
expandvariables="on" Expande variáveis antes de aplicar a FormattedSearch na busca. Utilizada para mostrar o texto expandido, isto é, para mostrar no resultado da SpreadSheetPlugin instanciado na fórmula Texto Puro
separator=", " Linha separadora "$n"
  • Exemplo: %SEARCH{"wiki" web="Main" scope="topic"}%
  • Exemplo com formatação: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Típico: * | *Sumário: * |" format="| $topic | $summary |"% (mostra resultados em uma tabela com cabeçalho)
  • Se o Foswiki:Extensions.TablePlugin está instalado, você pode configurar uma variável %TABLE{}% apenas antes de %SEARCH{}% para alternar a saída da pesquisa. Exemplo: %TABLE{ tablewidth="90%" }%
  • Relacionado: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch

  • [1] Nota: A busca em formulários usa nomes idênticos para as entradas dos campos.
  • [2] Nota: A web pode ser excluída de da pesquisa web="all" se você definir a variável NOSEARCHALL=on na WebPreferences.

  • STARTINCLUDE -- posição inicial do texto do tópico se incluído
    • Se presente em um tópico incluído, inicia a inclusão dessa posição até o final ou até a localização da variável %STOPINCLUDE%. A visualização normal do tópico é mostrada exceto a própria variável %STARTINCLUDE%.
    • Sintaxe: %STARTINCLUDE%
    • Relacionadas: INCLUDE, STOPINCLUDE

  • STOPINCLUDE -- posição final da texto do tópico a ser incluído
    • Se presente no tópico incluído, pára a inclusão nesta localização e ignora o restante do texto. Uma visualização normal do tópico mostra tudo exceto a própria variável %STOPINCLUDE%
    • Sintaxe: %STOPINCLUDE%
    • Relacionados: INCLUDE, STARTINCLUDE

  • TOC -- menu de conteúdos do tópico corrente
    • Sintaxe: %TOC%
    • Relacionados: TOC{"SomeTopic"}

  • TOC{"Topic"} -- menu de conteúdos
    • Sintaxe: %TOC{"SomeTopic" ...}%
    • Tabelas de conteúdos. Mostra um TOC que é gerado automaticamente baseada nos títulos do tópico. Títulos na WikiSyntax ("---++ texto") e HTML ("<h2>texto</h2>") são usados. Qualquer título com "!!" é excluído do TOC; por exemplo, escreva "---+!! texto" se você não quer listar o título no TOC.

Parâmetros suportados:
Parâmetro Descrisão Padrão
"TopicName" nome do tópico Tópico Atual
web="Name" Nome da web Web Atual
depth="2" Limite da profundidade dos cabeçalhos mostrados no TOC 6
title="Some text" Título para aparecer no topo do TOC nenhum
  • Exemplo: %TOC{depth="2"}%
  • Exemplo: %TOC{"FoswikiMacros" web="Tech" title="Contents:"}%
  • Relacionados: TOC

  • TOPIC -- nome do tópico corrente
    • Sintaxe: %TOPIC%
    • Expande to: FoswikiMacros, renderiza como FoswikiMacros
    • Relacionados: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB

  • TOPICLIST{"format"} -- tópico de índices da web
    • O "format" define o formato dos itens do tópico. Ele deve incluir as variáveis: $name expande para o nome do tópico; a variável $web expande para o nome da web.
    • Sintaxe: %TOPICLIST{"format" ...}%
    • Parâmetros suportados :
Parâmetros Descrição Padrão
"format" Formato de uma linha, deve incluir as variáveis $name e $web "$name"
format="format" (Alternativo ao de cima) "$name"
separator=", " Separador de linha "\n" (new line)
selection="TopicA, TopicB" Valor atual para ser selecionado na lista (none)
web="Name" Nome da web web atual
  • Exemplo: %TOPICLIST{"   * $web.$name"}% cria lista de itens de todos os tópicos
  • Exemplo: %TOPICLIST{separator=", "}% cria lista com todos os tópicos separados por vírgula
  • Exemplo: %TOPICLIST{" <option>$name</option>"}% cria uma lista de opções (para menus tipo drop down)
  • Relacionados: SEARCH, WEBLIST

  • SYSTEMWEB -- nome da web de documentação do Foswiki
    • web que contém toda a documentação e configurações para todo o site Foswiki
    • Sintaxe: %SYSTEMWEB%
    • Expande para: System
    • Relacionados: MAINWEB

  • USERNAME -- seu nome de usuário
    • Foswiki tem 3 formatos para nomes: USERNAME como jsmith, WIKINAME como JohnSmith e WIKIUSERNAME como Main.JohnSmith. Um usuário é denominado WikiGuest caso o mesmo não seja autenticado.
    • Sintaxe: %USERNAME%
    • Espande para: guest
    • Relacionados: REMOTE_USER, WIKINAME, WIKIUSERNAME
Topic revision: r1 - 28 Apr 2014, UnknownUser
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Wiki-Colivre? Send feedback