Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pr0m1th3as authored Feb 26, 2023
1 parent c945401 commit 9b4ff08
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ available for packages hosted at GitHub.

## Installation

To install the latest version (0.4.5) you need Octave (>=7.2.0) installed on your system. You can install it by typing:
To install the latest version (0.4.7) you need Octave (>=7.2.0) installed on your system. You can install it by typing:

```
pkg install -forge pkg-octave-doc
Expand Down Expand Up @@ -54,7 +54,7 @@ package_texi2html ("pkg-octave-doc")

* Avoid nesting `@itemize` and `@multitable` blocks because they are not parsed correctly by `texi2html`. You can achieve the same visual result by segmenting them.

* Table columns in HTML use dynamic width, os if you wish to maintain the required width for better visualization, add extra empty `@tags` inbetween.
* Table columns in HTML use dynamic width, so if you wish to maintain the required width for better visualization, add extra empty `@tags` inbetween.

For example:
````
Expand Down Expand Up @@ -86,6 +86,7 @@ DEFUN_DLD (libsvmread, args, nargout,
This function ...
````

`@math{}` texi tags are converted to `<math></math>` html tags and their contents are scanned for `x` and `*` characters, which are replaced by `&times;` in order to properly display the multiplication symbol. Make sure that lower case `x` within the `@math{}` tags is explicitly used for denoting multiplication and it is not used for anything else (e.g. variable name). This feature, introduced in release 0.4.7, only affects the contents of `@math{}` texi tags.

## TODO

Expand Down

0 comments on commit 9b4ff08

Please sign in to comment.