Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagodp committed Jun 19, 2019
1 parent 07577e2 commit 152a3a0
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 27 deletions.
41 changes: 28 additions & 13 deletions docs/en/language.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ Translations: [Português](../pt/language.md) 🌎
- [Scenario](#Scenario)
- [Constants](#Constants)
- [User Interface Element](#User-Interface-Element)
- [Property `id`](#Property-id)
- [Property `type`](#Property-type)
- [Property `editable`](#Property-editable)
- [Property `data type`](#Property-data-type)
- [Property `value`](#Property-value)
- [Property `minimum value`](#Property-minimum-value)
- [Property `maximum value`](#Property-maximum-value)
- [Property `minimum length`](#Property-minimum-length)
- [Property `maximum length`](#Property-maximum-length)
- [Property `format`](#Property-format)
- [Property `required`](#Property-required)
- [Examples of UI Elements](#Examples-of-UI-Elements)
- [Table](#Table)
- [Database](#Database)
Expand Down Expand Up @@ -260,7 +271,7 @@ Allowed properties:
- `format`
- `required`, defaults to `false`

Property `id`:
#### Property `id`
- Example: `- id is "name"`
- Default value is the element name in camel case and without spaces, *e.g.*, `"Some Name"` becomes `"someName"`
- Value must be declared between quotes (`"`)
Expand All @@ -274,7 +285,7 @@ Property `id`:
- Multiple identifiers are denoted by `id in [ "<value1>", "<value2>", ... ]` **Yet not supported by the tool**
- Example: `id in [ "birthDate", "~birthDate" ]`

Property `type`:
#### Property `type`
- Example: `- type is button`
- Default value is `textbox`
- Does not need quotes (`"`)
Expand Down Expand Up @@ -306,7 +317,7 @@ Property `type`:
- `unordered list` or `ul`
- `url` or `address` or `ip` or `site`

Property `editable`:
#### Property `editable`
- Example: `- editable is true`
- Allowed values are `true` and `false`
- Does not need quotes (`"`)
Expand All @@ -325,7 +336,7 @@ Property `editable`:
- `maximum value`
- `value`

Property `data type`:
#### Property `data type`
- Example: `- data type is double`
- Does not need quotes (`"`)
- Allowed types are:
Expand All @@ -337,7 +348,7 @@ Property `data type`:
- `datetime`
- Precision of `double` values is inferred from declared rules, *e.g.*, `12.50` makes Concordia to know that the precision is `2`

Property `value`:
#### Property `value`
- Accepted values:
- [Value](#value)
- [Number](#number)
Expand All @@ -357,7 +368,7 @@ Property `value`:
- `- value is not in "SELECT ..."`
- `- value is not equal to {Other UI Element}`

Property `minimum value`:
#### Property `minimum value`
- Accepted values:
- [Number](#number)
- [Constant](#constants)
Expand All @@ -371,7 +382,7 @@ Property `minimum value`:
- `- minimum value comes from "SELECT ..."`
- `- minimum value is equal to {Other UI Element}`

Property `maximum value`:
#### Property `maximum value`
- Same syntax as `minimum length`
- Examples:
- `- maximum value is 5`
Expand All @@ -381,7 +392,7 @@ Property `maximum value`:
- `- maximum value is equal to {Other UI Element}`


Property `minimum length`:
#### Property `minimum length`
- Same syntax as `minimum value`
- Examples:
- `- minimum length is 5`
Expand All @@ -390,7 +401,7 @@ Property `minimum length`:
- `- minimum length comes from "SELECT ..."`
- `- minimum length is equal to {Other UI Element}`

Property `maximum length`:
#### Property `maximum length`
- Same syntax as `minimum length`
- Examples:
- `- maximum length is 50`
Expand All @@ -400,7 +411,7 @@ Property `maximum length`:
- `- maximum length is equal to {Other UI Element}`


Property `format`:
#### Property `format`
- Accepted values:
- [Value](#value)
- [Constant](#constants)
Expand All @@ -410,11 +421,15 @@ Property `format`:
- `- format is "/^[0-9]{2}\.[0-9]{3}\-[0-9]{3}$/"`
- `- format is [Some Constant with RegEx]`

Property `required`:
- Accepted values are `true` and `false`
- Default value is `false`
#### Property `required`
- Accepted values are `true` or `false`
- When not declared, the property assumes `false` (that is, not required)
- The value `true` is optional. For example, the following declaration is accepted as `true`:
- `- required`
- Examples:
- `- required`
- `- required is true`
- `- required is false`


#### Examples of UI Elements
Expand Down
43 changes: 29 additions & 14 deletions docs/pt/language.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@
- [Cenário](#Cen%C3%A1rio)
- [Constantes](#Constantes)
- [Elemento de Interface de Usuário](#Elemento-de-Interface-de-Usu%C3%A1rio)
- [Propriedade `id`](#Propriedade-id)
- [Propriedade `tipo`](#Propriedade-tipo)
- [Propriedade `editável`](#Propriedade-edit%C3%A1vel)
- [Propriedade `tipo de dado`:](#Propriedade-tipo-de-dado)
- [Propriedade `valor`](#Propriedade-valor)
- [Propriedade `valor mínimo`](#Propriedade-valor-m%C3%ADnimo)
- [Propriedade `valor máximo`](#Propriedade-valor-m%C3%A1ximo)
- [Propriedade `comprimento mínimo`](#Propriedade-comprimento-m%C3%ADnimo)
- [Propriedade `comprimento máximo`](#Propriedade-comprimento-m%C3%A1ximo)
- [Propriedade `formato`](#Propriedade-formato)
- [Propriedade `obrigatório`](#Propriedade-obrigat%C3%B3rio)
- [Exemplos de Elementos de IU](#Exemplos-de-Elementos-de-IU)
- [Tabela](#Tabela)
- [Banco de Dados](#Banco-de-Dados)
Expand Down Expand Up @@ -260,7 +271,7 @@ Propriedades permitidas:
- `formato`
- `obrigatório`, por *default* é `false`

Propriedade `id`:
#### Propriedade `id`
- Exemplo: `- id é "nome"`
- O valor *default* é o nome do elemento em *camel case* (primeira letra minúscula) e sem espaços, *e.g.*, `"Algum Nome"` se torna `"algumNome"`
- Valor deve ser declarado entre aspas (`"`)
Expand All @@ -273,7 +284,7 @@ Propriedade `id`:
- Múltiplos identificadores são denotados por `id em [ "<valor1>", "<valor2>", ... ]` **Ainda não suportada pela ferramenta**
- Exemplo: `id em [ "nascimento", "~nascimento" ]`

Propriedade `tipo`:
#### Propriedade `tipo`
- Exemplo: `- tipo é botão`
- O valor *default* é `caixa de texto`
- Valores não usam aspas (`"`)
Expand Down Expand Up @@ -305,7 +316,7 @@ Propriedade `tipo`:
- `título` ou `title`
- `url` ou `address` ou `ip` ou `site`

Propriedade `editável`:
#### Propriedade `editável`
- Exemplo: `- editável é true`
- Valores permitidos são `true` e `false`
- Valores não usam aspas (`"`)
Expand All @@ -324,7 +335,7 @@ Propriedade `editável`:
- `valor máximo`
- `valor`

Propriedade `tipo de dado`:
#### Propriedade `tipo de dado`:
- Exemplo: `- tipo de dado é double`
- Valores não usam aspas (`"`)
- Tipos permitidos são:
Expand All @@ -336,7 +347,7 @@ Propriedade `tipo de dado`:
- `datetime`
- Precisão de valores `double` são inferidas a partir da declaração, *e.g.*, `12.50` faz Concordia saber que a precisão é `2`

Propriedade `valor`:
#### Propriedade `valor`
- Valores aceitos:
- [Valor](#valor)
- [Número](#número)
Expand All @@ -356,7 +367,7 @@ Propriedade `valor`:
- `- valor não está em "SELECT ..."`
- `- valor não é igual a {Outro Elemento de IU}`

Propriedade `valor mínimo`:
#### Propriedade `valor mínimo`
- Valores aceitos:
- [Número](#número)
- [Constante](#constantes)
Expand All @@ -370,7 +381,7 @@ Propriedade `valor mínimo`:
- `- valor mínimo vem da consulta "SELECT ..."`
- `- valor mínimo é igual a {Outro Elemento de IU}`

Propriedade `valor máximo`:
#### Propriedade `valor máximo`
- Mesma sintaxe que `comprimento mínimo`
- Exemplos:
- `- valor máximo é 5`
Expand All @@ -380,7 +391,7 @@ Propriedade `valor máximo`:
- `- valor máximo é igual a {Outro Elemento de IU}`


Propriedade `comprimento mínimo`:
#### Propriedade `comprimento mínimo`
- Mesma sintaxe que `valor mínimo`
- Exemplos:
- `- comprimento mínimo é 5`
Expand All @@ -389,7 +400,7 @@ Propriedade `comprimento mínimo`:
- `- comprimento mínimo vem da consulta "SELECT ..."`
- `- comprimento mínimo é igual a {Outro Elemento de IU}`

Propriedade `comprimento máximo`:
#### Propriedade `comprimento máximo`
- Mesma sintaxe que `comprimento mínimo`
- Exemplos:
- `- comprimento máximo é 50`
Expand All @@ -399,7 +410,7 @@ Propriedade `comprimento máximo`:
- `- comprimento máximo é igual a {Outro Elemento de IU}`


Propriedade `formato`:
#### Propriedade `formato`
- Valores aceitos:
- [Valor](#valor)
- [Constant](#constantes)
Expand All @@ -409,11 +420,15 @@ Propriedade `formato`:
- `- formato é "/^[0-9]{2}\.[0-9]{3}\-[0-9]{3}$/"`
- `- formato é [Alguma Constante com Expressão Regular]`

Propriedade `obrigatório`:
- Valores aceitos são `true` e `false`
- O valor *default* é `false`
#### Propriedade `obrigatório`
- Valores aceitos são `verdadeiro` ou `falso` (e também `true` ou `false`)
- Quando não declarada, a propriedade assume o valor `falso` (ou seja, não obrigatório)
- O valor `verdadeiro` é opcional. Por exemplo, a seguinte declaração é aceita como `verdadeiro`:
- `- obrigatório`
- Exemplos:
- `- obrigatório é true`
- `- obrigatório`
- `- obrigatório é verdadeiro`
- `- obrigatório é falso`


#### Exemplos de Elementos de IU
Expand Down

0 comments on commit 152a3a0

Please sign in to comment.