Skip to content

Commit

Permalink
Update upload_forms.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@miklosban
miklosban committed Mar 8, 2020
1 parent 972bce2 commit 48c08bb
Showing 1 changed file with 111 additions and 36 deletions.
147 changes: 111 additions & 36 deletions official_docs/en/upload_forms.rst
View file
@@ -1,7 +1,10 @@
.. _new-upload-form:

Create new data upload form
---------------------------
===========================

Form header definition
----------------------

Destination table
.................
Expand All @@ -15,7 +18,15 @@ This name can be multilingual, if you use the ''str_'' tag. See more about trans

Form access
...........
Define who can see / use the form: anyone, logged in users, specific group.
Define who can see / use the form: anyone (public), logged in users, specific group (specify groups in the group-access below).

Group access
............
If form access specified as "group-access" here choose the groups.

Data access
...........
Uploaded data will only be available to the specified groups here. By default, data can be read and edited by the uploader.

Form type
.........
Expand All @@ -27,59 +38,77 @@ Form description
................
A shorter or longer description of the form. This can be used to give instructions for uploaders.

Form columns
............
Form SRID
.........
Any kind of spatial reference can be coosed for the uploaded which is available in https://spatialreference.org/. The default srid is "epsg:4326 (WGS84)". If a list of sptial references specified here, uploaders can choose only from these options.
Use the following format for define a list of available references: "4326:wgs84,23700:eov". It is a comma separated list of epsg reference id and visible labels.

- included?: If checked, the column will appear on the form.

- column order: It is a small empty input box (by default) next to "included" option.

- obligatory: If yes (burgundy), then the form cannot be submitted without filling in the column cell.

Form column definitions
-----------------------

Included
........
If checked, the column will appear on the form.

- column:
- The visible name of the column. It can be edited to make it unique to a form.
- The original name of the column.
Column order
............
It is a small empty input box (by default) next to "included" option.

Column
......
There are two strings here: The visible name of the column (it can be edited to make it unique to a form), and the original name of the column.

- description: Short description of the field.
Obligatory
..........
Three options are avilable here: yes, no, soft-error
- Yes (colour: burgundy), then the form cannot be submitted without filling in the column cell.
- No (colour: gray), then form can be subbmitted with empty cell in the rows with this column.
- Soft-error (colour: pink), allows empty cells or difference from restrictions but uploader should confirm this for every affected lines.


- type:
Column description
..................
Short description of the field.

- text: arbitrary text - minimum and maximum lengths can be specified.
Column type
...........
- text: arbitrary text - minimum and maximum lengths can be specified.

- numeric: arbitrary number - minimum and maximum lengths can be specified
- numeric: arbitrary number - minimum and maximum lengths can be specified

- list: legördülő lista a megadott vesszővel elválasztott értékekből. A legördülő lista kiírt elemei és valós értékei név:érték formátumban megadhatók. A "név" amennyiben "str\_" előtaggal kezdődik, akkor automatikusan lefordul a kiválasztott nyelvi változatra, ha az definiálva van. A "true" és "false" szavak str_true és str_false fordítás szerint fordulnak le.
- list: legördülő lista a megadott vesszővel elválasztott értékekből. A legördülő lista kiírt elemei és valós értékei név:érték formátumban megadhatók. A "név" amennyiben "str\_" előtaggal kezdődik, akkor automatikusan lefordul a kiválasztott nyelvi változatra, ha az definiálva van. A "true" és "false" szavak str_true és str_false fordítás szerint fordulnak le.
Megadható több címke egy értékhez amikből webes űrlapesetén az első jelenik meg, file feltöltésnél pedig a fájl cella értékéből bármelyik cimke vagy az érték helyes egyezést ad. A cimkéket # karakterekkel tagolva kell megadni. Pl: female#tojó:f,male#hím#him:m,juvenil#fiatal:j,adult#öreg:a

Ez esetben az "f" érték lehetséges cimkéi a "female", "tojo" és "tojó" szavak

