wiki

WikiShow: mudanças entre as edições

Criou página com '= 5W2H = <br> == What == <br> * 1. Qual o nome do seu projeto? ** * 2. Qual o objetivo deste projeto? ** * 3. Quais os maiores desafios, na sua opinião, para se realizar...'
 
Tuliopq (discussão | contribs)
62 edições
 
(17 revisões intermediárias por 2 usuários não estão sendo mostradas)
Linha 6: Linha 6:


* 1.  Qual o nome do seu projeto?
* 1.  Qual o nome do seu projeto?
**
** WikiShow.
* 2.  Qual o objetivo deste projeto?
* 2.  Qual o objetivo deste projeto?
**
** Criar um aplicativo anexado (add-on) ao navegador (Google chrome e/ou Mozilla Firefox) que lê o conteúdo de uma página Wiki e o transforma em um "pdf" do tipo apresentação.
* 3.  Quais os maiores desafios, na sua opinião, para se realizar este trabalho?
* 3.  Quais os maiores desafios, na sua opinião, para se realizar este trabalho?
**
** Entender os mecanismos para criar um add-on.
** Ler o conteúdo da página wiki.
** Criar meios de simplificar a complexa sintexe do Beamer para melhor compreensão e facilitar utilização do usuário.
** Definir parametros de personalização.
* 4.  Quais os conhecimentos básicos que devemos ter para se implementar este projeto?
* 4.  Quais os conhecimentos básicos que devemos ter para se implementar este projeto?
**
** Ter conhecimento avançado em Latex, mais especificamente na classe Beamer.
* 5.  Quais soluções similares existem no mercado?
* 5.  Quais soluções similares existem no mercado?
** http://wiki2beamer.sourceforge.net/
** http://www.mediawiki.org/wiki/Extension:Wiki2LaTeX
<br>
<br>


Linha 20: Linha 25:


* 1. Porque é interessante desenvolver este projeto?
* 1. Porque é interessante desenvolver este projeto?
**  
** A ferramenta Wiki tem se mostrado um enorme potêncial em uma sala de aula, documentando avanços dos alunos, e organizando as aulas, mais a ferramenta ainda carece dessa ferramenta, de forma facil de usar.
* 2. Porque deve usar a tecnologia escolhida?
* 2. Porque deve usar a tecnologia escolhida?
**  
** Latex é largamente usado na área científica, por ser uma ferramenta poderosa para criação de documentos, Latex é dividifo em classes, entre as diversas clases tem as classes de apresentações, e a mais difundida neste meio é o Beamer[1], a classe escolhida para este projeto, por ser multiplataforma, e sob a licensa GNU, ela se encaixa perfeitamente.
* 3. Porque usar o hardware específico?
** [1] http://en.wikipedia.org/wiki/Beamer_%28LaTeX%29
**  
* 3. Porque usar o sistema específico?
* 4. Porque usar o sistema específico?
** Firefox e Chrome são os navegadores multiplataforma mais usados e difundido, podendo ser acessado por qualquer um, na maioria dos computadores.
**
<br>
<br>


Linha 33: Linha 37:


* 1. Quem pode se beneficiar deste projeto?  
* 1. Quem pode se beneficiar deste projeto?  
**  
** Todo aqueles interessados em transformar um conteúdo Wiki em uma apresentação, seja para uma aula ou uma simples apresentação de um conteúdo em uma reunião.
* 2. Quem poderá operar o sistema?
* 2. Quem poderá operar o sistema?
**
** O sistema não deverá requisitar muito conhecimento para ser operado, portanto qualquer um interessado poderá opera-lo.
* 3. Quem deverá participar do desenvolvimento do sistema?  
* 3. Quem deverá participar do desenvolvimento do sistema?  
**  
** Engenheiros, cientistas e/ou entusiantas
<br>
<br>


Linha 44: Linha 48:


