Warning: Can't find topic SelectTwikiWebs

TWiki Variáveis

Nomes especiais expandidos no momento da visita à página para mostrar dados ou informações do sistema

Visão Geral

TWikiVariáveis são nomes - %VARIAVEL% - que expandem dentro do conteúdo sempre que uma página é aberta. Variáveis são sustituídas pelos seus valores reais: dados armazenados, ou informações do sistema (como a data, ou o usuário atual). Existem variáveis predefinidas, e variáveis de preferência que você define. Você pode, também, definir variáveis padrões, com novos nomes e valores.

Variáveis Pré-definidas

A maioria das variáveis pré-definidas retornam valores que foram ou definidos na instalação do Twiki, ou obtidas pela informação do servidor (como o usuário atual, ou a data e a hora). Muitas das variáveis deixam você controlar como os resultados formatados aparecem.

• Dê um tempo para ler completamente todas as variáveis definidas nas preferências. Se você configurar ativamente seu site, reveja variáveis periodicamente. Elas cobrem um grande número de funções, e pode ser fácil faltar a variável perfeita para algo que você tem em mente. Por exemplo, veja %INCLUDINGTOPIC%, %INCLUDE%, e o poderoso %SEARCH%.

Essa versão do TWiki - Fri, 31 Mar 2006 build 9626 - expande as seguintes variáveis (envolvidas em % sinais de percentagem):

