Vous êtes sur la page 1sur 9

Portal do Software Pblico Brasileiro

Modelo de Manual de Instalao, Administrao e Uso do Formdin


Verso 1.02

Autor Lus Eugnio Barbosa

Local, 22 de maio e 2012

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

Sumrio
2 Licena deste Documento..................................................................................................................3 3 Arquitetura.........................................................................................................................................4 4 Instalao...........................................................................................................................................5 1 Passo-a-passo da Instalao no Sistema Operacional Windows/Linux.............................................5 5 Estrutura do Projeto...........................................................................................................................6 1 Criando Uma Aplicao Exemplo ....................................................................................................6 2 Hardware mnimo necessrio............................................................................................................8 3 Pr-requisitos.....................................................................................................................................8 6 Link da Licena Jridica Creative Commons....................................................................................8

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

1 - Licena deste Documento Para a utilizao deste documento necessrio seguir as regras da licena Creative Commons pela mesma Licena 2.5 Brasil (http://creativecommons.org/licenses/by-ncsa/2.5/br/deed.pt_BR). Voc tem a liberdade de: Compartilhar copiar, distribuir e transmitir a obra.

Remixar criar obras derivadas. Sob as seguintes condies: Atribuio Voc deve creditar a obra da forma especificada pelo autor ou licenciante (mas no de maneira que sugira que estes concedem qualquer aval a voc ou ao seu uso da obra). Compartilhamento pela mesma licena Se voc alterar, transformar ou criar em cima desta obra, voc poder distribuir a obra resultante apenas sob a mesma licena, ou sob uma licena similar presente. Ficando claro que: Renncia Qualquer das condies acima pode ser renunciada se voc obtiver permisso do titular dos direitos autorais. Domnio Pblico Onde a obra ou qualquer de seus elementos estiver em domnio pblico sob o direito aplicvel, esta condio no , de maneira alguma, afetada pela licena. Outros Direitos Os seguintes direitos no so, de maneira alguma, afetados pela licena: Limitaes e excees aos direitos autorais ou quaisquer usos livres aplicveis; Os direitos morais do autor; Direitos que outras pessoas podem ter sobre a obra ou sobre a utilizao da obra, tais como direitos de imagem ou privacidade. Aviso Para qualquer reutilizao ou distribuio, voc deve deixar claro a terceiros os termos da licena a que se encontra submetida esta obra. A melhor maneira de fazer isso com um link para esta pgina.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

2 - Arquitetura
O FormDin compe-se por um conjunto de componentes de software, que proveem uma arquitetura bsica para o desenvolvimento de aplicaes web baseadas em um menu principal, formulrios de entrada de dados e relatrios. A estrutura da aplicao utilizada pelo FormDin composta por trs classes a saber: TApplication, TForm e TPDOConnection. Elas so responsveis pela implementao do padro MVC ( Model, View e Controller). A classe TApplication (controller) a responsvel por receber as requisies e executar as aes pertinentes. A classe TForm ( view ) a responsvel pela criao dos formulrios de entrada de dados. A classe TPDOConnection (model) a responsvel em recuperar e gravar as informaes no banco de dados.

Diagrama da Arquitetura Utilizada pelo FormDin

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

3 - Instalao
Antes de iniciar, necessrio que voc tenha o PHP 5.3 ou superior rodando em seu servidor web. Caso ainda no tenha o ambiente instalado, pode ser utilizado os instaladores XAMPP (http://www.apachefriends.org/pt_br/xampp.html) ou WAMPP Server (http://www.wampserver.com/en/) que facilitam muito o trabalho de instalao do Apache + Php + Msql. Para baixar o FormDin voc deve acessar o endereo: http://www.softwarepublico.gov.br/dotlrn/clubs/formdin ou atravs do svn no seguinte endereo: http://svn.softwarepublico.gov.br/svn/formdin/

4 - Passo-a-passo da Instalao no Sistema Operacional Windows/Linux


A instalao do FormDin no requer muita burocracia, siga os seguintes passos: 1) faa o download atravs dos endereos j citados acima; 2) criar um novo diretrio para a aplicao no seu servidor web, de forma que ela fique disponvel no browser no endereo: http://localhost/minha_aplicacao/ Neste exemplo o diretrio da aplicao ser /minha_aplicacao/. 3) descompacte o arquivo zip baixado dentro do diretrio /minha_aplicacao/ 4) digite no browser o endereo: http://localhost/minha_aplicacao/base/exemplos/ Dever aparecer uma aplicao de exemplos de funcionalidades do FormDin, significando que o ambiente j est pronto e funcional.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

5 - Estrutura do Projeto
Toda aplicao criada com o FormDin, necessita do arquivo index.php e de trs diretrios/pasta obrigatrias para o funcionamento da aplicao, sendo: base/, includes/ e modulos/. O diretrio base/ onde fica o framework e seus arquivos no devem ser alterados, sob pena de em uma nova verso sobrescrever as suas alteraes. O diretrio includes/ onde dever ficar o arquivo de configurao da conexo com o banco de dados, devendo ser tambm utilizado para outros arquivos de apoio, comuns a toda a aplicao. O diretrio modulos/ onde deve ser criada toda a estrutura de formulrios da aplicao, podendo ser organizado tambm em subdiretrios. Para manter a organizao dos arquivos da aplicao, aconselhvel criar os seguintes diretrios quando necessrio: a) b) imagens/ para armazenamento das imagens; css/ para armazenamento das folhas de estilos e;

