Skip to content

Commit

Permalink
📝 melhoria documentação
Browse files Browse the repository at this point in the history
  • Loading branch information
bjverde committed Apr 21, 2020
1 parent d6c2e06 commit b0be2e9
Show file tree
Hide file tree
Showing 3 changed files with 155 additions and 103 deletions.
111 changes: 8 additions & 103 deletions documents/framework_puro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,112 +4,17 @@ Temas para apresentação do [Adianti FrameWork 7.0](https://www.adianti.com.br/
## Bootstrap
Temas baseado na aparecem padrão do Bootstrap
* [Boostrap Theme_formdin](framework_puro/bootstrap_theme_formdin.md), tema com menu horizontal e baseado no tema classico do FormDin 4
* [theme3_v2](framework_puro/bootstrap_theme3_v2.md)
* [theme3_v5](framework_puro/bootstrap_theme3_v5.md)
* [theme3_v2](framework_puro/bootstrap_theme3_v2.md)
* [theme3_v3](framework_puro/bootstrap_theme3_v3.md) - Informações dinâmica do arquivo `application.ini`
* [theme3_v4](framework_puro/bootstrap_theme3_v4.md) - V3 atulizado para Adianti 7.1 e favicon.png
* [theme3_v5](framework_puro/bootstrap_theme3_v5.md) - Ocupando toda tela

## Material
Temas baseado na aparecem Material da google, são temas Bootstrap porém com o lock en feel diferente.


# OLD
* Theme3_v2 - melhorando acessabilidade e removendo dependencias externas.
* Theme3_v3 - V2 + informações dinamicas configuradas no arquivo `application.ini`
* [theme3_v4](framework_puro.md#theme3_v4)
* [theme3_v5](framework_puro.md#theme3_v5)

* [theme4_v2](framework_puro.md#theme4_v2)

# Theme3_v2
Tema baseado no theme3 do Adianti FrameWork 7.0. *Quais são as diferenças do theme 3 do Adianti 7.0 ?*. Abaixo as lista dediferenças:

* retirada do `maximum-scale=1, user-scalable=no` da `viewport` no arquivo layout.html. Sem esse parâmetro no celular o usuário consegue fazer o movimento de pinça para aumentar ou diminuir o zoom , o que aumenta acessebilidade para os usuários.
* Inclusão dos arquivos das fontes MaterialIcons e source-code-pro assim não precisa de internet para baixar as fontes.

## Origem das fontes MaterialIcons
* MaterialIcons - https://github.com/google/material-design-icons/releases
* source-code-pro - https://github.com/adobe-fonts/source-code-pro
* Artigo do StackOverFlow que ajudou corrigir os temas - https://stackoverflow.com/questions/37270835/how-to-host-material-icons-offline


## Para usar
Edite o arquivo `<SISTEMA>/app/lib/menu/AdiantiMenuBuilder.php` incluido as linhas abaixo. Depois altere no arquivo `<SISTEMA>/app/config/application.ini` informando o nome do Tema.

```php
case 'theme3_v2':
ob_start();
$xml = new SimpleXMLElement(file_get_contents($file));
$menu = new TMenu($xml, null, 1, 'treeview-menu', 'treeview', '');
$menu->class = 'sidebar-menu';
$menu->id = 'side-menu';
$menu->show();
$menu_string = ob_get_clean();
return $menu_string;
break;
```

# Theme3_v3
Tema baseado no [theme3_v2](framework_puro.md#theme3_v2) para Adianti FrameWork 7.0. *Quais são as diferenças do theme 3 do Adianti 7.0 ?*. Abaixo as lista dediferenças:

* Todos os itens do [theme3_v2](framework_puro.md#theme3_v2)
* Inclusão do nome do sistema de forma customizada no `application.ini`.
* Inclusão da versão do sistema de forma customizada no `application.ini`.
* Title do HEAD alterado conforme novos parametos `head_title` e `version` no `application.ini`.
Ideia geral um Tema BootStrap
![theme_bootstrap](img/theme_bootstrap.png)

Locais das alterações
![Theme3_v3](img/theme3_v3.png)

## Para usar

### Etapa 01
Editar o arquivo `<SISTEMA>/app/config/application.ini`

1. Alterar para `theme = theme3_v3`
1. incluindo as informações abaixo :
```ini
[system]
version = 2.0.0
head_title = Sistema de Exemplo
logo-lg = Exemplo
logo-link-class = SystemAboutView
```
### Etapa 02
Edite o arquivo `<SISTEMA>/app/lib/menu/AdiantiMenuBuilder.php` incluido as linhas abaixo:
```php
case 'theme3_v3':
ob_start();
$xml = new SimpleXMLElement(file_get_contents($file));
$menu = new TMenu($xml, null, 1, 'treeview-menu', 'treeview', '');
$menu->class = 'sidebar-menu';
$menu->id = 'side-menu';
$menu->show();
$menu_string = ob_get_clean();
return $menu_string;
break;
```

### Etapa 03
Edite o arquivo `<SISTEMA>/index.php` incluido as linhas abaixo:

```php
$system_version = $ini['system']['version'];
$head_title = $ini['system']['head_title'].' - v'.$system_version;
$content = str_replace('{head_title}', $head_title, $content);
$content = str_replace('{system_version}', $system_version, $content);
$content = str_replace('{logo-mini}', $ini['general']['application'], $content);
$content = str_replace('{logo-lg}', $ini['system']['logo-lg'], $content);
$content = str_replace('{logo-link-class}', $ini['system']['logo-link-class'], $content);
```

# Theme3_v4
Tema baseado no theme3 do Adianti FrameWork 7.1. Tem todas as melhorias e modificações do [theme3_v3](framework_puro.md#theme3_v3) com as inclusões:

* Arquivo de `libraries.html` conforme Adianti 7.1
* Arquivo favicon.png

# Theme3_v5
Tema baseado no theme3 do Adianti FrameWork 7.1. Tem todas as melhorias e modificações do [theme3_v4](framework_puro.md#theme3_v4) com as inclusões:

* Arquivo de `layout.html` alterado removendo `layout-boxed` para ocupar toda area
## Material
Temas baseado na aparecem Material da google, são temas Bootstrap porém com o lock en feel diferente.


# Theme4_v2
Expand Down
73 changes: 73 additions & 0 deletions documents/framework_puro/bootstrap_theme3_v4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Temas para o FrameWork Puro
Temas para apresentação do [Adianti FrameWork 7.1](https://www.adianti.com.br/) baseado na aparecem padrão d BootStrap

* [<- voltar para lista de temas BootStrap](../framework_puro.md)
* [<- voltar para index](../../README.md)


# theme3_v3
Tema baseado no [theme3_v3](bootstrap_theme3_v3.md) para Adianti FrameWork 7.1


## *Quais são as diferenças do theme 3 do Adianti ?*.
* retirada do `maximum-scale=1, user-scalable=no` da `viewport` no arquivo layout.html. Sem esse parâmetro no celular o usuário consegue fazer o movimento de pinça para aumentar ou diminuir o zoom , o que aumenta acessebilidade para os usuários.
* Inclusão dos arquivos das fontes MaterialIcons e source-code-pro assim não precisa de internet para baixar as fontes.
* Inclusão do nome do sistema de forma customizada no `application.ini`.
* Inclusão da versão do sistema de forma customizada no `application.ini`.
* Title do HEAD alterado conforme novos parametos `head_title` e `version` no `application.ini`.
* Arquivo de `libraries.html` conforme Adianti 7.1
* Arquivo favicon.png

## Telas e suas alterações
Locais das alterações
![Theme3_v3](img/theme3_v3.png)

### Origem das fontes MaterialIcons
* MaterialIcons - https://github.com/google/material-design-icons/releases
* source-code-pro - https://github.com/adobe-fonts/source-code-pro
* Artigo do StackOverFlow que ajudou corrigir os temas - https://stackoverflow.com/questions/37270835/how-to-host-material-icons-offline



## Para usar

### Parte 01
Editar o arquivo `<SISTEMA>/app/config/application.ini` incluindo as informações abaixo :
```ini
[system]
version = 2.0.0
head_title = Sistema de Exemplo
logo-lg = Exemplo
logo-link-class = 'index.php?class=SystemAboutView'
login-link = http://wwww.meusite.com.br
```

### Parte 02

Edite o arquivo `<SISTEMA>/app/lib/menu/AdiantiMenuBuilder.php` incluido as linhas abaixo. Depois altere no arquivo `<SISTEMA>/app/config/application.ini` informando o nome do Tema.

```php
case 'theme3_v4':
ob_start();
$xml = new SimpleXMLElement(file_get_contents($file));
$menu = new TMenu($xml, null, 1, 'treeview-menu', 'treeview', '');
$menu->class = 'sidebar-menu';
$menu->id = 'side-menu';
$menu->show();
$menu_string = ob_get_clean();
return $menu_string;
break;
```

### Parte 03
Edite o arquivo `<SISTEMA>/index.php` incluido as linhas abaixo:

```php
$system_version = $ini['system']['version'];
$head_title = $ini['system']['head_title'].' - v'.$system_version;
$content = str_replace('{head_title}', $head_title, $content);
$content = str_replace('{system_version}', $system_version, $content);
$content = str_replace('{logo-mini}', $ini['general']['application'], $content);
$content = str_replace('{logo-lg}', $ini['system']['logo-lg'], $content);
$content = str_replace('{logo-link-class}', $ini['system']['logo-link-class'], $content);
```
74 changes: 74 additions & 0 deletions documents/framework_puro/bootstrap_theme3_v5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Temas para o FrameWork Puro
Temas para apresentação do [Adianti FrameWork 7.1](https://www.adianti.com.br/) baseado na aparecem padrão d BootStrap

* [<- voltar para lista de temas BootStrap](../framework_puro.md)
* [<- voltar para index](../../README.md)


# theme3_v3
Tema baseado no [theme3_v4](bootstrap_theme3_v4.md) para Adianti FrameWork 7.1


## *Quais são as diferenças do theme 3 do Adianti ?*.
* retirada do `maximum-scale=1, user-scalable=no` da `viewport` no arquivo layout.html. Sem esse parâmetro no celular o usuário consegue fazer o movimento de pinça para aumentar ou diminuir o zoom , o que aumenta acessebilidade para os usuários.
* Inclusão dos arquivos das fontes MaterialIcons e source-code-pro assim não precisa de internet para baixar as fontes.
* Inclusão do nome do sistema de forma customizada no `application.ini`.
* Inclusão da versão do sistema de forma customizada no `application.ini`.
* Title do HEAD alterado conforme novos parametos `head_title` e `version` no `application.ini`.
* Arquivo de `libraries.html` conforme Adianti 7.1
* Arquivo favicon.png
* Arquivo de `layout.html` alterado removendo `layout-boxed` para ocupar toda area

## Telas e suas alterações
Locais das alterações
![Theme3_v3](img/theme3_v3.png)

### Origem das fontes MaterialIcons
* MaterialIcons - https://github.com/google/material-design-icons/releases
* source-code-pro - https://github.com/adobe-fonts/source-code-pro
* Artigo do StackOverFlow que ajudou corrigir os temas - https://stackoverflow.com/questions/37270835/how-to-host-material-icons-offline



## Para usar

### Parte 01
Editar o arquivo `<SISTEMA>/app/config/application.ini` incluindo as informações abaixo :
```ini
[system]
version = 2.0.0
head_title = Sistema de Exemplo
logo-lg = Exemplo
logo-link-class = 'index.php?class=SystemAboutView'
login-link = http://wwww.meusite.com.br
```

### Parte 02

Edite o arquivo `<SISTEMA>/app/lib/menu/AdiantiMenuBuilder.php` incluido as linhas abaixo. Depois altere no arquivo `<SISTEMA>/app/config/application.ini` informando o nome do Tema.

```php
case 'theme3_v5':
ob_start();
$xml = new SimpleXMLElement(file_get_contents($file));
$menu = new TMenu($xml, null, 1, 'treeview-menu', 'treeview', '');
$menu->class = 'sidebar-menu';
$menu->id = 'side-menu';
$menu->show();
$menu_string = ob_get_clean();
return $menu_string;
break;
```

### Parte 03
Edite o arquivo `<SISTEMA>/index.php` incluido as linhas abaixo:

```php
$system_version = $ini['system']['version'];
$head_title = $ini['system']['head_title'].' - v'.$system_version;
$content = str_replace('{head_title}', $head_title, $content);
$content = str_replace('{system_version}', $system_version, $content);
$content = str_replace('{logo-mini}', $ini['general']['application'], $content);
$content = str_replace('{logo-lg}', $ini['system']['logo-lg'], $content);
$content = str_replace('{logo-link-class}', $ini['system']['logo-link-class'], $content);
```

0 comments on commit b0be2e9

Please sign in to comment.