* 1. Onde os dados serão inseridos?  
* 1. Onde os dados serão inseridos?  
**
** Os dados serão lidos diretamente pelo navegador, as únicas informações inseridas serão as informações de personalização.
* 2. Onde os dados serão externalizados, publicados?
* 2. Onde os dados serão externalizados, publicados?
**  
** Uma janela será aberta perguntando ao usuário onde ele deseja salvar os arquivos que, a princípio serão um ".tex", um ".pdf" e fotos.
* 3. Onde esta aplicação poderá ser usada?  
* 3. Onde esta aplicação poderá ser usada?  
**  
** Em meios acadêmicos ou corporativo.
* 4. Onde os dados serão armazenadas?  
* 4. Onde os dados serão armazenadas?  
**  
** Como o software não deverá usar muita memoria, os dados serão temporariamente armazenados na memória do computador.
* 5. Onde o software deverá ser hospedado?  
* 5. Onde o software deverá ser hospedado?  
**
** A principio no http://sourceforge.net/ podendo chegar ao Chrome Web Store e/ou no equivalente do Firefox.
<br>
<br>


Linha 59: Linha 63:


* 1. Em quanto tempo pretende desenvolver o sistema?  
* 1. Em quanto tempo pretende desenvolver o sistema?  
**  
** Em aproximadamente 6 meses.
* 2. Quais serão as fases e em quanto tempo cada uma?  
* 2. Quais serão as fases e em quanto tempo cada uma?  
**
** 3 meses para absorver o conhecimento necessário.
* 3. Qual o tempo de resposta do dispositivo ou do sistema?
** 3 meses para produzir e corrigir o código.
**  
* 3. Quanto tempo para responder a uma entrada?
* 4. Quanto tempo para responder a uma entrada?
** Praticamente instantâneo
**  
* 4. Quanto tempo para gerar a saída?
* 5. Quanto tempo para gerar a saída?
** Um computador básico não irá demorar mais do que 40s.
** <br>
<br>


== How ==
== How ==
Linha 73: Linha 77:


* 1. Como será dividido o desenvolvimento do sistema?
* 1. Como será dividido o desenvolvimento do sistema?
**  
** Primeiro, Documentando as diferentes sintaxe das ferramentas, exemplo como é a sintaxe de uma tabela em Wiki e em Latex
** Segundo, implementando algoritimo que identifica cada sintaxe do Wiki.
** Terceiro, implementando algoritimo que escreve cada sintaxe do Latex.
** Quarto, Extrair as informações da página.
** Quinto, implementar um algoritimo que organiza os dados (texto e fotos) de acordo com as preferência.
** Sexto, gera a saída.
* 2. Como será feita a entrada de dados?  
* 2. Como será feita a entrada de dados?  
**  
** A entrada será feita automática uma vez que o software irá identificar quando uma pagina Wiki está aberta e irá libera a execução, o usuário então irá apenas configurar suas preferências (como o template).
* 3. Como será feita a saída de dados?  
* 3. Como será feita a saída de dados?  
**  
** A saída será dois arquivos, um pdf e um tex, este último para dar a possibilidade de edição manual pelo usuário.
* 4. Descreva a 1a. funcionalidade?  
* 4. Descreva a 1a. funcionalidade?  
**  
** Criar tex e pdf.
* 5. Descreva a 2a. funcionalidade?
* 5. Descreva a 2a. funcionalidade?
** ............
** Criar e editar templates.
* n. Descreva a enésima funcionalidade?
<br>
** <br>


== How much ==
== How much ==
Linha 89: Linha 97:


* 1. Quanto custa cada parte do sistema?
* 1. Quanto custa cada parte do sistema?
**  
** Nada, todo o sistema que será usado é sobre a licensa GNU
* 2. Quanto deverá custar todo o sistema?  
* 2. Quanto deverá custar todo o sistema?  
**  
** O sistema terá apenas o custo do profissional
* 3. Quantas pessoas deverão ser usadas (Equipe) ?  
* 3. Quantas pessoas deverão ser usadas (Equipe) ?  
**  
** Apenas uma.
* 4. Quanto custa cada profissional?
* 4. Quanto custa cada profissional?
**  
** Nada, pois será um trabalho voluntário
* 5. Qual deverá ser o preço de aquisição do seu software para o usuário final (Valor de mercado)?   
* 5. Qual deverá ser o preço de aquisição do seu software para o usuário final (Valor de mercado)?   
**  
** O software será liberado gratuitamente.
<br>
<br>


