Skip to content

Commit

Permalink
Update example
Browse files Browse the repository at this point in the history
  • Loading branch information
guerler committed Oct 30, 2024
1 parent b1bc6e3 commit 76ed69d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
11 changes: 7 additions & 4 deletions docs/content/xml-introduction.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Visualization XML Wrapper

Galaxy Visualizations are configured using XML files. The files contain Visualization specific attributes such as the `name`, `description` and optionally an associated `logo`.
Galaxy Visualizations are configured using XML files. The files contain Visualization specific attributes such as the `name`, `description` and the associated npm package details.

```md
<visualization name="Test Environment" logo="galaxy-charts.svg">
<description>Welcome to Galaxy Charts.</description>
...
<visualization name="MY_VISUALIZATION">
<description>MY_DESCRIPTION</description>
<requirements>
<requirement type="npm" version="MY_NPM_PACKAGE_VERSION" package="MY_NPM_PACKAGE_NAME"/>
</requirements>
<entry_point entry_point_type="script" src="dist/index.js" css="dist/index.css" />
</visualization>
```
8 changes: 6 additions & 2 deletions public/galaxy-charts.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE visualization SYSTEM "../../visualization.dtd">
<visualization name="Test Environment">
<description>Welcome to Galaxy Charts.</description>
<visualization name="MY_VISUALIZATION">
<description>MY_DESCRIPTION</description>
<requirements>
<requirement type="npm" version="MY_NPM_PACKAGE_VERSION" package="MY_NPM_PACKAGE_NAME"/>
</requirements>
<entry_point entry_point_type="script" src="dist/index.js" css="dist/index.css" />
<specs>
<type>spec_type</type>
</specs>
Expand Down

0 comments on commit 76ed69d

Please sign in to comment.