clagomess/pirilampo

The open source living documentation generator of features files writen in Gherkin and Markdown support.

pirilampo's Issues

1.1.6. Alterar Forma de Versionamento

O versionamento de um arquivo que venha conter várias features não é interessante, mas isso podemos resolver através de instrução aos analistas. Já o versionamento atual, temos o problema de ser mantido em memória, apenas para geração do HTML.

Com isso propomos um versionamento utilizando um arquivo em cada pasta das funcionalidades, onde poderá conter o campo versão.

Neste arquivo poderá conter algumas outras informações, para a ferramenta utilizar no momento de aplicar a versão. Além do campo "Versão", os campos "Baseline" e "Release" são interessantes para o arquivo.

Possibilidade de não embedar imagens

1.1. Nova Interface

*Campos adicionados foram destacados em vermelho

Erro

com.itextpdf.tool.xml.exceptions.RuntimeWorkerException: Invalid nested tag p fo
und, expected closing tag campo.
        at com.itextpdf.tool.xml.XMLWorker.endElement(XMLWorker.java:135)
        at com.itextpdf.tool.xml.parser.XMLParser.endElement(XMLParser.java:397)

        at com.itextpdf.tool.xml.parser.state.ClosingTagState.process(ClosingTag
State.java:71)
        at com.itextpdf.tool.xml.parser.XMLParser.parseWithReader(XMLParser.java
:237)
        at com.itextpdf.tool.xml.parser.XMLParser.parse(XMLParser.java:215)
        at com.itextpdf.tool.xml.parser.XMLParser.parse(XMLParser.java:176)
        at com.itextpdf.tool.xml.XMLWorkerHelper.parseXHtml(XMLWorkerHelper.java
:239)
        at com.itextpdf.tool.xml.XMLWorkerHelper.parseXHtml(XMLWorkerHelper.java
:211)
        at com.itextpdf.tool.xml.XMLWorkerHelper.parseXHtml(XMLWorkerHelper.java
:243)
        at br.com.pirilampo.util.ParsePdf.buildHtml(ParsePdf.java:27)
        at br.com.pirilampo.util.Compilador.compilarPastaPdf(Compilador.java:301
)
        at br.com.pirilampo.controller.MainController.lambda$pastaGerarPdf$19(Ma
inController.java:129)
        at java.lang.Thread.run(Unknown Source)

1.1.3. Utilizar Nome da Funcionalidade no menu

Na imagem anterior, vemos que o nome da epe é o nome do arquivo .feature. Assim como o pickles, é mais interessante que o nome da funcionalidade no menu da EPE seja o nome da funcionalidade citada no meu arquivo feature. Como podemos ver abaixo:

Melhorar a formatação de titulo de cenário no PDF para melhorar a impressão em P&B

Possibilidade de colocar brand (imagem) no lugar do título

Problemas com UTF-8 BOM em features

Imagem fica grande demais na página

Incluí uma imagem em um dos documentos, mas ela fica exageradamente grande.
Não sei se seria um defeito, ou se estou declarando errado.

* De posse dessas informações, acesse o sistema e localize o registro a ser deletado:
    | Abrindo o Follow Up            |
    | ![Tela do sistema](teste.jpg) |

Tema para HTML

https://startbootstrap.com/template-overviews/simple-sidebar/

1.1.2. Alterar a Cor do Texto do Menu

É necessário disponibilizar uma combobox de cores para alteração da cor do texto e da linha que divide as EPE's, com isso, aumentam as chances de personalização do documento.

keyword style

.keyword{
        font-weight: bold;
        color: #337ab7;
        float: left;
        width: 60px;
        text-align: right;
        margin-right: 4px;
    }

1.1.4. Selecionar a Forma de Geração da Documentação

Para facilitar a forma de geração da EPE e matriz, a seleção prévia do campo " Gerar Documentação" deve ser realizada. Abaixo as condições:

Opção	Regra
Individual	Gera uma feature individual
Coletiva	Gera todas as features da pasta selecionada
Matriz	Gera apenas a matriz de rastreabilidade

1.1.7. Criar possibilidade de comparar duas EPE's

Conforme conversa com codificador, foi identificado que há possibilidade de criar comparação de duas features, ou duas pastas de features. Neste ponto, não sabemos como será o resultado final da forma de visualização, mas esta função seria bastante útil para leitura de documentações que foram manutenidas. Ficamos a disposição para alguma proposta para implementação desta função.

1.1.5. Matriz de Rastreabilidade

