hipertocp - online na nuvem

PROGRAMA:

NOME

hipertoc - gera um índice para documentos HTML

VERSÃO

versão 3.20

SINOPSE

hipertoc --ajuda | --manpage | --man_help | --cara

hipertoc [--bak corda ] [--debug] [--entrysep corda ] [--footer lima ] [--header
lima ] [--ignore_only_one] [--ignore_sole_first] [--inline] [--make_anchors] [
--make_toc] [--notoc_match corda ] [--ol | --nool] [--ol_num_levels] [--outfile
lima ] [--overwrite] [--quiet] [--textonly] [--title corda ] {--toc_after
tag = sufixo } {--toc_before tag = prefix } {--toc_end tag = endtag } {--toc_entry tag = level
} [--toc_label corda ] [--toc_only | --notoc_only] [--toc_tag corda ] [
--toc_tag_replace] [--use_id] [--useorg] arquivo ...

DESCRIÇÃO

hipertoc permite que você especifique "elementos significativos" que terão um hiperlink em um
"Índice" (ToC) para um determinado conjunto de documentos HTML.

Basicamente, o ToC gerado é uma lista de vários níveis contendo links para o
elementos significativos. hipertoc insere os links no ToC para elementos significativos em um
nível especificado pelo usuário.

Exemplo:

Se os H1s forem especificados como nível 1, eles aparecerão na lista de primeiro nível do ToC. Se
H2s são especificados como um nível 2, então eles aparecem em uma lista de segundo nível no ToC.

Existem dois aspectos para a geração de ToC: (1) colocar âncoras adequadas no HTML
documentos (--make_anchors), e (2) gerar o ToC a partir de documentos HTML que têm
âncoras neles para o ToC se conectar (--make_toc). Pode-se escolher fazer um ou ambos
estes.

hipertoc também suporta a capacidade de incorporar o ToC no próprio documento HTML
por meio da opção --inline.

Para que o hypertoc suporte a ligação a elementos significativos, o hypertoc insere âncoras
nos elementos significativos. Pode-se usar o hypertoc como um filtro, gerando o resultado para
outro arquivo, ou pode-se sobrescrever o arquivo original, com o original feito backup com um
sufixo (padrão: "org") anexado ao nome do arquivo.

Também é possível definir opções em um arquivo de configuração, bem como na linha de comando.

OPÇÕES

As opções podem começar com "-" ou "-"; opções booleanas podem ser negadas precedendo-as com
"não"; opções com valores de hash ou array podem ser adicionadas, dando a opção novamente para
cada valor.

Consulte Getopt :: Long para obter mais informações.

--argfile nome do arquivo
O nome de um arquivo do qual ler mais opções. Isso pode ser usado mais de uma vez. Para
exemplo:

--argfile seu.args --argfile meu.args

Consulte "Arquivos de opções" para obter mais informações.

--bak
--bak corda

Se o (s) arquivo (s) de entrada está / estão sendo sobrescritos (--overwrite está ativado), copie o
arquivo original para "nome do arquivo.corda". Se o valor estiver vazio, não há arquivo de backup
escrito. (padrão: org)

--depurar
Ative a saída de depuração detalhada. Usado para depurar este módulo; em outras palavras,
não se preocupe. (padrão: desligado)

--entrysep
--entrysep corda

Cadeia de separação para não entradas de itens (padrão: ",")

--rodapé
--rodapé lima

Arquivo que contém o texto do rodapé para o índice.

--cabeçalho
--cabeçalho lima

Arquivo que contém o texto do cabeçalho do índice.

--Socorro
Imprima uma breve mensagem de ajuda e saia.

--ignore_only_one
Se houver apenas um item no ToC, não faça um ToC.

--ignore_sole_first
Se o primeiro item no ToC for do nível mais alto, E é o único desse
nível, ignore-o. Isso é útil em páginas da web onde há apenas um cabeçalho H1, mas
não se sabe de antemão se haverá apenas um.

--na linha
Coloque o ToC no documento em um determinado ponto. Consulte "Inlining the ToC" para obter mais informações.

--make_anchors | --gen_anchors
Crie âncoras para o índice analítico para vincular.

--make_toc | --gen_toc
Faça um sumário com links para elementos significativos ancorados.

--man_help | --manpage | --cara
Imprima toda a documentação e saia.

--notoc_match
--notoc_match corda

Se houver certas tags individuais que você não deseja incluir na tabela de
conteúdo, mesmo que correspondam aos "elementos significativos", então se este padrão
corresponde ao conteúdo dentro da tag (não ao corpo), então essa tag não será incluída,
seja na geração de âncoras, seja na geração do ToC. (padrão: class = "notoc")