- true-false: boolen false/true value. Az érték sorrendje a lista definíciós mezőben szabályozható. pl: "false,true"
- true-false: boolen false/true value. Az érték sorrendje a lista definíciós mezőben szabályozható. pl: "false,true"

- date: tetszőleges karakterrel elválasztva év hónap nap sorrendben. Adatbázisban date típusként tárolva.
- date: tetszőleges karakterrel elválasztva év hónap nap sorrendben. Adatbázisban date típusként tárolva.

- date and time: üres karektert követően a dátum után óra:perc:másodperc formátumban. Ha hiányzik a másodperc a program automatikusan 00-nak tekinti, de figyelmeztet az elfogadására. Ha hiányzik a perc a program automatikusan 00-nak tekinti, de figyelmeztet az elfogadására. Adatbázisban datetime típusként tárolva.
- date and time: üres karektert követően a dátum után óra:perc:másodperc formátumban. Ha hiányzik a másodperc a program automatikusan 00-nak tekinti, de figyelmeztet az elfogadására. Ha hiányzik a perc a program automatikusan 00-nak tekinti, de figyelmeztet az elfogadására. Adatbázisban datetime típusként tárolva.

- time: (timetominutes): hours:minutes formátum amit a program egész szám értékké számol át. Adatbázisban egész számként tárolva.
- time: (timetominutes): hours:minutes formátum amit a program egész szám értékké számol át. Adatbázisban egész számként tárolva.

- time: hours:minutes. As time type in the database.
- time: hours:minutes. As time type in the database.

- time interval: (timeinterval) Pl: 2014-02-25 12:00:00 2014-02-25 13:00:00. Adatbázisban timeinterval típusként tárolva.
- time interval: (timeinterval) Pl: 2014-02-25 12:00:00 2014-02-25 13:00:00. Adatbázisban timeinterval típusként tárolva.

- autocomplete: a lista_definíció mezőben megadott sql tábla oszlopából autocomplete listát készít. A szintaxis táblanév.oszlop. A táblát a public sémában keresi a program a gisdata adatbázisban.
- autocomplete: a lista_definíció mezőben megadott sql tábla oszlopából autocomplete listát készít. A szintaxis táblanév.oszlop. A táblát a public sémában keresi a program a gisdata adatbázisban.

- autocompletelist: Similar to the autocomplete field, just here it is possible autocompleting multiple values into a single field
- autocompletelist: Similar to the autocomplete field, just here it is possible autocompleting multiple values into a single field

- photo id: fotó modul bekapcsolása esetén ide írja be a feltöltött fotó azonosítókat a program.
- photo id: fotó modul bekapcsolása esetén ide írja be a feltöltött fotó azonosítókat a program.

- geometria: point: WKT POINT()
- geometria: point: WKT POINT()

- geometria: line: WKT LINE()
- geometria: line: WKT LINE()

- geometria: polygon: WKT POLYGON()
- geometria: polygon: WKT POLYGON()

- geometria: any: WKT
- geometria: any: WKT

- colour rings: színesgyűrű kombináció megadására ad lehetőséget, ahol piros, rózsaszín, zöld, világos zöld, narancs, sárga, kék, világos kék, fehér, fekete, barna, lila, ibolya és fémgyűrű kombinációkat lehet létrehozni. A szögletes zárójelben levő rész a különböző láb-részeken megadandó maximális gyűrűk számát kódolja, az ezt követő rész a lehetséges színek egyénileg megadott cimkéi. Pl: [XX],Blue:B, red:R, green:G
- colour rings: színesgyűrű kombináció megadására ad lehetőséget, ahol piros, rózsaszín, zöld, világos zöld, narancs, sárga, kék, világos kék, fehér, fekete, barna, lila, ibolya és fémgyűrű kombinációkat lehet létrehozni. A szögletes zárójelben levő rész a különböző láb-részeken megadandó maximális gyűrűk számát kódolja, az ezt követő rész a lehetséges színek egyénileg megadott cimkéi. Pl: [XX],Blue:B, red:R, green:G
Megengedett színek és jelölések:
R = 'red'
P = 'pink'
Expand All @@ -97,14 +126,18 @@ Form columns
M = 'silver'


