`
documento` `
script` Chave.exemplo = true; Chave.indice = false; `
` `
topico` `
nome`Documentação Complementar`
` `
titulo`Documentacao Complementar`
` `
descritor`apoie, apoie.org, ajuda, documentação`
` `
lead`Documentação que não foi automatizada ainda.`
` `
origem`DocumentacaoComplementar.xml`
` `
` `
topico` `
titulo`Visões de usuários `
` `
desc`
De acordo com interessado: usuário final, palestrante, conteudista, programador ....
http://apoie.org/VisaoApoie.html
http://apoie.org/VisaoApoie5.html
`
` `
` `
topico` `
titulo`Página`
` `
desc`
Uma página é um conjunto chamado pagina que  é dividida em elementos.

`
` `
` `
topico` `
titulo`Elemento`
` `
desc`
Cada elemento pode ser exibido ou ocultado.
Podem ser exibidos ou ocultados mais de um elemento ao mesmo tempo.
Um elemento pode ser exibido sozinho na página.

Exemplos:

`
` `
` `
topico` `
titulo`Conjunto`
` `
desc`
Um elemento pode ser um conjunto.
Um conjunto pode ter seus elementos exibidos ou ocultados.
Podem ser exibidos ou ocultados os elementos de mais de um conjunto ao mesmo tempo.

Exemplos:

`
` `
` `
topico` `
titulo`Apresentação`
` `
desc`
Cada página corresponde a um tópico.
Cada tópico pode ter um ou mais elementos.
Os elementos de um tópico podem ser apresentados pelos botões do painel de apresentação, no canto inferior direito da tela.
O número total de elementos e o elemento atual da aparesentação são exibidos no painel. Ex: 9/9
Os elementos de um tópico podem ser apresentados de forma automática como uma apresentação de slides.
O intervalo de tempo entre a apresentação de cada elemento pode ser configurado e é exibido em segundos.

Exemplos:

`
` `
` `
topico` `
titulo`Características do Elemento`
` `
desc` Cada elemento tem um id.
Características do elemento fazem referências ao id.
Existem duas ocasiões que o sistema trata o elemento
  • apresentar elemento (componentes da interface)
    • Antes
      • Chave.id
      • Cond.id
      • Preparar.id
    • Nível de detalhe
      • id
      • nome
      • icone
      • Dado
    • Conjunto
      • Conj.id
      • Expandir.id
    • Cinema.id
    • Estilo.id  ....
    • Acabar.id
  • elemento sofre alguma atuação (comportamento)
    que ações serão executadas
    • onmouseover: dica.id
    • onclick: hlink.id
`
` `
` `
topico` `
titulo`Documentação`
` `
desc`
A documentação da página pode ser vista em:
e                                   - documentação automática
?                                                   - documentação complementar externa
                                              -  melhora apresentador ou melhorar tópico
18.Índice de Listas de Melhorias
17.Documentação Complementar - Documentação complementar externa  (aparece no indice geral tbém)
|                                                       -Documentação interna do projeto
Dicas                                               - Visão do usaruio final e visão programador
Documentacaodesenvolvimento      - Documentação do desenvolvimento
DocumentacaoComponente            - Documentação do componente

Fluxo de uma pagina do apoie        - Diagrama de funcionamento de uma página com usuarios

A documentação do programa é automática.
A documentação exibe as características de cada elemento.
Pode ser exibida a documentação de um ou mais elementos.

Exemplos:

`
` `
` `
topico` `
titulo`Uso de dicas`
` `
desc`
  • Dica- com Chave.DicaDetalhada desligada - visão do usuário final:
    apresenta dica do elemento se houver
    senão apresenta a do genitor mais próximo com dica
  • Dica+ com Chave.DicaDetalhada ligada - visão programador:
    apresenta id e documentação do elemento - continua fazendo o que faz
  • o que o apresentador faz hoje:
    • com Chave.DicaDetalhada desligada (estado inicial):
      apresenta dica do elemento se houver
      apresenta Id se não houver dica
    • com Chave.DicaDetalhada ligada:
      apresenta dica do elemento se houver
