Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aminya
aminya committed Feb 10, 2020
1 parent 9e5c5da commit 4f44410
Showing 1 changed file with 52 additions and 52 deletions.
104 changes: 52 additions & 52 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,22 @@ Powerful MusicXML reading and writing package for Julia.
] add https://github.com/JuliaMusic/MusicXML.jl
```


# Usage Example
```julia
using MusicXML

# Reads musicxml file and then extracts the data, builds all the types and stores them in proper format.
doc = readmusicxml(joinpath("examples", "musescore.musicxml"))
scorepartwise = readmusicxml( "musescore.musicxml")

# Example 1:
# Prints Each instrument name and then the pitches

# Extracting each instrument information
scprts = doc.scorepartwise.partlist.scoreparts
scprts = scorepartwise.partlist.scoreparts

# Extracting parts
prts = doc.scorepartwise.parts
prts = scorepartwise.parts

# Extracting each part
for prt in prts
Expand Down Expand Up @@ -56,7 +57,6 @@ for prt in prts
iMsr+=1
end
end

```


Expand All @@ -72,62 +72,61 @@ readmusicxml, parsemusicxml
## Types:

```
Doc
scorepartwise
partlist
scoreparts
scorepartwise
partlist
scoreparts
name
id
scoreinstrument
name
id
scoreinstrument
name
id
mididevice
port
id
midiinstrument
channel
program
volume
pan
id
parts
id
measures
attributes
divisions
key
fifth
mode
time
beats
beattype
staves
instruments
clef
sign
line
transpose
diatonic
chromatic
octaveChange
double
notes
pitch
step
alter
octave
rest
unpitched
duration
type
accidental
mididevice
port
id
midiinstrument
channel
program
volume
pan
id
parts
id
measures
attributes
divisions
key
fifth
mode
time
beats
beattype
staves
instruments
clef
sign
line
transpose
diatonic
chromatic
octaveChange
double
notes
pitch
step
alter
octave
rest
unpitched
duration
type
accidental
```

For naming, If the fieldname is a Vector it has `s` at the end of the word.

For naming, types are first letter captalized of the field names:
```
Doc, Scorepartwise, Part, Measure, NoteX, Unpitched, Rest, Pitch, Attributes, Time, Transpose, Clef, Key, Partlist, Scorepart, Midiinstrument, Mididevice, Scoreinstrument
Scorepartwise, Part, Measure, NoteX, Unpitched, Rest, Pitch, Attributes, Time, Transpose, Clef, Key, Partlist, Scorepart, Midiinstrument, Mididevice, Scoreinstrument
```


Expand All @@ -136,6 +135,7 @@ Doc, Scorepartwise, Part, Measure, NoteX, Unpitched, Rest, Pitch, Attributes, Ti
pitch2xml, xml2pitch
```


```@index
```

Expand Down

2 comments on commit 4f44410

@aminya
Copy link
Member Author

@aminya aminya commented on 4f44410 Feb 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/9209

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.1 -m "<description of version>" 4f44410a46e8c333bdc376c627e51e8a9f7f10d6
git push origin v0.2.1

Also, note the warning: Version 0.2.1 skips over 0.2.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.