= DER =
= DER =
[[Arquivo:WikiShow_DER.png]]


= DFD =
= DFD =
[[Arquivo:WikiShow_DFD2.jpeg]]


= DD =
= DD =
* Interface do usuário:
[[Arquivo:WikiShowUsuario.png]]
* O arquivo .tex é gerado com o nome do projeto.
* O arquivo .pdf é gerado com o mesmo nome do arquivo .tex.
* O usuário pode colar o texto no formato wiki para gerar o arquivo tex ou carregar um arquivo tex jah existente inserindo o caminho do aqruivo no campo "Arquivo Tex", e partir dai chamar o editor ou o pdflatex.
* Quando o usuário chamar pdflatex deve abrir uma janela mostrando a saída do progresso com a opção de salvar a saída.
[[Arquivo:WikiShowSaidaPdflatex.png]]
* O usuário pode chamar um editor de texto simples para editar o conteúdo do arquivo Tex.
* O editor tem uma opção de ajuda, que irá abrir um no navegador o site com a documentação do Beamer.
[[Arquivo:WikiShowEditor.png]]
* Em "Configurações" irá abrir uma tela com duas abas, uma para editar os paramentros da sintaxe, e outra com os parametros que são inseridos no preâmbulo.
* Em "Sintaxe" o usuário pode editar a forma como o programa reconhece os ambientes, tanto no formato wiki quanto no formato latex, Por exemplo, no campo de texto do wiki "= %s =" ("%s" é a string que contém o texto) ser "\chapter{%s}" no latex. O usuário poderá salvar as configurações.
[[Arquivo:WikiShowConfSintaxe.png]]
* Na aba "Preâmbulo" o usuário pode escolher a codificação do texto, a fonte padrão, babel (para reconhecer o tipo de linguagem, e poder por exemplo separar sílaba), o tema a ser utilizado, a cor do tema e inserir os autor e instituto.
* Em cor do tema é aplicado um filtro de imagem sobre o plano de fundo, que multiplica as cores do plano de fundo pela cor selecionada pelo usuário.
[[Arquivo:WikiShowConfPreambulo.png]]
* Usuário pode usar os temas padrões do beamer, mais terá a opção de criar seus próprios temas usando um sistema próprio do WikiShow, que embora tenha as opções muito limitada é simples de usar.
* As opções para criar os temas são:
** Plano de fundo: o campo deve conter uma string para foto, esta foto tem o constraste do desing do slide, isto é uma foto monocromática, onde a cor será definida após a aplicação do filtro.
** Tamanho, cor e posição para o titulo: em posição o usuário pode alterar a posição com que o título aparece no slide para ajustar ao desing.
** Autor: O usuário pode colocar sua assinatura em todos os slides.
** Cabeçalho: O usuário pode colocar informações extras no cabeçalho, como por exemplo, exibir a seção, data ou até mesmo uma foto.
** Rodapé: semelhante ao cabeçalho.
[[Arquivo:WikiShowTemas.png]]
<br>
= UML =
<br>
== Diagrama de Classes ==
[[Arquivo:wikishowclasse.png]]
<br>
== Diagrama de Casos de Uso ==
[[Arquivo:Wikicasodeuso.png]]
<br>
== Detalhamento dos Casos de Uso ==
'''Nome do Caso de Uso:''' Gerar Pdf
'''Ator:''' Usuário (iniciante) PdfLatex
'''Pré-condições:''' O arquivo tex deverá estar pronto
'''Pós-condições:''' o metodo salvar pdf é iniciado
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em gerar pdf || -
|-
| - || 2. O sistema envia o arquivo tex para o sistema pdflatex com os parametros de execução
|-
| 3. O pdfLatex processa o arquivo em uma pasta temporária || -
|}
<br>
  '''Seqüências Alternativas'''
