Skip to content

Commit 4f44410

Browse files
committed
Update docs
1 parent 9e5c5da commit 4f44410

File tree

1 file changed

+52
-52
lines changed

1 file changed

+52
-52
lines changed

docs/src/index.md

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,22 @@ Powerful MusicXML reading and writing package for Julia.
1111
] add https://github.com/JuliaMusic/MusicXML.jl
1212
```
1313

14+
1415
# Usage Example
1516
```julia
1617
using MusicXML
1718

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

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

2425
# Extracting each instrument information
25-
scprts = doc.scorepartwise.partlist.scoreparts
26+
scprts = scorepartwise.partlist.scoreparts
2627

2728
# Extracting parts
28-
prts = doc.scorepartwise.parts
29+
prts = scorepartwise.parts
2930

3031
# Extracting each part
3132
for prt in prts
@@ -56,7 +57,6 @@ for prt in prts
5657
iMsr+=1
5758
end
5859
end
59-
6060
```
6161

6262

@@ -72,62 +72,61 @@ readmusicxml, parsemusicxml
7272
## Types:
7373

7474
```
75-
Doc
76-
scorepartwise
77-
partlist
78-
scoreparts
75+
scorepartwise
76+
partlist
77+
scoreparts
78+
name
79+
id
80+
scoreinstrument
7981
name
8082
id
81-
scoreinstrument
82-
name
83-
id
84-
mididevice
85-
port
86-
id
87-
midiinstrument
88-
channel
89-
program
90-
volume
91-
pan
92-
id
93-
parts
94-
id
95-
measures
96-
attributes
97-
divisions
98-
key
99-
fifth
100-
mode
101-
time
102-
beats
103-
beattype
104-
staves
105-
instruments
106-
clef
107-
sign
108-
line
109-
transpose
110-
diatonic
111-
chromatic
112-
octaveChange
113-
double
114-
notes
115-
pitch
116-
step
117-
alter
118-
octave
119-
rest
120-
unpitched
121-
duration
122-
type
123-
accidental
83+
mididevice
84+
port
85+
id
86+
midiinstrument
87+
channel
88+
program
89+
volume
90+
pan
91+
id
92+
parts
93+
id
94+
measures
95+
attributes
96+
divisions
97+
key
98+
fifth
99+
mode
100+
time
101+
beats
102+
beattype
103+
staves
104+
instruments
105+
clef
106+
sign
107+
line
108+
transpose
109+
diatonic
110+
chromatic
111+
octaveChange
112+
double
113+
notes
114+
pitch
115+
step
116+
alter
117+
octave
118+
rest
119+
unpitched
120+
duration
121+
type
122+
accidental
124123
```
125124

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

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

133132

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

138+
139139
```@index
140140
```
141141

0 commit comments

Comments
 (0)