Índice de ajuda

Construir um plug-in de ajuda

Neste exemplo, assumimos que o autor da documentação já facultou a documentação em bruto sob forma de ficheiros HTML. A granularidade e a estrutura destes ficheiros compete liminarmente á equipa de documentação. Uma vez entregue a documentação, a configuração do plug-in e dos tópicos pode processar-se independentemente.

Começamos por partir do princípio de que a documentação já consta da árvore seguinte.

   html/
      concepts/
         concept1.html
         concept1_1.html
         concept1_2.html
      tasks/
         task1.html
         task2.html
         task3_1.html
         task3_2.html
      ref/
         ref1.html
         ref2.html

Partimos também do princípio de que o nome do plug-in é com.example.helpexample.

O primeiro passo é criar um directório de plug-in, com.example.helpexample debaixo do directório plugins da plataforma. A sub-árvore doc\ mostrada supra deve ser copiada para o directório.

Os plug-ins de documentação precisam de um manifesto tal como os plug-ins de código. A marcação seguinte define o plug-in de documentação.

   <?xml version="1.0" ?>
   <plugin name="Online Help Sample"
      id="com.example.helpexample"
      version="1.0"
      provider-name="oMeuExemplo" />