|
Como se cria um 'HowTo'
Início
1. Como se cria um 'HowTo'
Aqui explica como se pode criar um ficheiro 'HowTo'.
Para tal deverá incluir o ficheiro das funções a utilizar.
Início
2. Função inicial
A função htmlBody_HowToOpen inicializa a página de 'HowTo'. Ela tem quatro argumentos e não tem retorno:
- Título da janela: é o que aparece no bordo superior da janela.
Se for uma string vazia (''), usa o título de default.
- Título da página: é o título que aparece no cabeçalho da página.
- Ficheiro com o índice dos "HowTo's": é um ficheiro que tem a informação dos "HowTo's" disponibilizados
- Índice de "HowTo's": é um vector que contém a informação sobre os diferentes "HowTo's".
Início
3. Como se cria a estrutura das entradas
A informação é organizada numa estrutura. primeiro cria-se a estrutura e em seguida faz-se o seu preenchimento:
- Em primeiro lugar deve inicializar-se o vector com a função 'HowTo_IdxInfoTable_begin'
que tem dois argumentos e retorna a estrutura das entradas:
- Título do corpo: Título que aparece no top do corpo co conteúdo
- Título da tabela: Título da tabela do índice das entradas
- Em seguida faz-se, pela ordem desejada, o preenchimento do vector resultante da função anterior a função
com 'HowTo_CreateIdx' para cada uma das entradas. Esta função recebe três argumentos:
- Estrutura das entradas: Variável retornada pela função
'HowTo_IdxInfoTable_begin', chamada anteriormente;
- Posicionamento no ficheiro: Nome da posicionamento dentro da página 'html;
- Título da entrada: É o texto que aparece no índice inicial e que será ainda usado
na respectiva posição em que o seu conteúdo se encontra.
Início
4. Como se introduz uma entrada
Uma entrada é iniciada com a função 'HowTo_InfoHeader' e termina com 'HowTo_InfoFooter'. Estas função não têm retorno.
Ambas recebem como primeiro argumento a estrutura das entradas obtida no ponto anterior. Para além disso, a primeira recebe como segundo
argumento a indicação para o conteúdo da informação ficar dentro de um 'blockquote' ou não. O default é ficar dentro e, para não
ficar deverá usar-se o valor '0'.
Início
5. Classes previamente descritas e que podem ser usadas
Foram criadas algumas classes que permitem uma maior uniformização do texto, são elas:
| Classe | Significado |
|---|
| HowToLink | Link de uso geral. | | BoldTitle | Título de item num enumerado | | BoldText1 | Bold em texto | | SepLIsX | Padding-top de 'X'px, para usos diversos. 'X' pode tomar os valores 5,15,25 | | | | HowToUL1 | Características de enumerado de nível 1 | | HowToLI1 | Características 'li' para enumerado de nível 1 | | HowToUL2 | Características de enumerado de nível 2 | | HowToLI2 | Características 'li' para enumerado de nível 2 | | | | tableHowTo | Tabela genérica | | tableHowToTd | Características de 'td' | | centerTable | Para central uma tabela na página | | width20 | Define a largura a 20% | | width80 | Define a largura a 80% | A definição de default de '<b>' é '{font-size:95%;font-weight:bold;color:#00868B;}'
Início
6. Finalização da página
Para finalizar a página, existem duas funções:
- htmlBodyFooter: Recebe como argumento o texto
que se deseja imprimir no 'footer'.
- htmlBodyClose: Fecha a página
Início
7. Funções auxiliares
Concontram-se predefinidas funções que podem ser usadas para melhor uniformizar as páginas criadas.
São elas (de momento há apenas uma...):
- table_createVTR_width: Cria uma linha completa de tabela.
Recebe quatro argumentos:
- Tipo: Tipo de célula. Pode ser 'th' (título) ou 'td' (célula normal).
É o mesmo para todas as células da linha.
- Classe: Pode ser o nome da classe das células (td/th) ou
então ser um vector com o mesmo número de colunas da tabela, em que cada elemento tem o nome da respectiva classe;
- Dimensões: Vector com as dimensões de cada coluna. Deve ter o
mesmo número de elementos que o número de colunas;
- Texto: Vector com o conteúdo de cada coluna. Deve ter o
mesmo número de elementos que o número de colunas.
Exemplo: table_createVTR_width ('classe', ['20%','80%'], ['texto1','texto2']);
Início
8. Links úteis
Início
|