--ol | --nool
Use uma lista ordenada para entradas de índice (para uma determinada profundidade). Se --ol é
falso (ou seja, --nool é definido), então não use uma lista ordenada para entradas ToC.

(padrão: falso)

(Veja --ol_num_levels para determinar a profundidade da listagem da lista ordenada)

--ol_num_levels
O número de níveis de profundidade na lista OL irá se --ol for verdadeiro. Se definido como zero,
usará uma lista ordenada para todos os níveis. (padrão: 1)

--arquivo de saída
--arquivo de saída lima

Arquivo para gravar a saída. É aqui que a saída HTML modificada e a Tabela de
O conteúdo vai para. Se você fornecer '-' como o nome do arquivo, a saída irá para STDOUT.
(padrão: STDOUT)

- sobrescrever
Substitua o arquivo de entrada com a saída. Se estiver em vigor, --outfile é ignorado.
Usado em gerar_âncoras para criar as âncoras "no lugar" e em gerar_toc if
a opção --inline está em vigor. (padrão: desligado)

--quieto
Suprima mensagens informativas. (padrão: desligado)

--somente texto
Use apenas o conteúdo do texto em elementos significativos.

--título
--título corda

Título para a página ToC (se não estiver usando --header ou --inline ou --toc_only) (padrão: "Tabela
dos conteúdos ")

--toc_depois
--toc_depois etiqueta=sufixo

--toc_after "H2 ="

Para definir o layout de elementos significativos no ToC. o etiqueta é a tag HTML que
marca o início do elemento. o sufixo é o que deve ser anexado ao
Tabela de entrada de conteúdo gerada para essa tag. Este é um argumento hash cumulativo.
(padrão: indefinido)

--toc_antes
--toc_antes etiqueta=prefixo

--toc_before "H2 = "

Para definir o layout de elementos significativos no ToC. o etiqueta é a tag HTML
que marca o início do elemento. o prefixo é o que é necessário para ser prefixado
à entrada de índice gerada para essa tag. Este é um hash cumulativo
argumento. (padrão: indefinido)

--toc_end
--toc_end etiqueta=etiqueta final

--toc_end "H1 = / H1"

Para definir elementos significativos. o etiqueta é a tag HTML que marca o início de
o elemento. o etiqueta final a tag HTML que marca o final do elemento. Quando
correspondência no arquivo de entrada, o caso é ignorado (mas certifique-se de que todos os seus etiqueta opções
referindo-se à mesma tag são exatamente os mesmos!). Este é um argumento hash cumulativo.
(padrão: H1 = / H1 H2 = / H2)

--toc_entry
--toc_entry etiqueta=nível

--toc_entry "TITLE = 1" --toc_entry "H1 = 2"

Para definir elementos significativos. o etiqueta é a tag HTML que marca o início de
o elemento. o nível é o nível que a tag é considerada. O valor de nível
deve ser numérico e diferente de zero. Se o valor for negativo, entradas consecutivas
representado pelo elemento_significativo será separado pelo valor definido por
opção --entrysep. Este é um argumento hash cumulativo. (padrão: H1 = 1 H2 = 2)

--toc_label | --toclabel
--toc_label corda

Texto HTML que rotula o ToC. Sempre usado. (predefinição: " Índice ")

--toc_only | --notoc_only
Produza apenas o Índice, ou seja, o Índice mais o toc_label.
Se houver um --header ou --footer, eles também serão exibidos.

Se --toc_only for falso (ou seja, --notoc_only estiver definido), se não houver --header, e
--inline não for verdadeiro, então um cabeçalho de página HTML adequado será gerado e, se houver
não --footer e --inline não são verdadeiros, então um rodapé de página HTML será gerado.
(padrão: - notoc_only)

--toc_tag
--toc_tag corda

Se um ToC deve ser incluído inline, este é o padrão que é usado para corresponder à tag
onde o ToC deve ser colocado. Pode ser uma tag inicial, uma tag final ou um comentário, mas
o <deve ser deixado de fora; isto é, se você deseja que o ToC seja colocado após o CORPO
tag e, em seguida, forneça "BODY". Se você quiser uma tag de comentário especial para fazer onde o ToC deve
vá e inclua as marcas de comentário, por exemplo: "! - toc--" (padrão: BODY)

--toc_tag_replace
Em conjunto com --toc_tag, este é um sinalizador para dizer se a tag dada deve ser
substituído, ou se o ToC deve ser colocado após a tag. Isso pode ser útil se o seu
toc_tag é um comentário e você não precisa dele depois de definir o ToC.
(padrão: falso)

--use_id
Use id = "nome"para âncoras em vez denome"> âncoras. No entanto, se uma âncora
já existe para um elemento significativo, isso não fará uma identificação para aquele particular
elemento.

--useorg
Use arquivos de backup pré-existentes como fonte de entrada; ou seja, arquivos do formulário
nome do arquivo.bak (veja --bak).

ARQUIVO FORMATOS

Opções Arquivos
As opções podem ser fornecidas em arquivos, bem como na linha de comando usando o --argfile
nome do arquivo opção na linha de comando. Além disso, os arquivos ~ / .hypertocrc e ./.hypertocrc são
verificado para opções.

O formato é o seguinte: As linhas que começam com # são comentários. Linhas entre PoD
marcadores também são comentários. As linhas em branco são ignoradas. As opções em si devem ser
dada a forma como estariam na linha de comando, ou seja, o nome da opção (incluam que o
-) seguido de seu valor (se houver).

Por exemplo:

# defina o ToC para três níveis
--toc_entry H1 = 1
--toc_entry H2 = 2
--toc_entry H3 = 3

--toc_end H1 = / H1
--toc_end H2 = / H2
--toc_end H3 = / H3

Os arquivos de opções podem ser aninhados, fornecendo um --argfile nome do arquivo argumento dentro da opção
arquivo, ele irá e obter o referido arquivo também.

Consulte Getopt :: ArgvFile para obter mais informações.

DETALHES

Significativo elementos
Aqui estão alguns exemplos de definição dos elementos significativos para o seu Índice.

Exemplo of Padrão

O seguinte reflete a configuração padrão se nada for especificado explicitamente:

--toc_entry "H1 = 1" --toc_end "H1 = / H1" --toc_entry "H2 = 2" --toc_end "H2 = / H2"

Ou, se foi definido em um dos possíveis "Arquivos de Opções":

# configurações padrão
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_entry H2 = 2
--toc_end H2 = / H2

Exemplo of antes Depois

As seguintes opções fazem uso das opções antes / depois:

# Um arquivo de opções que adiciona alguma formatação
# torna as entradas ToC de nível 1
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_before H1 =
--toc_after H1 =

# torna as entradas ToC de nível 2
--toc_entry H2 = 2
--toc_end H2 = / H2
--toc_before H2 =
--toc_after H2 =

# Faça as entradas de nível 3 como estão
--toc_entry H3 = 3
--toc_end H3 = / H3

Exemplo of personalizadas final

As seguintes opções tentam indexar os termos de definição:

# Um arquivo de opções que pode funcionar para documentos do tipo Glossário
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_entry H2 = 2
--toc_end H2 = / H2

# Assume que o documento tem um DD para cada DT, caso contrário, ToC
# obterá entradas com muito texto.
--toc_entry DT = 3
--toc_end DT = DD
--toc_before DT =
--toc_after DT =

formatação que o ToC
As opções --toc_entry etc. fornecem controle sobre a aparência das entradas ToC, mas há
são outras opções que afetam a aparência final do arquivo ToC criado.

Com a opção --header, o conteúdo do arquivo fornecido será adicionado antes do
ToC gerado. Isso permite que você tenha um texto introdutório, ou qualquer outro texto, antes do
ToC.

Observação:
Se você usar a opção --header, certifique-se de que o arquivo especificado contém o HTML de abertura
tag, o elemento HEAD (contendo o elemento TITLE) e a tag BODY de abertura.
No entanto, essas tags / elementos não devem estar no arquivo de cabeçalho se as opções --inline
é usado. Consulte "Inlining the ToC" para obter informações sobre o que o arquivo de cabeçalho deve conter
para inlining o ToC.

Com a opção --toc_label, o conteúdo da string dada será prefixado antes do
ToC gerado (mas depois de qualquer texto tirado de um arquivo --header).

Com a opção --footer, o conteúdo do arquivo será anexado após o
ToC.

Observação:
Se você usar o -footer, certifique-se de incluir as tags de fechamento BODY e HTML (a menos que,
claro, você está usando a opção --inline).

Se a opção --header não for especificada, a marcação HTML inicial apropriada será
adicionado, a menos que a opção --toc_only seja especificada. Se a opção --footer não for
especificado, a marcação HTML de fechamento apropriada será adicionada, a menos que a opção --toc_only
é especificado.

Se você não quiser / precisar lidar com arquivos de cabeçalho e rodapé, então você está autorizado a
especifique o título, opção --title, do arquivo ToC; e permite que você especifique um
título, ou rótulo, para colocar antes da lista de entradas ToC, a opção --toc_label. Ambas as opções
têm valores padrão, consulte "OPÇÕES" para obter mais informações sobre cada opção.

Se você não deseja que as tags de página HTML sejam fornecidas, e deseja apenas o próprio ToC, então
especifique a opção --toc_only. Se não houver arquivos --header ou --footer, então
simplesmente exiba o conteúdo de --toc_label e do próprio ToC.

Inlining que o ToC
A capacidade de incorporar o ToC diretamente em um documento HTML é suportada por meio do
opção --inline.

O inlining será feito no primeiro arquivo da lista de arquivos processados ​​e só será
feito se aquele arquivo contiver uma tag de abertura que corresponda ao valor --toc_tag.

Se --overwrite for verdadeiro, o primeiro arquivo da lista será sobrescrito, com o
ToC gerado inserido no local apropriado. Caso contrário, uma versão modificada do primeiro
arquivo é enviado para STDOUT ou para o arquivo de saída definido pela opção --outfile.

As opções --toc_tag e --toc_tag_replace são usadas para determinar onde e como o ToC está
inserido na saída.

Exemplo 1

# este é o padrão
--toc_tag CORPO --notoc_tag_replace

Isso colocará o ToC gerado após a tag BODY do primeiro arquivo. Se o --header
opção é especificada, então o conteúdo do arquivo especificado é inserido após o BODY
marcação. Se a opção --toc_label não estiver vazia, então o texto especificado por --toc_label
opção é inserida. Em seguida, o ToC é inserido e, finalmente, se a opção --footer for
especificado, ele insere o rodapé. Então, o resto do arquivo de entrada segue como era
antes.

Exemplo 2

--toc_tag '! - toc--' --toc_tag_replace

Isso colocará o ToC gerado após o primeiro comentário do formulário , e essa
o comentário será substituído pelo ToC (na ordem
--cabeçalho
--toc_label
ToC
--footer) seguido pelo resto do arquivo de entrada.

Observação:
O arquivo de cabeçalho não deve conter a tag HTML inicial e o elemento HEAD, pois o
O arquivo HTML que está sendo processado já deve conter essas tags / elementos.

EXEMPLOS

Crie an em linha ToC para um lima
hipertoc --inline --make_anchors --overwrite --make_toc index.html

Isso criará âncoras em "index.html", criará um ToC com o título "Tabela de
Conteúdo "e coloque-o após a tag BODY de" index.html ". O arquivo index.html.org irá
contém o arquivo index.html original, sem ToC ou âncoras.

Crie a ToC lima da múltiplo arquivos
Primeiro, crie as âncoras.

hipertoc --make_anchors --overwrite index.html fred.html george.html

Em seguida, crie o ToC

hipertoc --make_toc --outfile table.html index.html fred.html george.html

Crie an em linha ToC depois de que o primeiro cabeçalho of que o primeiro lima
hipertoc --make_anchors --inline --overwrite --make_toc --toc_tag / H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Isso criará âncoras nos arquivos "index.html", "fred.html" e "george.html", crie
um ToC sem cabeçalho e coloque-o após o primeiro cabeçalho H1 em "index.html" e faça backup
os arquivos originais para "index.html.org", "fred.html.org" e "george.html.org"

Crie an em linha ToC com personalizadas elementos
hipertoc --quiet --make_anchors --bak "" --overwrite \
--make_toc --inline --toc_label "" --toc_tag '! - toc--' \
--toc_tag_substituir \
--toc_entry H2 = 1 --toc_entry H3 = 2 \
--toc_end H2 = / H2 --toc_end H3 = / H3 meuarquivo.html

Isso criará um ToC embutido sobrescrevendo o arquivo original e substituindo um
comentário, e que leva cabeçalhos H2 como nível 1 e cabeçalhos H3 como nível 2. Isso pode ser
útil onde o arquivo .html é gerado por algum outro processo, e você pode então criar
o ToC como a última etapa.

Crie a ToC com personalizadas elementos
hipertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry TITLE = 1 --toc_end TITLE = / TITLE
--toc_entry H2 = 2 --toc_entry H3 = 3 \
--toc_end H2 = / H2 --toc_end H3 = / H3 \
--make_toc --outfile index.html\
mary.html fred.html george.html

Isso cria âncoras nos elementos H2 e H3 e cria um arquivo ToC chamado index.html,
indexação no TITLE e nos elementos H2 e H3.

Crie a ToC com personalizadas elementos e opções lima
Dado um arquivo de opções denominado 'custom.opt' da seguinte forma:

# Título, H2 e H3
--toc_entry TITLE = 1
--toc_end TITLE = / TITLE
--toc_entry H2 = 2
--toc_end H2 = / H2
--toc_entry H3 = 3
--toc_end H3 = / H3

então, o exemplo anterior pode ter linhas de comando mais curtas da seguinte maneira:

hipertoc --quiet --make_anchors --bak "" --overwrite \
--argfile custom.opt --make_toc --outfile index.html mary.html fred.html george.html

NOTAS

· O hypertoc é inteligente o suficiente para detectar âncoras dentro de elementos significativos. Se a âncora
define o atributo NAME, hypertoc usa o valor. Caso contrário, adiciona seu próprio NOME
atribuir à âncora. Se --use_id for verdadeiro, ele também verifica e usa
IDs.

· O elemento TITLE é tratado especialmente se especificado como um elemento significativo. Isto é
ilegal inserir âncoras (A) em elementos TITLE. Portanto, o hypertoc vai realmente
link para o próprio nome do arquivo em vez do elemento TITLE do documento.

· Hypertoc irá ignorar um elemento significativo se não contiver nenhum espaço não em branco
personagens. Uma mensagem de aviso é gerada se tal condição existir.

· Se você tem uma sequência de elementos significativos que mudam de uma forma ligeiramente desordenada
moda, como H1 -> H3 -> H2 ou mesmo H2 -> H1, embora hipertoc lide com isso para
crie uma lista que ainda seja um bom HTML, se você estiver usando uma lista ordenada para que
profundidade, então você obterá uma numeração estranha, pois um elemento de lista extra terá sido
inserido para aninhar os elementos no nível correto.

Por exemplo (H2 -> H1 com --ol_num_levels = 1):

1.
* Meu cabeçalho H2
2. Meu cabeçalho H1

Por exemplo (H1 -> H3 -> H2 com --ol_num_levels = 0 e H3 também sendo significativo):

1. Meu cabeçalho H1
1.
1. Meu cabeçalho H3
2. Meu cabeçalho H2
2. Meu segundo cabeçalho H1

Em casos como este, pode ser melhor não usar a opção --ol.

· Se não estiver usando --overwrite ao gerar âncoras, o comando precisa ser
feito em duas passagens, a fim de fornecer os nomes de arquivo corretos (aqueles com o real
âncoras neles) para a parte de geração de ToC. Caso contrário, o ToC terá âncoras
apontando para arquivos que não os possuem.

· Ao usar --inline, deve-se tomar cuidado ao substituir - se definir o ToC para
ser incluído após uma determinada tag (como o BODY padrão), então, se alguém executar o comando
repetidamente, era possível obter vários ToCs no mesmo arquivo, um após o outro.

RESSALVAS

· A versão 3.10 (e acima) gera âncoras mais detalhadas (compatíveis com SEO) do que a anterior
versões. Assim, as âncoras geradas com versões anteriores não corresponderão à versão 3.10
âncoras.

· A versão 3.00 (e acima) do hypertoc se comporta de maneira um pouco diferente da versão 2.x do
hipertoc. Agora ele foi projetado para fazer tudo de uma só vez e deixou de funcionar
opções: a opção --infile não é mais usada (todos os nomes de arquivos são colocados no final de
o comando); a opção --toc_file não existe mais; use a opção --outfile
em vez de; a opção --tocmap não é mais suportada.

Agora, ele gera tags em minúsculas em vez de maiúsculas.

· Hypertoc não é muito eficiente (memória e velocidade), e pode ser lento para grandes
documentos.

· Agora que a geração das âncoras e do ToC é feita de uma só vez, ainda mais memória
é usado do que era o caso antes. Isso é mais notável ao processar vários
arquivos, uma vez que todos os arquivos são lidos na memória antes de processá-los.

· Marcação inválida será gerada se um elemento significativo estiver contido dentro de um
âncora. Por exemplo:

O comando FOO

será convertido para (se h1 for um elemento significativo),

O comando FOO

o que é ilegal, pois as âncoras não podem ser aninhadas.

É melhor colocar declarações de âncora dentro do elemento a ser ancorado. Para
exemplo, o seguinte é preferido:

O comando FOO

O hypertoc detectará o NOME "foo" e o utilizará.

Melhor ainda é usar IDs:

O comando FOO

· Atributos NAME sem aspas não são reconhecidos.

Use o hypertocp online usando os serviços onworks.net