Macro de índice
A macro de índice faz a varredura dos títulos na página do Confluence para criar um índice baseado nos títulos. Isso ajuda os leitores a se encontrarem nas páginas longas, resumindo a estrutura do conteúdo e fornecendo links aos títulos.
Deseja ver a macro de índice em ação? Verifique como ela é usada para Criar páginas perspicazes de entrevistas de clientes.
Uso da macro de índice
Dica: Para acesso rápido na barra de ferramentas do editor, selecione Inserir > Índice.
Para adicionar uma macro de índice em uma página:
- In the Confluence editor, choose Insert > Other Macros
- Find and select the required macro
Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros, mentions and emojis.
To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.
Parâmetros de macro
Error rendering macro 'excerpt-include'
No link could be created for '_Details_about_macro_parameters'.
Parâmetro | Padrão | Descrição |
|---|---|---|
Estrutura de tópicos de tipo | lista |
|
Exibir numeração de seção | limpar | Selecione a caixa de seleção para aplicar a numeração da estrutura de tópicos aos títulos, por exemplo: 1.1, 1.2, 1.3. |
Estilo da lista | disco | Selecione o estilo dos pontos para cada item da lista. É possível usar qualquer estilo válido de CSS. Por exemplo:
|
Recuo do título |
| Configure o recuo para uma lista de acordo com a quantidade de CSS. Inserir |
Separador | colchetes | Esse parâmetro se aplica somente à listas planas. É possível inserir qualquer um dos valores a seguir:
|
Nível mínimo de título | 1 | Selecione o nível mais alto de título para iniciar sua lista de índice. Por exemplo: inserindo o 2 incluirá 2 níveis e títulos com letra minúscula, porém não incluirá títulos de nível 1. |
Nível máximo de título | 7 | Selecione o nível do título mais baixo para incluir. Por exemplo: inserindo o 2 incluirá 1 e 2 níveis, porém não incluirá títulos de nível 3 e abaixo. |
Incluir títulos |
| Filtrar títulos para incluir conforme critérios específicos. É possível usar caracteres curinga. Consulte a documentação Regex da Sun para obter exemplos de criação de cadeias de caracteres de expressão regular.
|
Excluir títulos |
| Filtrar títulos para incluir conforme critérios específicos. É possível usar caracteres curinga. Consulte a documentação Regex da Sun para obter exemplos de criação de cadeias de caracteres de expressão regular.
|
Imprimível | verificado | Por padrão, o índice está configurado para ser impresso. Se você limpar a caixa de seleção, o índice não ficará visível ao imprimir a página. |
Nome da classe de CSS |
| Caso você tenha estilos de índice personalizados na sua folha de estilo de CSS, use esse parâmetro para inserir o índice |
URL absoluto (absoluteURL ) | Por padrão, os links no índice são URLs alternativos apontando para a página atual. Se verificados, os links no índice estarão cheios de URLs. Essa configuração é útil quando uma página com um índice é incluída em outra e para controlar para onde os links estão direcionando o usuário. |
Exemplos
Os exemplos abaixo são baseados neste índice:
Índice filtrado
Esse exemplo filtra os títulos para incluir os que contêm "Favoritos", mas exclui títulos que terminam com "Coisas". A lista é formada por numerais romanos.
| Parâmetro | Valor |
|---|---|
| Estilo da lista | upper-roman |
| Incluir títulos | Favourite.* |
| Excluir títulos | .*Things |
O índice resultante é:
Lista plana
Esse exemplo filtra todos os títulos para apresentar uma lista plana de "desconhecidos" entre colchetes (o estilo da lista padrão).
| Parâmetro | Valor |
|---|---|
| Tipo de saída | plana |
| Nível máximo do título | 2 |
| Incluir títulos | Unknown.* |
O índice resultante é:
Exemplo de marcação do wiki
Esse exemplo é útil quando você quer adicionar uma macro fora do editor, por exemplo, como um conteúdo personalizado na barra lateral, no cabeçalho ou no rodapé de um espaço.
Nome da macro: toc
Corpo da macro: Nenhum.
Esse exemplo mostra um tipo de lista de índices.
{toc:printable=true|style=square|maxLevel=2|indent=5px|minLevel=2|class=bigpink|exclude=[1//2]|type=list|outline=true|include=.*}Esse exemplo mostra uma tabela plana de índices.
{toc:printable=true|maxLevel=2|minLevel=2|class=bigpink|exclude=[1//2]|type=flat|outline=true|separator=pipe|include=.*}Notas
- Ao usar uma macro de índice em um template, você verá um erro ao visualizar o próprio template. Porém, a macro de índice funciona nas páginas que as pessoas criam do template – os índices aparecem após a página ser salva. (Isso provavelmente acontece porque o template não é definido como uma página e a macro de índice funciona somente para páginas.)
- A macro de índice somente exibe conteúdo de página ou de publicação no blog. Não é possível usá-la para adicionar um índice de títulos em um comentário, por exemplo.
- Devido a uma pendência inconclusa na macro de índice (CONF-10619), a função do navegador de macro Atualizar não renderiza as modificações de parâmetro. Atualmente, a renderização da modificação do valor do parâmetro para a macro de índice ocorre somente após a página ser salva.
Uso da marcação do título em HTML com macro de índice
A macro de índice não suporta sozinha a marcação do título em HTML. Por isso, se você usar a macros HTML e Incluir HTML para renderizar a marcação do título em HTML em uma página do Confluence, a macro de índice não criará uma lista de conteúdo fora desses títulos.
Entretanto, ao inserir uma âncora de HTML em cada título em HTML na sua página (com base na sintaxe a seguir), a macro de índice incorporará esses títulos na sua lista de conteúdo.<h2><a name="pagename-headingname"></a>Nome do título</h2>A sintaxe para o nome da âncora é o nome da página e do título separados por hífen. Remova todos os espaços e converta todo o texto em letras minúsculas. Converta todos os sinais de pontuação em formato codificado de URL equivalente.