Skip to content

Commit

Permalink
minor export docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
metelkin committed Jan 24, 2025
1 parent 5f689cb commit 6e0a850
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions export-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,9 @@ The following formats are implemented in Heta compiler.

See also [Features support table](#features-support)

## Inline export (deprecated)

Heta of versions 0.4.6 and earlier supported inline export.
It was removed in version 0.5.0.

The inline export to different formats could be done in heta code by using `#export` action.

Example 1

```heta
#export {format: JSON, filepath: output};
```

Example 2

```heta
#export {format: SBML, version: L2V4, filepath: model};
```

Starting from heta-compiler version 0.9.0 the inline export is supported but it is deprecated.
One should use `export` property in declaration file or use CLI `--export` property.
See [migrate to v0.9](./migrate-to-v0.9.md) and [CLI references](./cli-references.md) for details.

## Declaration exports

There are two recommended ways to export models in Heta compiler: using [`export` property](./cli-references.md#declaration-file-format) in declaration file or using CLI [`--export` property](./cli-references.md#running-build-with CLI-options). If no --export option is set, the compiler will use the `export` property from the declaration file.
There are two recommended ways to export models in Heta compiler: using [`export` property](./cli-references.md#declaration-file-format) in declaration file or using CLI [`--export` property](./cli-references.md#running-build-with-CLI-options). If no --export option is set, the compiler will use the `export` property from the declaration file.

The `export` property is an array of objects with the `format` and `filepath` properties and other format-specific properties.

Expand Down Expand Up @@ -82,6 +59,29 @@ Instead of `export` property in the declaration file, one can use CLI `--export`
heta build --export '{format: JSON, filepath: output, omit: ["aux.wiki"], spaceFilter: "nameless|another"}, {format: SBML, version: L2V4, filepath: model}, Table'
```

## Inline export (deprecated)

Heta of versions 0.4.6 and earlier supported inline export.
It was removed in version 0.5.0.

The inline export to different formats could be done in heta code by using `#export` action.

Example 1

```heta
#export {format: JSON, filepath: output};
```

Example 2

```heta
#export {format: SBML, version: L2V4, filepath: model};
```

Starting from heta-compiler version 0.9.0 the inline export is supported but it is deprecated.
One should use `export` property in declaration file or use CLI `--export` property.
See [migrate to v0.9](./migrate-to-v0.9.md) and [CLI references](./cli-references.md) for details.

## JSON

Export to [JSON structure](https://www.json.org/) (array) storing the content of whole platform or selected namespaces (see spaceFilter option).
Expand Down

0 comments on commit 6e0a850

Please sign in to comment.