Location: PHPKode > projects > MUSPA > doc/doc.html
<?xml encoding="ISO 8859-1" version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<title>Muspa</title>
	<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<!-- Instalando -->
<div class="title">MUSPA doc!</div>
<p>
	O muspa é distribuido em um arquivo compactado em tar.bz2,
	o conteúdo de ambos arquivos são iguais. Depois de fazer o download de um desses
	arquivos no local onde você deseja instalar o muspa.
</p>

<div class="subtitle">Pré requesitos</div>
<p>Para executar o muspa você precisa ter pelo menos:</p>
<ul>
	<li>PHP4 (recomendado 4.3.x ou superior)</li>
	<li>MySQL 4.x</li>
	<li>Um servidor http (recomendado Apache)</li>
	<li>Um navegador ;-P (Para mais informações veja a seção <a href="#compatibilidade">compatibilidade</a>)</li>
	<li>Conhecimento mínimo sobre PHP para instalar.</li>
</ul>

<div class="subtitle">Instalando</div>
<p>
	Depois de copiar todos os arquivos para a pasta onde você deseja instalar o muspa,
	execute o script install.php pelo seu navegador.
</p>
<p>
	Como o script de instalação irá mostrar, você precisa setar algumas permissões em alguns arquivos para que o muspa funcione corretamente.
</p>
<table>
	<tr>
		<th>Arquivo</th>
		<th>chmod</th>
	</tr>
	<tr>
		<td>./conf_auto.php</td>
		<td>666</td>
	</tr>
	<tr>
		<td>./conf_modules.php</td>
		<td>666</td>
	</tr>
	<tr>
		<td>./tmp/</td>
		<td>777</td>
	</tr>
	<tr>
		<td>./modules/noticia/imagens/</td>
		<td>777</td>
	</tr>
</table>

<div class="subtitle">Testando as configurações</div>
<p>O instalador irá redirecionar você para a tela de login do muspa assim que ele finalizar a isntalação.</p>
<p>Mesmo se as configurações do MySQL estiverem erradas a tela de login deve aparecer,
entre com o usuário <strong>admin</strong> e a senha <strong>admin</strong>, se não
apareceu nenhuma mensagem de erro depois disso a configuração esta correta.
</p>
<p>
Se você não configurou corretamente o MySQL, tente logar no muspa, e será enviado para você
um email com o erro que ocorreu, ou então use o muspa no modo DEBUG (ver script ./config.php) para ver o que esta acontecendo.
</p>

<!-- Compatibilidade -->
<div class="title"><a name="compatibilidade"></a>Compatibilidade</div>
<p>Apesar de tentarmos fazer o muspa compatível com
	a maioria dos navegadores mais usados pela humanidade, recomendamos o
	Mozilla Firefox, já que o IE6 não suporta CSS level2 entre outras coisas,
	porém o muspa continua sendo funcionalmente 100% compativel com o IE6.
</p>
<p>
	Não foram feitos testes com o IE5.5, talvez ele funcione, talvez não. Com o IE5 não irá
	funcionar, pois o javascritp do menu não funciona nele, assim como o editor WYSIWYG.
</p>
<p>
	O Konqueror não é 100% compativél com o muspa, pois o editor WYSIWYG usado no módulo de
	notícias por exemplo não funciona nele, já que o konqueror ainda não tem suporte a
	<i>design mode</i>, o que impossibilita qualquer editor WYSIWYG ser executado nele.
</p>
<p>
	Não temos o mínimo interesse em fazer javascripts, etc.. compativeis com versões antigas de
	navegadores, como o IE5.0 por exemplo, pois o MUSPA é uma ferramenta feita para ser usada
	por pessoas que vão gerenciar sites, sendo obrigação deste ter a versão mais recente ou pelo
	menos não tão antiga de seu navegador.
</p>




<!-- Criando módulos -->
<div class="title">Configurando/usando módulo de noticias</div>
<p>
Esta é uma explicação relampago de como configurar o módulo de notícias, um documentação
melhor deve surgir em próximas versões.
</p>

<p>
O primeiro passo para configurar o módulo de notícias e configurar as seções e modelos.
Seção normalmente é a seção do site onde a notícia vai aparecer, por exemplo "Capa", "Esportes", etc.
Modelo é o trecho de código HTML que será utilizado para mostrar o chamamaento daquela notícia no site,
chamamento é basicamente o link para a notícia, que normalmente tem um título, um pequeno texto e talvez uma foto.
</p>

<p>
Vá no menu "Notícias" => "Seções/Modelos", clique no link para criar um novo modelo, no campo "nome" digite:
</p>

<p><code>(DATAHORA|%d/%m/%Y} - {TITULO}&lt;br /&gt;</code></p>