c) js/ para armazenamento de arquivos de cdigos javascripts que forem necessrios para o funcionamento e customizao da aplicao. Exemplo: /minha_aplicacao /base /includes /modulos /js /css index.php A pasta mdulos dever ser organizada contendo uma subpasta para cada mdulo e dentro desta subpasta devem ser colocados os arquivos php, css, js referentes ao mdulo e tambm uma outra subpasta chamada action/ onde devero ficar as aes solicitadas pelo usurio. Exemplo: se o nome do modulo chamar cad_pessoa.php, ento a estrutura da pasta /mdulos/ ficaria assim: modulos/ cad_pessoa/ cad_pessoa.php cad_pessoa.css ( se houber ) cad_pessoa.js ( se houver ) action/ ( pasta com as aes do mdulo);

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro

6 - Criando Uma Aplicao Exemplo


Considerando que os passos acima foram executados com sucesso, vamos dar um exemplo de como criar uma aplicao simples, com um menu e um formulrio de entrada de dados sem acesso a banco de dados, somente a ttulo de demonstrao. Crie um diretrio chamado appteste/ no seu servidor web. O endereo de acesso pelo browser ser: http://localhost/appteste/. Lembrando que esta aplicao um novo diretrio, fora do diretrio minha_aplicacao/ que foi criado para explicar a estrutura de diretrios no tpico anterior. No confundir. Descompacte o arquivo do FormDin ou baixe do SVN dentro deste diretrio appteste/ ficando com a seguinte estrutura: appteste/base/. Se voc j tiver baixado o zip ou j tiver o diretrio base do exemplo inicial minha_aplicacao/ no precisa fazer novamente, basta copi-lo para dentro do diretrio appteste/. Existe tambm a possibilidade de utilizar o diretrio base/, nico, para todas as aplicaes. Basta cri-lo no mesmo nvel da(s) aplicao(es) e alterar a referncia no(s) includes do index.php adicinando ../ no caminho do diretrio base/, veja o exemplo de como ficaria organizada a estrutura de diretrios para vrias aplicaes com a mesma base/: ./sistemas/ base/ sistemaA/ sistemaB/ ... Vamos criar ento o arquivo index.php que ser responsvel pela inicializao da aplicao e pelo recebimento de todas as requisies da aplicao. Este ser o controlador da aplicao. Utilize o editor de texto de sua preferncia e crie o arquivo index.php no diretrio appteste com o seguinte contedo Sugesto, a utilizao de uma IDE como o eclipse, netbeans ajudam muito devido aos recursos de autocomplete e visualizao dos parmetros ( assinatura do mtodo ). <?php include('base/classes/webform/TApplication.class.php'); // se estiver utilzando um diretrio base nico utilizar assim: include('../base/classes/webform/TApplication.class.php'); $app = new TApplication(); // criar uma instncia do objeto aplicao $app->setTitle('Aplicao Exemplo Utilizando FormDin'); $app->setSigla('SISEXEMPLO'); $app->setUnit('Departamento de Informtica DI 2011'); $app->setLoginInfo('Bem-vindo'); $app->run(); ?>
Modelo de Manual de Instalao, Administrao e Uso do <nome do software>
7

Portal do Software Pblico Brasileiro

Para testar digite no browser o dendereco: http://localhost/appteste/ e pressione <enter>. Se tudo estiver correto, dever aparecer a tela padro da aplicao sem funcionalidades ainda. O prximo passo ser a criao do menu principal da aplicao que ser responsvel por chamar o nosso formulrio exemplo. Para criao do menu principal, vamos utilizar a classe TMenuDhtmlx, que a responsvel pela criao do XML necessrio para criao do menu. Por questo de organizao, vamos colocar o arquivo responsvel pela criao do menu no diretrio includes/. No seu editor, crie um arquivo chamado menu.php com o seguinte contedo: <?php $menu = new TMenuDhtmlx(); $menu->add(1,0,'Cadastro',null,null,'folderAzul.gif'); $menu->add(11,1,'Exemplo','tela_exemplo.php','Exemplo formdin','folderAzulOpen.gif'); $menu->getXml(); ?> Agora necessrio informar o arquivo responsvel pela criao do menu, includes/menu.php aplicao Para isso, abra o arquivo index.php e adicione a linha: $app->setMainMenuFile('includes/menu.php'); antes da linha $app->run(); Faa uma atualizao da pgina da aplicao no browser que o menu dever aparecer. Vamos ento criar o modulo tela_exemplo.php. Crie um novo arquivo chamado tela_exemplo.php dentro da pasta modulos/tela_exemplo/ Adicione o seguinte cdigo ao arquivo: <?php $frm = new TForm('Tela Exemplo Utilizando o FormDin'); $frm->show(); ?> Salve o arquivo e no menu da aplicao no browser, clique na opo Tela Exemplo para exibir o formulrio. Finalizando ento, se tudo funcionou direitinho, o ambiente j est pronto para comear a criao de uma aplicao de verdade. Os prximos passos seria a adio dos campos e botes ao formulrio e fazer o tratamento das aes. No diretrio /base/exemplos tem uma srie de exemplos das funcionalidades, campos etc. 7 - Hardware mnimo necessrio Computador com processador Intel ou Amd.

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>

Portal do Software Pblico Brasileiro Memria RAM: 512MB RAM (1GB RAM recomendvel);

HD: 15GB para instalar o GNU/Linux) ou Windows, com Apache e o PHP

8 - Pr-requisitos Servidor web Apache 2.0 ou superior, com suporte a linguagem PHP versao 5.3 ou superior. 9 - Link da Licena Jridica Creative Commons http://creativecommons.org/licenses/by-sa/2.5/br/legalcode

Modelo de Manual de Instalao, Administrao e Uso do <nome do software>