DOCPROJECT

Tutorial

Instalação

Após fazer o download descompacte os arquivos em uma pasta de sua preferência, dentro do diretório raiz do seu webserver.

Em seguida acesse-o pelo browser, a seguinte tela irá aparecer:

Dê permissão de leitura/escrita (se necessário) nas pastas solicitadas.

Para que a configuração seja concluída edite o arquivo "config.php", e entre com os dados de acesso do seu banco de dados.

Enfim atualize seu browser, se tudo ocorrer bem todos os itens apareceram como concluídos. Remova ou altere a pasta "install", e atualize seu browser novamente.

Entendendo o Docproject

A tela inicial será carregada:

• 1. Versões da documentação
• 2. Indice da documentação
• 3. Login
• 4. Idiomas cadastrados

O Docproject suporta várias versões de uma mesma documentação, ou se preferir, várias documentações diferentes na mesma aplicação, juntamente com o suporte a vários idiomas, ambos influenciam na navegação tanto do usuário como do administrador, exemplo:

Ao clicar em "Novo tópico" o mesmo será criado para a versão e idioma corrente (se não houver nenhum selecionado, os padrões serão usados).

O mesmo serve para a área administrativa, os tópicos la carregados, estarão relacionados com a versão e o idioma correntes.

Efetue o login:

Usuário administrator Senha admin

Criando um tópico

Clique em "new topic", a tela a seguir deverá aparecer:

• Language topic Idioma corrente
• Version topic Versão corrente
• Principal topic Tópico principal é o tópico que é mostrado assim que o site é carregado (o mesmo não aprece no indice)
• Parent topic Você pode setar um tópico como filho, algo como: 1 First Topic / 1.1 Son of first topic
• Title Título(!) do tópico
• Content of topic Conteúdo(!) do tópico

Syntax Highlighter

Para inserir blocos de código utilize a seguinte sintaxe: [code linguage]Código[/code]

Lembrando que o nome da linguagem DEVE OBRIGATÓRIAMENTE estar em minúsculo.

As seguintes linguagens são suportadas:

• PHP
• JS
• CSS
• SQL
• PLAIN
• JAVA
• C#
• C
• DELPHI
• AS3
• PERL
• PYTHON
• RUBY
• VB
• XML
• XHTML
• HTML
• XSLT

Área administrativa

• 5. Deslogar
• 6. Administrativo

Clique em "admin":

• 7. Seta o posicionamento dos tópicos cadastrados
• 8. Gerencia os usuários
• 9. Seta o tema
• 10. Gerencia os idiomas e seta o padrão
• 11. Gerencia as versões e seta a padrão
• 12. Gerencia os links (atalhos)
• 13. Configura o nome e o logo

A administração é simples e intuitiva, por isto não é necessário detalhar os mesmos, mas lembre-se que o idioma e versão correntes influenciam nos tópicos exibidos tanto no site, quanto na área adminitrativo, divirta-se.