<p>Um único modelo pode ser usado por várias seções, os textos {TITULO} e (DATAHORA|%d/%m/%Y} serão substituidos pelo
título da notícia e pela data respectivamente. Salve o modelo clicando em "Criar Modelo".</p>

<p>
Agora vamos criar uma seção, novamente vá em "Notícias" => "Seções/Modelos", (note que você já vê seu modelo listado)
clique no link para criar uma novo seção.
</p>

<p>
	Escolha um nome para sua seção, selecione quais usuários do MUSPA podem cadastrar notícia nesta
	seção e escolha quais modelos esta seção pode ter, como isso é apenas uma introdução, marque todos
	os usuários e modelos que estiverem disponíveis.
</p>
<p>
No campo "Arquivo de Conteúdo" digite <code>conteudo.php</code>, este será o arquivo usado para mostrar o conteúdo da notícia. Salve a seção.
</p>

<div class="subtitle">Criando arquivo de conteúdo</div>
<p>
Os arquivos de conteúdo podem ser salvos em qualquer lugar, bastando especificar corretamente
seu endereço quando for cadastrar a seção, para facilitar as coisas vamos por o arquivo de
conteúdo dentro do diretório <strong>muspa/modules/noticia/</strong>, assim basta especificarmos o nome do arquivo
quando criarmos a seção, pois o caminho do arquivo é em relação a esta pasta, e não a pasta raiz do muspa.
</p>

<p>
	Crie um arquivo HTML normal e salve como <strong>conteudo.php</strong> na pasta
	 <strong>muspa/modules/noticia/</strong>. No lugar onde você quer que apareça o título da notícia,
	 coloque o seguinte código PHP:
</p>
<p><code>&lt;?=$muspa_titulo ?&gt;</code></p>
<p>Lembre-se se colocar isto no código do arquivo! Caso esteja fazendo a página com o DreamWeaver&reg; ou outro editor HTML digite o código no modo código, e não no modo design.</p> 

<p>Aqui estão mais alguns códigos que você pode colocar, prometo uma lista completo com descrição de cada código em
um futuro próspero, mas por enquanto é só isso.</p>

<p><code>&lt;?=$muspa_conteudo ?&gt;</code></p>
<p><code>&lt;?=$muspa_fonte ?&gt;</code></p>
<p><code>&lt;?=$muspa_datahora ?&gt;</code></p>
<p><code>&lt;?=$muspa_olho ?&gt;</code></p>
<p><code>&lt;?=$muspa_minitexto ?&gt;</code></p>


<p>Se você fez tudo certo e eu expliquei tudo certo, agora você ja esta com o MUSPA configurado, bastando apenas fazer
aparecer em sua página as chamadas para as notícias.</p>

<p>Supondo que a página inicial de seu site seja <code>index.html</code>, renomeie ele para <code>index.shtml</code>.</p>

<p>Onde você desejar que apareça as chamadas da notícia, coloque o seguinte código SSI em seu código HTML:</p>

<p><code>&lt;!--#include virtual="muspa/modules/noticia/?type=list&secao=1&end=10" --&gt;</code></p>

<p>Isso fará com que o servidor HTTP substitua este trecho de código pelas chamadas da notícias da seção com ID igual a 1 (note o trecho <code>secao=1</code> no código, o ID da seção pode ser visto na tela "Seções/Modelos" do MUSPA.</p>

<p>O trecho de código <code>end=10</code> faz com que seja mostrada no máximo 10 notícias.</p>

<p>Existem outras opções que podem ser usadas ai, como para mostrar mais de uma seção por chamada, etc. porém a falta de tempo para escrever essas documentações só me permitem descrever isto.</p>

<p>Agora que tudo esta pronto, cadastre algumas notícias e teste. Se tudo deu certo parabéns por ter conseguido a farçanha de entender tudo o que falei nesse mini tutorial escrito em 10 minutos e boa sorte usando o MUSPA.</p>

<!-- Criando módulos -->
<div class="title">Criando módulos</div>
<p>Todos os módulos do muspa ficam dentro do diretótio ./modules/ em diretótios com seus respectivos nomes,
o nome do diretório precisa ser o mesmo nome do arquivo .php e também o mesmo nome da classe que haverá neste
arquivo.</p>
<p>
	Resumindo, Crie uma classe extendida da classe Admin em um diretório dentro do diretório
	./modules, este diretório precisa ter o mesmo nome da classe que também precisa ter o
	mesmo nome do arquivo .php.
</p>



<!-- Ajudando -->
<div class="title">Ajudando</div>
<p>Se você sabe PHP, é designer, ou apenas quer escrever documentação, sua ajuda será bem vinda!
Acesse <a href="http://muspa.sf.net/suporte.shtml" target="_balnk">http://muspa.sf.net/suporte.shtml</a>.
</p>

<!-- Créditos -->
<p><strong>- Hugo P.L.</strong></p>
</body>
</html>
Return current item: MUSPA