A matriz de rastreabilidade gerada deve conter duas páginas, com o mesmo layout utilizado na geração da EPE. A matriz será gerada na pasta "..\3 - Requisitos\Especificações", com isso, será possível utilizar informações de vários módulos e funcionalidades.

A matriz deverá gerar um arquivo único em formato HTML, localizado na pasta "..\3 - Requisitos\Matriz de Rastreabilidade". Caso não exista a pasta em questão, o sistema deverá cria-la.

A seguir as páginas que deverão ser criadas após a geração da matriz:

Regras Gerais
Nesta matriz, deve conter as regras gerais, que estão localizadas no arquivo feature "..\3 - Requisitos\Regras Gerais\RegrasGerais.feature". Cada cenário deste arquivo feature deve ser colocado nas seções, recuperando o título do cenário em cada um. Dentro da seção deve haver o texto do cenário, nesta feature os cenários não conterão exemplos, apenas um texto pré-definido e uma lista de funcionalidades.

Os cenários desta matriz estarão referenciados, em sequência, da seguinte forma:

Exemplo: @ref_rng01
Sendo assim, será possível recuperar todos os cenários presentes nas features da pasta "..\3 - Requisitos\Especificações" que tenham a tag @ref_rng01.

• Exemplo da feature de regras gerais:
  
• Exemplo de um cenário, localizado em qualquer lugar da pasta "..\3 - Requisitos\Especificações"
  

O sistema deverá recuperar o nome da funcionalidade, localizado no topo da feature após o campo:

Exemplo: "Funcionalidade: Incluir Pessoa"

E atribuir, com um link de pop up, o nome da funcionalidade e a opção de visualização do cenário original. Na exibição da pop up será exibido o cenário que citou a regra geral, conforme a imagem acima "Verificar Campos Obrigatórios".

Sendo assim, podemos criar a matriz de regras gerais da seguinte forma:

Regras de Negócio

Nesta matriz de regra de negócio deve conter os cenários de todas as features da pasta "..\3 - Requisitos\Especificações" que estão com a tag a seguir:

Exemplo: @ref_rn01

As seções desta página deverão conter o nome das pastas daquela feature.

Sendo assim, as seções devem estar descritas da seguinte forma:

A lista presente em cada seção deve estar preenchidas com as regras sinalizadas com a tag, ordenadas pela feature e numeração do cenário. As quatro primeiras regras do "Módulo" administrativo que podemos considerar estão na seguinte feature:

Os cenários são:

Sendo assim, podemos exemplificar essa matriz da seguinte forma:

Renomear

pirilampo/pom.xml

Line 215 in beb1cb2

<errTitle>enccg</errTitle>

Verificar a possibilidade de embedar as imagens como base64 nos HTML gerado

Sign the executable to minimize antivirus false positives or use launching instead of wrapping

Problemas ao abrir resource em build

file:\D:\pirilampo\build\pirilampo.jar!\br\com\pirilampo\htmlTemplate\template_feature.html (A sintaxe do nome do arquivo, do nome do diretório ou do rótulo do volume está incorreta)

Possibilidade de alterar o nome do menu Raíz

Icone

https://www.iconfinder.com/icons/659648/animal_firefly_glow_insect_lampyrid_lightning_worm_icon#size=128

Possibilidade de alterar cor padrão do menu

1.1.1. Lista de Cores Padronizadas

A forma de alteração de cores do documento dificulta o uso da ferramenta. A solução encontrada foi adicionar as seguintes cores pré-definidas para gerar o documento:

Cor	Código
Vermelho	#D50000
Rosa	#E67C73
Laranja	#F4511E
Amarelo	#F6BF26
Verde Claro	#33B679
Verde	#0B8043
Anil	#039BE5
Azul	#3F51B5
Azul Claro	#7986CB
Violeta	#8E24AA
Cinza	#616161
Branco	#FFFFFF
Preto	#040404
Personalizada	-

O padrão de cores utilizado foi retirado da agenda do Google. Os domínios das combobox "Cor do Menu" e "Cor do Texto do Menu" irão exibir o nome da cor e ao gerar a documentação, o código da cor seria aplicado.
Ao selecionar o domínio " Personalizada " em algum dos campos, é exibido um input abaixo do respectivo campo para adicionar o código da cor. Este campo só deverá ser exibido na seleção desse domínio.

Criar indice no PDF

Possibilidade de link de cenários

Eu quero fazer o seguinte dentro da descrição de um cenário, citar o nome de outro cenário e que o pirilampo crie um link, e quando eu clicar ele leve para o outro cenário ou que quando eu passe o mouse no link do cenário ele abra um hint apresentando o conteúdo