Variable:	Expanded to:
%WIKIHOMEURL%	A URL base do script do TWiki, é o link do ícone Home no canto superior esquerdo, é /bin/view
%SCRIPTURL%	A URL do script do TWiki, é http://aulas.edugraf.ufsc.br/bin
%SCRIPTURLPATH%	O caminho da URL do script do TWiki, é /bin
%SCRIPTSUFFIX%	O sufixo do script, ex: .pl, .cgi é
%PUBURL%	A URL pública do TWiki, é http://aulas.edugraf.ufsc.br/pub Exemplo: Você pode referir a um arquivo anexado a outro tópico como %PUBURL%/%WEB%/OtherTopic/image.gif
%PUBURLPATH%	O caminho da URL pública do TWiki, é /pub
%ATTACHURL%	A URL de anexos do tópico atual, é http://aulas.edugraf.ufsc.br/pub/Portugues/TWikiVariables Exemplo: Caso você anexe um arquivo você pode se referir a ele como %ATTACHURL%/image.gif
%ATTACHURLPATH%	O caminho da URL de anexos do tópico atual, é /pub/Portugues/TWikiVariables
%URLPARAM{"name"}%	Retorna o valor de um parâmetro de URL. Ex: %URLPARAM{"skin"}% retorna print para um .../view/Portugues/TWikiVariables?skin=print URL. O valor é:
%WIKITOOLNAME%	O nome da ferramenta wiki, é TWiki
%WIKIVERSION%	A versão da ferramenta Wiki é Fri, 31 Mar 2006 build 9626
%USERNAME%	Seu login de usuário é guest
%WIKINAME%	Seu nome de usuário Wiki. O mesmo que %USERNAME% caso não for definido no tópico TWikiUsers. É TWikiGuest
%WIKIUSERNAME%	Seu %WIKINAME% incluindo o nome da web Main - sempre use assinaturas completas. Seu valor é: Main.TWikiGuest
%MAINWEB%	A web principal contendo TWikiUsers, OfficeLocations e TWikiGroups. É Main
%TWIKIWEB%	A web contendo toda a documentação e configuração do TWiki é TWiki
%WEB%	A web atual é Portugues
%BASEWEB%	O nome da web onde os includes foram inicializados, e.g. a web do primeiro tópico dos includes aninhados. Da mesma forma que %WEB% no caso de não haver include.
%INCLUDINGWEB%	O nome da web do tópico que inclui o tópico atual. Assim como %WEB% no caso de não haver include.
%HOMETOPIC%	O tópico home em cada web. É WebHome
%NOTIFYTOPIC%	O tópico de notificação em cada web. É WebNotify
%WIKIUSERSTOPIC%	O tópico index de todos usuários registrados. É TWikiUsers
%WIKIPREFSTOPIC%	A web do tópico de preferências. É TWikiPreferences
%WEBPREFSTOPIC%	O tópico de preferências da web. É WebPreferences
%STATISTICSTOPIC%	O tópico de estatísticas da web. É WebStatistics
%TOPIC%	O nome do tópico atual, é TWikiVariables
%BASETOPIC%	O nome do tópico onde os includes são inicializados, ex. o primeiro tópico de includes aninhados. Do mesmo jeito que %TOPIC% no caso de não haver include.
%INCLUDINGTOPIC%	O nome do tópico que inclui o tópico atual. Da mesma forma que %TOPIC% no caso de não haver include.
%SPACEDTOPIC%	O nome do tópico atual com espaços adicionados, para pesquisa da expressão regular de Ref-By, é TWiki%20*Variables
%TOPICLIST{"format"}%	Tópico de índice da web. O "format" define o formato de um item do tópico. Ele pode incluir variáveis: A variável $name contém o nome do tópico; a variável $web contém o nome da web. Os parâmetros são: formato, separador e web: Parâmetro: Descrição: Padrão: "formato" Formato de uma linha, pode incluir as variáveis $name e $web "$name" format="formato" (Alternativo ao de cima) "$name" separator=", " linha de separação "\n" (nova linha) web="Name" Nome da web Web atual Examples: %TOPICLIST{"   * $web.$name"}% criar uma lista de bolotas de todos os tópicos. %TOPICLIST{separator=", "}% cria uma lista de todos os tópicos separada por vírgula. %TOPICLIST{" <option>$name</option>"}% cria uma lista de opções (para menus drop down).
%WEBLIST{"format"}%	Web index, ex. lista de todas web's. Webs ocultas são excluídas ,ex. webs com uma variável de preferência NOSEARCHALL=on. O "format" define o formato de um item de web. A variável $name contém o nome da web, $qname contém o nome da web entre aspas duplas, $marker contém o marker onde a web condiz com selection. Os parâmetros são: formato, separador e web: Parâmetro: Descrição: Padrão: "formato" Formato de uma linha, pode incluir a variável=$name= "$name" format="formato" (Alternativo ao de cima) "$name" separator=", " separador de linha "\n" (nova linha) webs="public" Lista de web's separada por vírgulas, public contém todas as não ocultas "public" marker="selected" Texto para $marker onde o item condiz com selection, de outro modo é igual a "" "selected" selection="%WEB%" Valor atual a ser selecionado na lista section="%WEB%" Examples: %WEBLIST{"   * [[$name.WebHome]]"}% cria uma lista de bolotas de todas webs. %WEBLIST{"$name" webs="Trash,public" selection="Portugues" separator=" "}% Caixa de seleção (Dropdown) de todas Webs públicas + Trash Web, Web atual selecionada.
%GMTIME%	A hora GM, é 21 Nov 2009 - 10:16
%GMTIME{"format"}%	A hora GM é formatada baseada nas variáveis de tempo. Variável: Unidade: Exemplo $seconds segundos 59 $minutes minutos 59 $hours horas 23 $day dia do mês 31 $month mês no formato ISO Dec $mo mês com 2 dígitos 12 $year ano com 4 dígitos 1999 $ye ano com 2 dígitos 99 As variáveis podem ser abreviadas a 3 caracteres. Exemplo: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% é 21 Nov, 2009 - 10:16:24
%SERVERTIME%	Hora do Servidor, é 21 Nov 2009 - 08:16
%SERVERTIME{"format"}%	Hora do Servidor formatada. Exemplo: %SERVERTIME{"$hou:$min"}% é 08:16
%HTTP_HOST%	A variável de ambiente HTTP_HOST, é aulas.edugraf.ufsc.br
%REMOTE_ADDR%	A variável de ambiente REMOTE_ADDR, é 38.107.191.95
%REMOTE_PORT%	A variável de ambiente REMOTE_PORT, é 43367
%REMOTE_USER%	A variável de ambiente REMOTE_USER, é
%INCLUDE{"page" ...}%	Inclusão, no lado do servidor para Inclua tópicos e páginas web: Parâmetro: Descrição: Padrão: "AlgumTopico" O nome de um tópico localizado na web atual, i.e. %INCLUDE{"WebNotify"}%   "Web.Topico" Um tópico em outra web, i.e. %INCLUDE{"TWiki.SiteMap"}%   "http://..." Uma URL absoluta, i.e. %INCLUDE{"http://twiki.org/"}%   pattern="..." Um padrão em expressão regular para incluir parte de um tópico ou página none rev="1.2" Inclui uma versão anterior do tópico; N/A para URLs última versão
%STARTINCLUDE%	Se presente em um tópico incluído, inicia a inclusão do texto daquele ponto até o fim, ou até o ponto da variável %STOPINCLUDE%. Uma visão normal do tópico mostra tudo, exceto a própria variável %STARTINCLUDE%.
%STOPINCLUDE%	Se presente em um tópico incluído, para a inclusão do texto naquele ponto e ignora o resto do texto. Uma visão normal do tópico mostra tudo, exceto a própria variável %STOPINCLUDE%.
%TOC%	Tabela de conteúdo do tópico atual. (TOC é acrônimo de Table of Contents)
%TOC{"SomeTopic" ...}%	Tabela de conteúdo. Mostra um TOC gerado automaticamente baseado nos cabeçalhos de um tópico. Cabeçalhos em Sintaxe Wiki ("---++ texto") e HTML ("<h2>texto<h2>") são examinados no cliente. (mas não "<H2>texto</H2>", que pode ser usado para excluir um cabeçalho do TOC.) Os parâmetros são: nome do tópico, web e profundidade: Parâmetro: Descrição: Padrão: "NomeDoTopico" nome do tópico tópico atual web="Nome" nome da web web atual depth="2" Profundidade limite de cabeçalhos mostrados no TOC 6 Exemplos: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
%SEARCH{"text" ...}%	Busca em linha, mostra o resultado de uma busca "encaixado" em um tópico. Os parâmetros são: o termo da busca, web, escopo, ordem e muitos outros: [1] Parâmetro: Descrição: Padrão: "texto" O termo de busca. É uma expressão regular ou é literal, dependendo do parâmetro regex. para expressões regulares é usado ";" para representar and e.g. "search;agrep" encontrará todos os tópicos que contenham search e agrep. requerido search="texto" (alternativa ao anterior) N/A web="Nome" web="Main Know" web="all" Wiki web para a busca: Uma web, uma lista de webs separada por espaços, ou all (todas) as webs. [2] web atual scope="topic" scope="text" Busca pelo nome do tópico (título) ou no texto (corpo/conteúdo) do tópico texto do tópico order="topic" order="modified" order="editby" order="formfield(nome)" Ordena o resultado da busca pelo nome do tópico, última modificação, último editor, ou um campo nome de um TWikiForms nome do tópico limit="all" limit="16" Limita o número de resultados retornados Todos (all) regex="on" Busca com expressão regular; também permite ";" como and busca literal reverse="on" Inverte o sentido da busca busca ascendente casesensitive="on" busca sensível ao estado (maiúscula ou minúscula) ignorar estado nosummary="on" Mostrar somente o título do tópico mostrar o resumo bookview="on" Busca BookView, e.g. mostra o texto completo do tópico mostrar o resumo nosearch="on" Suprimir a linha de busca mostrar busca noheader="on" Suprimir cabeçalho de busca Topics: Changed: By: mostrar cabeçalho nototal="on" não mostrar o número de tópicos encontrados mostrar total header="..." format="..." Formatação customizada do resultado: veja busca formatada para uso, variáveis e exemplos resultados em tabela Exemplo comum: %SEARCH{"wiki" web="Main" scope="topic"}% Exemplo formatado: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (mostra o resultado em uma tabela com cabeçalho - detalhes...) Se o TWiki:Plugins.TablePlugin está instalado, você poderá definir uma variável %TABLE{}% logo antes do %SEARCH{}% para alterar a saída da busca. Exemplo: %TABLE{ tablewidth="90%" }%
%METASEARCH{...}%	Busca especial de meta dados Parâmetro: Descrição: Padrão: type="topicmoved" Que propriedade da busca é requisitada? "topicmoved" se a busca é por um tópico que pode ter sido movido "parent" se a busca é por um tópico que tenha um pai específico i.e. O filho deste. required web="%WEB%" A Wiki web da busca: Uma web, uma lista de webs separada por espaço, ou all (todas) as webs. required topic="%TOPIC%" o tópico ao qual a busca se relaciona required title="Titulo" o texto que é colocado antes de cada resultado da busca required Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="Esse tópico existe e foi movido para: "}%, você pode precisar usar isso em WebTopicViewTemplate e WebTopicNonWikiTemplate %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Filhos: "}%
%VAR{"NOME" web="Web"}%	Pega um valor de preferência de uma web diferente da atual. Exemplo: Para pegar %WEBBGCOLOR% da web Main escreva %VAR{"WEBBGCOLOR" web="Main"}%, é #FFEFA6