- input control: checks the number of characters entered
Input control
.............
checks the number of characters entered
- no check
- min - max
- regular expression
- spatial
- custom check

- list definítion: lista típusnál vesszővel elválasztott lista megadaása. Autocoplete típusnál adatbázis és oszlop megadása "SELECT:" előtaggal. Pl.: SELECT:my_project.species, igaz/hamis típusnál sorrend megadása. Bármilyen listánál ha a kezdő vagy záró karakter vessző, üres elemmel kezdődik vagy zárul a lista. A SELECT típusú listázásnál meg lehet adni egy másik oszlopot ami a listában megjelenő értékeket adja. Pl: SELECT:my_project.species:national_name ami esetben a national_name oszlop értékei jelennek meg a listában, de a hozzá tartozó species elemek lesznek az értékek.
List definítion
...............
lista típusnál vesszővel elválasztott lista megadaása. Autocoplete típusnál adatbázis és oszlop megadása "SELECT:" előtaggal. Pl.: SELECT:my_project.species, igaz/hamis típusnál sorrend megadása. Bármilyen listánál ha a kezdő vagy záró karakter vessző, üres elemmel kezdődik vagy zárul a lista. A SELECT típusú listázásnál meg lehet adni egy másik oszlopot ami a listában megjelenő értékeket adja. Pl: SELECT:my_project.species:national_name ami esetben a national_name oszlop értékei jelennek meg a listában, de a hozzá tartozó species elemek lesznek az értékek.
{
"list": {
"val1": ["label1", "label2"]
Expand All @@ -125,15 +158,57 @@ Form columns
"selected":["val1"],
}

- default values: Uniform value for each line of the form. You can define a fill value, an optional value, and a fixed value.
Default values
..............
You can predefine a value for a field. There are several dynamic predefined values:
- _autocomplete
- _input
- _list
- _geometry
- _login_name
- _email
- _boolean
- _attacment
- _datum
- _auto_geometry

Ha üres input mezőt szeretnénk, akkor _input értéket kell megadni, ha választó listát szeretnénk kapni a _list értéket kell megadni (a lista fefiníció elemeit tölti be), ha geometra választást, akkor _geometry értéket, az _datum pedig a dátum választó mezőt eredményez.

- api-params:
relations: Megadható hogy a táblából egy más oszlop értéke esetén az adott oszlopba bevitt értéket hogyan ellenőrízze vagy módosítsa. pl.: weight oszlop esetén ha a sex oszlop tartalma female akkor az értékek min 20 és max 30 numerikus értket vehetnek fel (sex=female) {minmax=20:30}
Field display options
.....................

- sticky
This has real significance in the mobile application. If this option is selected, the field will retain its value when new rows start.
- hidden
Field not displayed.
- read only
Field value cannot be modified.
- list element as buttons
List element will be diplayed as buttons. Pictures can be used in the buttons.
Pictures should be defined in for all list elements in the list definition like in this example:
If the list has the following values: animals, plants, mushrooms, bats

"pictures": {
"animals": "http://....png",
"plants": "http://....png",
"mushrooms": "http://....png",
"bats": "http://....png"
}
- once
Field displayed only once in observation-list in mobile app at the end of observation
(This option will used in the web form to pull out a field from the table over the table. Currenty, using the default value option do this for the web form)

Column relations
................
Megadható hogy a táblából egy más oszlop értéke esetén az adott oszlopba bevitt értéket hogyan ellenőrízze vagy módosítsa. pl.: weight oszlop esetén ha a sex oszlop tartalma female akkor az értékek min 20 és max 30 numerikus értket vehetnek fel (sex=female) {minmax=20:30}

Check the contents of columns depending on the contents of other columns

Pseudo columns
..............
Columns from other upload-forms can be added here with the following format: form-name:column1,column2,columnN
The listed column will be appear after this column. The data entered in the pseudo-columns will be uploaded using the the other form's definition. Using this feature let uploaders to upload data into two tables at once.


Relations pseudolanguage definition
-----------------------------------
Expand Down

0 comments on commit 48c08bb

Please sign in to comment.