Projeto

Geral

Perfil

Wiki » Estrutura-wiki »

Macros

Para conhecer as macros disponíveis, use a macro {{macro_list}}.
Para garantir o funcionamento da macro é importante que sejam reservadas uma linha acima e outra abaixo da chamada, como exemplificado a seguir:

Conteúdo antes da macro

{{macro}}

Conteúdo depois da macro

Tabela de conteúdos

{{toc}} vai gerar o recurso abaixo:

É possível ainda alinhar a lista à direita usando {{>toc}} ou à esquerda usando {{<toc}}. Abaixo um exemplo do primeiro caso:

Item recolhido

Permite "esconder" um conteúdo e apresentá-lo apenas quando clicado. Essa macro usa argumentos e precisa ser escrita num formato específico, em que a abertura da macro, seu nome e seu argumento ficam em uma linha, seu conteúdo na linha seguinte, e o fechamento da macro numa linha separada:

{{collapse(gatilho)
Conteúdo escondido
}}

O código acima gera o resultado a seguir:

gatilho

Essa macro permite que seu conteúdo seja formatado com markdown como a seguir:

Gatilho

Inclusão

Permite incluir uma página específica (todo o seu conteúdo) em diferentes espaços. Para isso, utilize a estrutura {{include(Project:Name)}}:

{{include(redmine:footer)}}

A macro acima, que inclui a página Footer desse projeto, resulta no bloco a seguir:

Essa página foi acessada 18 vezes.
Em caso de dúvida, entre em contato com [email protected].

Páginas Filhas

Permite incluir os links da estrutura de páginas de uma Wiki.

{{child_pages(redmine:Wiki, parent=1, depth=2)}}

O código acima, que referência a página Wiki do projeto Redmine IPEDF Codeplan (cujo identificador é redmine) incluindo seu próprio link através do parent=1 e indo até dois níveis a partir dela própria com depth=2, resulta no seguinte:

Macros Disponíveis {{macro_list}}

hello_world
Sample macro.
macro_list
Displays a list of all available macros, including description if available.
child_pages
Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

{{child_pages}} -- can be used from a wiki page only
{{child_pages(depth=2)}} -- display 2 levels nesting only
{{child_pages(Foo)}} -- lists all children of page Foo
{{child_pages(Foo, parent=1)}} -- same as above with a link to page Foo
include
Includes a wiki page. Examples:

{{include(Foo)}}
{{include(projectname:Foo)}} -- to include a page of a specific project wiki
collapse
Inserts of collapsed block of text. Examples:

{{collapse
This is a block of text that is collapsed by default.
It can be expanded by clicking a link.
}}

{{collapse(View details...)
With custom link text.
}}
thumbnail
Displays a clickable thumbnail of an attached image.
Default size is 200 pixels. Examples:

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}} -- with custom title and size
issue
Displays an issue link including additional information. Examples:

{{issue(123)}}                              -- Issue #123: Enhance macro capabilities
{{issue(123, project=true)}}                -- Andromeda - Issue #123: Enhance macro capabilities
{{issue(123, tracker=false)}}               -- #123: Enhance macro capabilities
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123
mj
MathJax Macro:

Usage:
{{mj( single line MathJax Syntax )}}

{{mj
Multi line
MathJax Syntax
}}
mermaid
Add mermaid graphs to your wiki. Example:

{{mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
}}
comment_form
Displays a comment form.
comments
Display comments of the page.
count
Count access to the pages.

  !{{count}}
show_count
Displays an access count of the page.

  !{{show_count}}
popularity
Displays list of the popular pages.

  !{{popularity}}
  !{{popularity(max)}}
  !{{popularity(max, term)}}
div_start_tag
Displays a <pre><div id="id_name" class="class_name"></pre>

 !{{div_start_tag(id_name)}}'
 !{{div_start_tag(id_name, class_name)}}
div_end_tag
Displays a <pre></div></pre>

  !{{div_end_tag}}
fn
Create a footnote.

 {{fn(word, description)}}
fnlist
Displays footnotes of the page.
iframe
Insert an iframe tag

  !{{iframe(url, width, height)}}
lastupdated_at
Displays a date that updated the page.

 !{{lastupdated_at}}
lastupdated_by
Displays a user who updated the page.

 !{{lastupdated_by}}
new
Displays a string 'new'.

  !{{new(yyyy-mm-dd)}}
  !{{new(yyyy-mm-dd, expire)}}

Default of expire is 5.
new_page
Create new page.
page_break
Page break here.
project
Creates link to other project.

 {{project(project_name)}}
 {{project(project_identifire}}
 {{project(project_name, alias)}}
 {{project(project_identifire, alias}}
recent
Displays a list of pages that were changed recently. '

 !{{recent}}'
 !{{recent(number_of_days)}}
taggedpages
Displays pages that have specified tag.

  !{{taggedpages(tagname)}}
  !{{taggedpages(tagname, project)}}
tags
Displays tags.

  !{{tags}}
tagcloud
Displays tagcloud.

  !{{tagcloud}}
twitter
Creates link to twitter account page.

 !{{twitter(user_name)}}
vote
Vote macro.

  !{{vote(key)}}
  !{{vote(key, label)}}
show_vote
Display result of vote macro.

  !{{show_vote(key)}}
wiki
Link to wiki page of other project.

  !{{wiki(project_name, wiki_page)}}
 !{{wiki(project_name, wiki_page, alias)}}
 !{{wiki(project_identifier, wiki_page)}}
 !{{wiki(project_identifier, wiki_page, alias)}}

Essa página foi acessada 13 vezes.
Em caso de dúvida, entre em contato com [email protected].

Like0