Skip to content

Commit

Permalink
Change default config
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfgangmm committed Dec 8, 2020
1 parent cc59801 commit 02465a0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Snippet | Shortcut (Mac/other)

### TEI Publisher instance

The _teipublisher.endpoint_ configuration property defines the HTTP or HTTPS URL the extension will communicate with to retrieve HTML previews. For example, to use your local TEI Publisher instance, set this to `http://localhost:8080/exist/apps/tei-publisher`.
The _teipublisher.endpoint_ configuration property defines the HTTP or HTTPS URL the extension will communicate with to retrieve HTML previews. By default this points to a public TEI Publisher instance available on `https://teipublisher.com/exist/apps/tei-publisher`.

### API Connectors

Expand Down Expand Up @@ -86,7 +86,17 @@ The `label` property provides the text to be shown to the user in the dropdown.

## Recommended Extensions

For proper XML editing support, we recommend installing either the [Scholary XML](https://marketplace.visualstudio.com/items?itemName=raffazizzi.sxml) or the [XML Language Support by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml) extension. Scholary XML is more lightweight and has nice features, but it requires a `<?xml-model?>` processing instruction in every file. The Red Hat extension support catalog files, which allow you to associate an XML namespace with a certain schema.
For proper XML editing support, we recommend installing either the [Scholary XML](https://marketplace.visualstudio.com/items?itemName=raffazizzi.sxml) or the [XML Language Support by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml) extension. Scholary XML is more lightweight and has nice features, but it requires a `<?xml-model?>` processing instruction in every file. The Red Hat extension support catalog files, which allow you to associate an XML namespace with a certain schema. For example, a simple `catalog.xml` for all TEI files may look as follows:

```xml
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
<uri
name="http://www.tei-c.org/ns/1.0"
uri="https://tei-c.org/Vault/P5/current/xml/tei/custom/schema/xsd/tei_all.xsd" />
</catalog>
```

Store this somewhere and change the `xml.catalogs` setting in vscode to point to it.

Other extensions you might find useful:

Expand Down
5 changes: 3 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/eeditiones/tei-publisher-vscode.git"
},
"publisher": "e-editiones",
"version": "0.1.0",
"version": "0.2.0",
"license": "GPL-3.0-or-later",
"engines": {
"vscode": "^1.51.0"
Expand Down Expand Up @@ -92,7 +92,7 @@
"teipublisher.endpoint": {
"type": "string",
"format": "uri",
"default": "http://localhost:8080/exist/apps/kb",
"default": "https://teipublisher.com/exist/apps/tei-publisher",
"description": "Defines the TEI Publisher instance (or an application generated from TEI Publisher) which will be used to preview TEI"
},
"teipublisher.apiList": {
Expand Down

0 comments on commit 02465a0

Please sign in to comment.