`
` `
` `
topico` `
titulo`Camadas para configurar a página`
` `
desc`A página pode ser configurada em vários níveis:
  1. com o programa rodando
    • editar diretamente no HTML
    • exibir / apagar elementos - Índice de Tópico
    • apagar elemento nele mesmo
    •  configuração apagada  cabeçalho ligado nome ligado lead ligado corpo ligado rodapé ligado índice ligado índice de tópico ligado exposição de quadros apagado Elementos alinhaos por cima apagado exibir com fundo preto  janela de edição apagada ... painel config
    •   configuração ligada janela configuração
    • janela de edição ligadajanela para editar
  2. na carga do programa 
    1. na URL # comandos
    2. tag script no .xml
    3. no arquivo html body > onload do html....Inic(.xml);....
  3. em arquivo .js - que tem também as definições
`
` `
` `
topico` `
titulo`Uso de funções`
` `
desc`sempre tivemos a idéia que as funções fossem usadas de diversas formas:

  • o apresentador (programa) usa as funções que estão em arquivos .js
  • o conteúdo usa mesmas funções
    • no xml, onde outras funções podem ser definidas.
    • no conteúdo como no teste de Índice  no cabeçalho de apoie.org
  • a pessoa que apresenta o conteúdo (na URL e na janela "js")

Para usar alguma função é só testar se funciona de maneira adequada e melhorar se necessário.
`
` `
` `
topico` `
titulo`Quantos niveis exibir`
` `
desc`Diversas formas usadas:
  • índices gerados pelo apresentador {15} : Expandir mostra o nível abaixo
  • Chave id.doc: faz aparecer a documentação de id e seus descendentes
  • Ícone doc documentacao apagado: apresenta doc do conjunto página e seus descendentes, ou seja, documentação da página inteira
Acho que o melhor é o que fazemos nos índices.

Em uma outra fase vamos usar critério já definido de exibir do nível inicial até nível final indicados
`
` `
` `
topico` `
titulo`Unificação de critérios e sintaxe`
` `
desc`Diversas formas usadas:
  • índices gerados pelo apresentador {15} : Expandir mostra o nível abaixo
  • Chave id.doc: faz aparecer a documentação de id e seus descendentes
  • Ícone doc documentacao apagado: apresenta doc do conjunto página e seus descendentes, ou seja, documentação da página inteira
Acho que o melhor é o que fazemos nos índices.

Em uma outra fase vamos usar critério já definido de exibir do nível inicial até nível final indicados
`
` `
` `
topico` `
titulo`Arquivos do apoie.org`
` `
desc`
`
` `
` `
topico` `
titulo`Gerar vários arquivos`
` `
desc`
  1. MontarXml2.html
    1. cd diretório desejado
    2. echo ListaXml=[\'$(echo *.xml)\' ]\; | sed "s/ /', '/g" > ListaXml.js
  2. Testar pelo menos


`
` `
` `
topico` `
titulo`Testes de Funções`
` `
desc`
  1. http://pythontutor.com/visualize.html#togetherjs=9IHGz27M1a
  2. Exemplo:
    function ver (id) // retorna se um elemento deve ser exibido ou não
        {return Chave[id] === undefined || Chave[id];}
       
    var Chave = [];
    Chave.elemento = false;
    console.log(ver("elemento"))


`
` `
` `
topico` `
titulo`Fazer aparecer qq elemento em qq conjunto`
` `
desc`

  1. Exemplos:
    Incluir:
    http://apoie.org/Mutirao.html#Conj.rodape=['Logo','LinkTopico','Origem','Fonte',Referencia','GPL'];

    Ocultar
    http://www.apoie.org/Mutirao.html#atribuir(false, 'Chave', 'Logo'); ou

    http://www.apoie.org/Mutirao.html#Chave.Logo =false;


`
` `
` `
`