[1] Nota: O formulário da busca usa nomes idênticos para campos da entrada.

[2] Nota: Uma web pode ser excluida de uma busca web="all" (todas as webs) se você definir uma variável NOSEARCHALL=on no seu WebPreferences.

Variáveis de Preferências

Variáveis adicionais são definidas no tópico de preferências ( nível-do-site ( SL ) em TWikiPreferences, nível-da-web ( WL ) em WebPreferences de cada web e as preferências do nível-do-usuário ( UL ) no tópico individual do usuário )

Variáveis adicionais são definidas em preferências ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences de cada web, e preferências em nível de usuário ( UL ) em tópicos de usuários individuais):

Nota: Existem várias outras variáveis úteis definidas em TWikiPreferences como %BR% para quebra de linha, cores como %RED% para texto colorido e pequenos ícones como %H% para um ícone de ajuda.

Ajustando Preferências

• A sintaxe para as variáveis de preferência é a mesma em qualquer lugar do TWiki. No modo de edição, no início de uma nova linha:
  [6 espaços] * [espaço] Set [espaço] NOMEDAVARIAVEL [espaço] = [valor]
  Exemplo:
  • Set NOMEDAVARIAVEL = valor

Criando Variáveis sob Encomenda

• Você pode adicionar as suas próprias variáveis preferenciais para um site completo, uma Web, ou um único tópico, usando a sintaxe padrão. O que quer que você coloque na sua variável será substituído na tela e tratado exatamente como se tivesse sido escrito. Deste modo, você pode colocar textos formatados, links para páginas, caminhos para imagens.

Exemplo: Criando uma variável de logotipo personalizado

• Para colocar um logotipo em qualquer lugar de uma web escrevendo %MEULOGO%, simplesmente defina a variável na página de preferências da web da web em questão. Você deve enviar logo.gif - isso pode ser feito anexando um arquivo à um TopicoLogico (qualquer tópico a sua escolha):
  • Set MEULOGO = %PUBURL%/%MAINWEB%/TopicoLogico/logo.gif

-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 30 Nov 2001