Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: text values: describe which combinations of gui_element and encoding are desirable (DEV-1521) #259

Merged
merged 3 commits into from Nov 23, 2022
Merged

docs: text values: describe which combinations of gui_element and encoding are desirable (DEV-1521) #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4e8141
edit
jnussbaum Nov 23, 2022
7b6c5bb
Update docs/dsp-tools-xmlupload.md
jnussbaum Nov 23, 2022
e070f41
Merge branch 'main' into wip/dev-1521-docs-gui_element-encoding
jnussbaum Nov 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/dsp-tools-create-ontologies.md
View file
Open in desktop
Expand Up @@ -530,17 +530,17 @@ for more information.

*gui_elements / gui_attributes*:

- `SimpleText`: A simple text entry box (one line only)
- `SimpleText`: one-line text entry box (for text **without** markup)
- *gui_attributes*:
- `maxlength=integer` (optional): maximal length (number of characters accepted)
- `size=integer` (optional): size (width) of widget
- `Textarea`: A multiline text entry box
- `Textarea`: multiline text entry box (for text **without** markup)
- *gui_attributes*:
- `cols=integer` (optional): number of columns of the textarea
- `rows=integer` (optional): number of rows of the textarea
- `width=percent` (optional): width of the textarea on the screen
- `wrap=soft|hard` (optional): wrapping of text
- `Richtext`: A rich-text editor.
- `Richtext`: multiline rich-text editor (for text **with** markup)
- *gui_attributes*: No attributes

Example:
Expand Down
34 changes: 18 additions & 16 deletions docs/dsp-tools-xmlupload.md
View file
Open in desktop
Expand Up @@ -676,34 +676,36 @@ Attributes:

The `<text>` element has the following attributes:

- `encoding`: either "utf8" or "xml" (required)
- `encoding` (required)
- `utf8`: simple text without markup
- `xml`: complex text with markup. It must follow the XML format as defined by the
[DSP standard mapping](https://docs.dasch.swiss/latest/DSP-API/03-apis/api-v2/xml-to-standoff-mapping/).
- `permissions`: Permission ID (optional, but if omitted, users who are lower than a `ProjectAdmin` have no permissions at all, not even view rights)
- `permissions`: Permission ID (optional, but if omitted, users who are lower than a `ProjectAdmin` have no permissions
at all, not even view rights)
- `comment`: a comment for this specific value (optional)

Within a text property, multiple simple (UTF8) and complex (XML) text values may be mixed.
Both simple and complex text values can be used inside all `gui_element`s that are defined in an ontology (`SimpleText`,
`Richtext`, `Textarea`, see [here](dsp-tools-create-ontologies.md#textvalue)). But typically, you would use UTF8 in a
`SimpleText`, and XML in `Richtext` or `Textarea`.
For the possible combinations of `encoding` with the `gui_element` [defined in the ontology](dsp-tools-create-ontologies.md#textvalue),
see the table:

| `gui_element` (JSON ontology) | `encoding` (XML data) | How DSP-APP renders the whitespaces |
|-------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------|
| `SimpleText` | `utf8` | Pretty-print whitespaces and newlines from the XML are taken into the text field as they are. |
| `Textarea` | `utf8` | Pretty-print whitespaces and newlines from the XML are taken into the text field as they are. |
| `Richtext` | `xml` | Pretty-print whitespaces and newlines from the XML are removed. If you want a newline in the text field, use `<br />` instead. |

Example of a public simple text and a hidden complex text:
Example of a public and a hidden text:
```xml
<text-prop name=":hasComment">
<text encoding="utf8" permissions="prop-default">Probe bei "Wimberger". Lokal in Wien?</text>
<text-prop name=":hasDescription">
<text encoding="xml" permissions="prop-default">Probe bei "Wimberger". Lokal in Wien?</text>
<text encoding="xml">
<strong>Bold text</strong> and a <a class="salsah-link" href="IRI:obj_0003:IRI">link to an ID</a>
and a <a class="salsah-link" href="http://rdfh.ch/4123/nyOODvYySV2nJ5RWRdmOdQ">link to an IRI</a>
<strong>Bold text</strong> and a <a class="salsah-link" href="IRI:obj_0003:IRI">link to an ID</a>.<br/>
And a <a class="salsah-link" href="http://rdfh.ch/4123/nyOODvYySV2nJ5RWRdmOdQ">link to an IRI</a>.
</text>
</text-prop>
```

The complex text above contains a link to the resource `obj_0003`, which is defined in the same XML file.
It also contains a link to the resource `http://rdfh.ch/4123/nyOODvYySV2nJ5RWRdmOdQ`, which already exists on the DSP server.

For simple texts, it is not advised to add XML-"pretty-print" whitespaces or line breaks, because they will be taken
into the text field as they are.
The second text above contains a link to the resource `obj_0003`, which is defined in the same XML file. It also
contains a link to the resource `http://rdfh.ch/4123/nyOODvYySV2nJ5RWRdmOdQ`, which already exists on the DSP server.


### &lt;time-prop&gt;
Expand Down