Skip to content

Commit

Permalink
Added docs for the AbletonInfoText parser
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianrudnik committed Nov 22, 2023
1 parent 318eff3 commit 8042377
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions website/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ export default defineConfig({
link: '/search/parser/',
items: [
{text: 'Ableton Live Set', link: '/search/parser/ableton-live-set'},
{text: 'Ableton Info-Text', link: '/search/parser/ableton-info-text'},
]
},
{
Expand Down
45 changes: 45 additions & 0 deletions website/docs/search/parser/ableton-info-text.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
description: Parser for Ableton Info-Text elements.
---

# Ableton Info-Text parser

This parser will extract any annotation, also known as Info-Text, within an Ableton Live Set file and create its own dedicated result item per annotation.

This text can be entered by the user in the Live Set and is used to add notes to given tracks, devices, clips or other elements.

The resulting document type is `AbletonInfoText`.

## Fields

### `type`

<IndexProp name="type%" type="string" mapping="exact">

The exact type of the document.

- `+type:AbletonInfoText` will match all documents of this type.
</IndexProp>

<!--@include: ./shared/base.md-->
<!--@include: ./shared/annotation.md-->

### `parent`

<IndexProp name="parent" type="string" mapping="exact" :version="[11,10,9]">

A path-like string that represents the path towards the given Info-Text element.

It is based on a simplified XML structure path to give a hint of the location of the annotation within the Live Set.

- `+parent:"LiveSet/Tracks/AudioTrack/Name/Annotation"` will match all annotations that are at that given location.
</IndexProp>

## Produced tags

<IndexTag base="type:ableton-info-text">

A type tag that matches all documents of this type.

- `+tags:"type:ableton-info-text"` if the result document is of type `AbletonInfoText`.
</IndexTag>
7 changes: 7 additions & 0 deletions website/docs/search/parser/ableton-live-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ The label of the software used to create the Live Set file. This is a end-user f

## Produced tags

<IndexTag base="ableton-live-set">

A type tag that matches all documents of this type.

- `+tags:type:"ableton-live-set"` if the result document is of type `AbletonLiveSet`.
</IndexTag>

### `bpm`

<IndexTag base="bpm" value="int">
Expand Down

0 comments on commit 8042377

Please sign in to comment.