Skip to content

Commit 0b11b2f

Browse files
committed
[docs] Add local view note
1 parent d6bc508 commit 0b11b2f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,22 @@ The Python installation features multiple convenience commandline scripts.
7979

8080
- `odmlconvert`: Converts odML files of previous file versions into the current one.
8181
- `odmltordf`: Converts odML files to the supported RDF version of odML.
82-
- `odmlview`: Render and browse local XML odML files in the webbrowser.
82+
- `odmlview`: Render and browse local XML odML files without stylesheet in the webbrowser.
8383

8484
All scripts provide detailed usage descriptions by adding the `help` flag to the command.
8585

8686
odmlconvert -h
8787
odmltordf -h
8888
odmlview -h
8989

90+
### Browsing odML files
91+
92+
odML XML files can be saved with an included XSL stylesheet for convenient local
93+
viewing via a web browser. To use this option, save odML documents using the `XMLWriter`
94+
instead of `odml.save()`:
95+
96+
XMLWriter(doc).write_file("filename.xml", local_style=True)
97+
9098
### odML - NIX conversion script
9199

92100
You can also find a command line script for importing metadata from odML files into the

0 commit comments

Comments
 (0)