3a: Erro:
1. Caso um erro aconteça ao processar o arquivo o erro deverá aparecer na tela para o usuário.
<br>
'''Nome do Caso de Uso:''' Salvar Pdf
'''Ator:''' PdfLatex (iniciante) Usuário
'''Pré-condições:''' O arquivo pdf deverá estar pronto
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. Pdflatex executa a função com a informação da localização temporário do pdf || -
|-
| - || 2. O sistema abre uma janela informando as pastas do sistema, para que o usuário possa escolher a pasta e o nome do arquivo
|-
| 3. O usuário informa a localização e o nome do arquivo || -
|-
| - || 4. O sistema salva o arquivo
|}
<br>
  '''Seqüências Alternativas'''
4a: Erro: O arquivo já existe
1. O sistema informa o erro e pergunta ao usuário se ele dejesa salvar por cima.
<br>
'''Nome do Caso de Uso:''' Novo Proj
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em Novo Projeto || -
|-
| - || 2. O sistema limpa o editor e seta as configuraçõs com o valor padrão.
|}
<br>
  '''Seqüências Alternativas'''
2:  Caso o projeto anterior não esteja salvo o sistema deverá informar ao usuário com as opções de salvar projeto e continuar assim mesmo
<br>
'''Nome do Caso de Uso:''' Abrir projeto
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:''' O sistema reconfigura com as configurações do projeto
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em abrir projeto ||
|-
| - || 2. O sistema abre uma janela para que o usuário possa escolher a localização e o arquivo com os dados do projeto.
|}
<br>
'''Nome do Caso de Uso:''' Salvar Projeto
'''Ator:''' Usuário
'''Pré-condições:''' projeto atual diferente de vazio
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em Salvar projeto ||
|-
| - || 2. O sistema abre uma janela para que o usuário preencha informações de localização e nome do arquivo do projeto
|-
| 3. O usuário preenche as informações e clica em salvar || -
|-
| - || 4. O sistema salva o projeto
|}
<br>
  '''Seqüências Alternativas'''
4a: Erro: O arquivo já existe
1. O sistema informa o erro e pergunta ao usuário se ele dejesa salvar por cima.
<br>
'''Nome do Caso de Uso:''' Configurar
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em configurações || -
|-
|  || 2a. O sistema abre uma janela com as possiveis configurações separadas em abas, configurações gerais, preambulo e tema.
|-
|  || 2b. Em configurações gerais o usuário pode escolher o tema, o preambulo e colocar os parametros de execução do pdflatex, ele pode ainda alterar as configurações do editor de texto como cor da letra, cor de fundo, tamanho, fonte, etc.
|-
|  || 2c. Em preambulo o usuário terá acesso em um pequeno texto com as infomações do preambulo, podendo altera-lo, e ainda pode salvar ou criar um novo.
|-
|  || 2d. Em tema o usuário terá acesso a configurações especificas do design do slide, como cabeçalho e rodapé foto do fundo do slide tamanho, cor e tipo da letra usado em cada um, terá também a opção de alterar a posicao com que o cabeçalho e rodapé aparece. E ainda pode salvar ou criar um novo.
|}
<br>
  '''Seqüências Alternativas'''
1a:
1.
<br>
'''Nome do Caso de Uso:''' Abrir Tema
'''Ator:'''
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em abrir tema ||
|-
| - || 2. O sistema abre uma janela para que o usuário possa escolher a localização e o arquivo com os dados do tema.
|}
<br>
  '''Seqüências Alternativas'''
1a:
1.
<br>
'''Nome do Caso de Uso:''' Novo Tema
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em novo tema || -
|-
|  || 2. O sistema limpa as informações de configurações referente ao tema
|}
<br>
  '''Seqüências Alternativas'''
2a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar
<br>
'''Nome do Caso de Uso:''' Salvar Tema
'''Ator:''' Usuário
'''Pré-condições:''' ter configurações não salvas
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em salvar tema ||
|-
|  || 2. O sistema salva as configurações tema configuradas pelo usuário
|}
<br>
  '''Seqüências Alternativas'''
2a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar
2b: Caso não tenha uma versão antiga do arquivo salvo o sistema abre uma janela para que o usuário salvo o novo arquivo
<br>
'''Nome do Caso de Uso:''' Editar Tema
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em editar tema ||
|-
| || 2. O sistema abre o menu de configurações na aba tema
|}
<br>
'''Nome do Caso de Uso:''' Novo Preambulo
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em Novo Preambulo ||
|-
|  || 2. O sistema limpa o texto dos preâmbulo
|}
<br>
  '''Seqüências Alternativas'''
1a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar
<br>
'''Nome do Caso de Uso:''' Salvar Tema
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em Salvar preambulo ||
|-
|  || 2. O sistema salva as configurações do preâmbulo
|}
<br>
  '''Seqüências Alternativas'''
2a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar
2b: Caso não tenha uma versão antiga do arquivo salvo o sistema abre uma janela para que o usuário salvo o novo arquivo
<br>
'''Nome do Caso de Uso:''' Abrir Preâmbulo
'''Ator:''' Usuário
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. O usuário clica em Abrir Preâmbulo || 
|-
|  || 2. O sistema abre uma janela para que o usuário possa escolher a localização e o arquivo com os dados do preâmbulo.
|}
<br>
'''Nome do Caso de Uso:''' Identifica Estrut
'''Ator:''' Texto
'''Pré-condições:'''
'''Pós-condições:'''
:: '''Seqüência de Eventos'''
{| class="wikitable"
|-
! '''Ação do Ator'''!!'''Resposta do Sistema'''
|-
| 1. Texto envia os dados do texto no formato wiki para o sistema ||
|-
| - || 2. O sistema fragmenta o texto pelas diferentes estruturas (capitulos, tabelas, fotos, etc) sem perder a informação da sequencia e os envia para os seus correspondentes conversores
|}
<br>
  '''Seqüências Alternativas'''
2a: O sistema pode não identificar a que ambiente pertence um trecho do texto
1. O sistema deve retornar uma mensagem de erro
<br>
= Protótipo =
<br>

Edição atual tal como às 23h37min de 12 de fevereiro de 2015

5W2H


What


  • 1. Qual o nome do seu projeto?
    • WikiShow.
  • 2. Qual o objetivo deste projeto?
    • Criar um aplicativo anexado (add-on) ao navegador (Google chrome e/ou Mozilla Firefox) que lê o conteúdo de uma página Wiki e o transforma em um "pdf" do tipo apresentação.
  • 3. Quais os maiores desafios, na sua opinião, para se realizar este trabalho?
    • Entender os mecanismos para criar um add-on.
    • Ler o conteúdo da página wiki.
    • Criar meios de simplificar a complexa sintexe do Beamer para melhor compreensão e facilitar utilização do usuário.
    • Definir parametros de personalização.
  • 4. Quais os conhecimentos básicos que devemos ter para se implementar este projeto?
    • Ter conhecimento avançado em Latex, mais especificamente na classe Beamer.
  • 5. Quais soluções similares existem no mercado?


Why


  • 1. Porque é interessante desenvolver este projeto?
    • A ferramenta Wiki tem se mostrado um enorme potêncial em uma sala de aula, documentando avanços dos alunos, e organizando as aulas, mais a ferramenta ainda carece dessa ferramenta, de forma facil de usar.
  • 2. Porque deve usar a tecnologia escolhida?
    • Latex é largamente usado na área científica, por ser uma ferramenta poderosa para criação de documentos, Latex é dividifo em classes, entre as diversas clases tem as classes de apresentações, e a mais difundida neste meio é o Beamer[1], a classe escolhida para este projeto, por ser multiplataforma, e sob a licensa GNU, ela se encaixa perfeitamente.
    • [1] http://en.wikipedia.org/wiki/Beamer_%28LaTeX%29
  • 3. Porque usar o sistema específico?
    • Firefox e Chrome são os navegadores multiplataforma mais usados e difundido, podendo ser acessado por qualquer um, na maioria dos computadores.


Who


  • 1. Quem pode se beneficiar deste projeto?
    • Todo aqueles interessados em transformar um conteúdo Wiki em uma apresentação, seja para uma aula ou uma simples apresentação de um conteúdo em uma reunião.
  • 2. Quem poderá operar o sistema?
    • O sistema não deverá requisitar muito conhecimento para ser operado, portanto qualquer um interessado poderá opera-lo.
  • 3. Quem deverá participar do desenvolvimento do sistema?
    • Engenheiros, cientistas e/ou entusiantas


Where


  • 1. Onde os dados serão inseridos?
    • Os dados serão lidos diretamente pelo navegador, as únicas informações inseridas serão as informações de personalização.
  • 2. Onde os dados serão externalizados, publicados?
    • Uma janela será aberta perguntando ao usuário onde ele deseja salvar os arquivos que, a princípio serão um ".tex", um ".pdf" e fotos.
  • 3. Onde esta aplicação poderá ser usada?
    • Em meios acadêmicos ou corporativo.
  • 4. Onde os dados serão armazenadas?
    • Como o software não deverá usar muita memoria, os dados serão temporariamente armazenados na memória do computador.
  • 5. Onde o software deverá ser hospedado?


When


  • 1. Em quanto tempo pretende desenvolver o sistema?
    • Em aproximadamente 6 meses.
  • 2. Quais serão as fases e em quanto tempo cada uma?
    • 3 meses para absorver o conhecimento necessário.
    • 3 meses para produzir e corrigir o código.
  • 3. Quanto tempo para responder a uma entrada?
    • Praticamente instantâneo
  • 4. Quanto tempo para gerar a saída?
    • Um computador básico não irá demorar mais do que 40s.


How


  • 1. Como será dividido o desenvolvimento do sistema?
    • Primeiro, Documentando as diferentes sintaxe das ferramentas, exemplo como é a sintaxe de uma tabela em Wiki e em Latex
    • Segundo, implementando algoritimo que identifica cada sintaxe do Wiki.
    • Terceiro, implementando algoritimo que escreve cada sintaxe do Latex.
    • Quarto, Extrair as informações da página.
    • Quinto, implementar um algoritimo que organiza os dados (texto e fotos) de acordo com as preferência.
    • Sexto, gera a saída.
  • 2. Como será feita a entrada de dados?
    • A entrada será feita automática uma vez que o software irá identificar quando uma pagina Wiki está aberta e irá libera a execução, o usuário então irá apenas configurar suas preferências (como o template).
  • 3. Como será feita a saída de dados?
    • A saída será dois arquivos, um pdf e um tex, este último para dar a possibilidade de edição manual pelo usuário.
  • 4. Descreva a 1a. funcionalidade?
    • Criar tex e pdf.
  • 5. Descreva a 2a. funcionalidade?
    • Criar e editar templates.


How much


  • 1. Quanto custa cada parte do sistema?
    • Nada, todo o sistema que será usado é sobre a licensa GNU
  • 2. Quanto deverá custar todo o sistema?
    • O sistema terá apenas o custo do profissional
  • 3. Quantas pessoas deverão ser usadas (Equipe) ?
    • Apenas uma.
  • 4. Quanto custa cada profissional?
    • Nada, pois será um trabalho voluntário
  • 5. Qual deverá ser o preço de aquisição do seu software para o usuário final (Valor de mercado)?
    • O software será liberado gratuitamente.


DER

DFD

DD

  • Interface do usuário:

  • O arquivo .tex é gerado com o nome do projeto.
  • O arquivo .pdf é gerado com o mesmo nome do arquivo .tex.
  • O usuário pode colar o texto no formato wiki para gerar o arquivo tex ou carregar um arquivo tex jah existente inserindo o caminho do aqruivo no campo "Arquivo Tex", e partir dai chamar o editor ou o pdflatex.
  • Quando o usuário chamar pdflatex deve abrir uma janela mostrando a saída do progresso com a opção de salvar a saída.

  • O usuário pode chamar um editor de texto simples para editar o conteúdo do arquivo Tex.
  • O editor tem uma opção de ajuda, que irá abrir um no navegador o site com a documentação do Beamer.

  • Em "Configurações" irá abrir uma tela com duas abas, uma para editar os paramentros da sintaxe, e outra com os parametros que são inseridos no preâmbulo.
  • Em "Sintaxe" o usuário pode editar a forma como o programa reconhece os ambientes, tanto no formato wiki quanto no formato latex, Por exemplo, no campo de texto do wiki "= %s =" ("%s" é a string que contém o texto) ser "\chapter{%s}" no latex. O usuário poderá salvar as configurações.

  • Na aba "Preâmbulo" o usuário pode escolher a codificação do texto, a fonte padrão, babel (para reconhecer o tipo de linguagem, e poder por exemplo separar sílaba), o tema a ser utilizado, a cor do tema e inserir os autor e instituto.
  • Em cor do tema é aplicado um filtro de imagem sobre o plano de fundo, que multiplica as cores do plano de fundo pela cor selecionada pelo usuário.

  • Usuário pode usar os temas padrões do beamer, mais terá a opção de criar seus próprios temas usando um sistema próprio do WikiShow, que embora tenha as opções muito limitada é simples de usar.
  • As opções para criar os temas são:
    • Plano de fundo: o campo deve conter uma string para foto, esta foto tem o constraste do desing do slide, isto é uma foto monocromática, onde a cor será definida após a aplicação do filtro.
    • Tamanho, cor e posição para o titulo: em posição o usuário pode alterar a posição com que o título aparece no slide para ajustar ao desing.
    • Autor: O usuário pode colocar sua assinatura em todos os slides.
    • Cabeçalho: O usuário pode colocar informações extras no cabeçalho, como por exemplo, exibir a seção, data ou até mesmo uma foto.
    • Rodapé: semelhante ao cabeçalho.


UML


Diagrama de Classes


Diagrama de Casos de Uso


Detalhamento dos Casos de Uso

Nome do Caso de Uso: Gerar Pdf
Ator: Usuário (iniciante) PdfLatex
Pré-condições: O arquivo tex deverá estar pronto
Pós-condições: o metodo salvar pdf é iniciado
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em gerar pdf -
- 2. O sistema envia o arquivo tex para o sistema pdflatex com os parametros de execução
3. O pdfLatex processa o arquivo em uma pasta temporária - 


 Seqüências Alternativas
3a: Erro:
1. Caso um erro aconteça ao processar o arquivo o erro deverá aparecer na tela para o usuário.



Nome do Caso de Uso: Salvar Pdf
Ator: PdfLatex (iniciante) Usuário
Pré-condições: O arquivo pdf deverá estar pronto
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. Pdflatex executa a função com a informação da localização temporário do pdf -
- 2. O sistema abre uma janela informando as pastas do sistema, para que o usuário possa escolher a pasta e o nome do arquivo
3. O usuário informa a localização e o nome do arquivo -
- 4. O sistema salva o arquivo 


 Seqüências Alternativas
4a: Erro: O arquivo já existe
1. O sistema informa o erro e pergunta ao usuário se ele dejesa salvar por cima.




Nome do Caso de Uso: Novo Proj
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em Novo Projeto -
- 2. O sistema limpa o editor e seta as configuraçõs com o valor padrão. 


 Seqüências Alternativas
2:  Caso o projeto anterior não esteja salvo o sistema deverá informar ao usuário com as opções de salvar projeto e continuar assim mesmo




Nome do Caso de Uso: Abrir projeto
Ator: Usuário
Pré-condições: 
Pós-condições: O sistema reconfigura com as configurações do projeto
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em abrir projeto
- 2. O sistema abre uma janela para que o usuário possa escolher a localização e o arquivo com os dados do projeto. 


Nome do Caso de Uso: Salvar Projeto
Ator: Usuário
Pré-condições: projeto atual diferente de vazio
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em Salvar projeto
- 2. O sistema abre uma janela para que o usuário preencha informações de localização e nome do arquivo do projeto
3. O usuário preenche as informações e clica em salvar -
- 4. O sistema salva o projeto 


 Seqüências Alternativas
4a: Erro: O arquivo já existe
1. O sistema informa o erro e pergunta ao usuário se ele dejesa salvar por cima. 



Nome do Caso de Uso: Configurar 
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em configurações -
2a. O sistema abre uma janela com as possiveis configurações separadas em abas, configurações gerais, preambulo e tema.
2b. Em configurações gerais o usuário pode escolher o tema, o preambulo e colocar os parametros de execução do pdflatex, ele pode ainda alterar as configurações do editor de texto como cor da letra, cor de fundo, tamanho, fonte, etc.
2c. Em preambulo o usuário terá acesso em um pequeno texto com as infomações do preambulo, podendo altera-lo, e ainda pode salvar ou criar um novo.
2d. Em tema o usuário terá acesso a configurações especificas do design do slide, como cabeçalho e rodapé foto do fundo do slide tamanho, cor e tipo da letra usado em cada um, terá também a opção de alterar a posicao com que o cabeçalho e rodapé aparece. E ainda pode salvar ou criar um novo. 


 Seqüências Alternativas
1a: 
1. 



Nome do Caso de Uso: Abrir Tema
Ator: 
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em abrir tema
- 2. O sistema abre uma janela para que o usuário possa escolher a localização e o arquivo com os dados do tema. 


 Seqüências Alternativas
1a: 
1. 



Nome do Caso de Uso: Novo Tema
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em novo tema -
2. O sistema limpa as informações de configurações referente ao tema 


 Seqüências Alternativas
2a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar



Nome do Caso de Uso: Salvar Tema
Ator: Usuário
Pré-condições: ter configurações não salvas
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em salvar tema
2. O sistema salva as configurações tema configuradas pelo usuário 


 Seqüências Alternativas
2a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar
2b: Caso não tenha uma versão antiga do arquivo salvo o sistema abre uma janela para que o usuário salvo o novo arquivo



Nome do Caso de Uso: Editar Tema
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em editar tema
2. O sistema abre o menu de configurações na aba tema 


Nome do Caso de Uso: Novo Preambulo
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em Novo Preambulo
2. O sistema limpa o texto dos preâmbulo 


 Seqüências Alternativas
1a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar 



Nome do Caso de Uso: Salvar Tema
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em Salvar preambulo
2. O sistema salva as configurações do preâmbulo 


 Seqüências Alternativas
2a: Caso haja alterações não salvas o sistema informa o usuário dando-lhe a opção de salvar
2b: Caso não tenha uma versão antiga do arquivo salvo o sistema abre uma janela para que o usuário salvo o novo arquivo



Nome do Caso de Uso: Abrir Preâmbulo
Ator: Usuário
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. O usuário clica em Abrir Preâmbulo
2. O sistema abre uma janela para que o usuário possa escolher a localização e o arquivo com os dados do preâmbulo. 



Nome do Caso de Uso: Identifica Estrut
Ator: Texto
Pré-condições: 
Pós-condições:
Seqüência de Eventos
Ação do Ator Resposta do Sistema
1. Texto envia os dados do texto no formato wiki para o sistema
- 2. O sistema fragmenta o texto pelas diferentes estruturas (capitulos, tabelas, fotos, etc) sem perder a informação da sequencia e os envia para os seus correspondentes conversores 


 Seqüências Alternativas
2a: O sistema pode não identificar a que ambiente pertence um trecho do texto
1. O sistema deve retornar uma mensagem de erro


Protótipo


Disponível em “http://3.143.69.156/wiki/index.php?title=WikiShow&oldid=34428”