Skip to content

Commit 3a3ac27

Browse files
authored
Update docs (#111)
* add node names * delete old docs of Julia 0.6
1 parent dd39bd3 commit 3a3ac27

File tree

2 files changed

+28
-101
lines changed

2 files changed

+28
-101
lines changed

docs/Project.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
34

45
[compat]
5-
Documenter = "~0.20"
6+
Documenter = "~0.22"

docs/src/manual.md

Lines changed: 26 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ The text just before the `@` sign shows the node type (in this example,
7272
Let's add a root node to the document and a text node to the root node:
7373
```jldoctest doc
7474
julia> elm = ElementNode("root") # create an element node
75-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f2a1b5f0>)
75+
EzXML.Node(<ELEMENT_NODE[root]@0x00007fd9f2a1b5f0>)
7676
7777
julia> setroot!(doc, elm)
78-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f2a1b5f0>)
78+
EzXML.Node(<ELEMENT_NODE[root]@0x00007fd9f2a1b5f0>)
7979
8080
julia> print(doc)
8181
<?xml version="1.0" encoding="UTF-8"?>
@@ -111,7 +111,7 @@ The value of a property will be `nothing` when there is no corresponding value.
111111

112112
```jldoctest
113113
julia> elm = ElementNode("element")
114-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f44122f0>)
114+
EzXML.Node(<ELEMENT_NODE[element]@0x00007fd9f44122f0>)
115115
116116
julia> println(elm)
117117
<element/>
@@ -167,19 +167,19 @@ julia> txt.content
167167
child element to an existing node:
168168
```jldoctest
169169
julia> user = ElementNode("User")
170-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f427c510>)
170+
EzXML.Node(<ELEMENT_NODE[User]@0x00007fd9f427c510>)
171171
172172
julia> println(user)
173173
<User/>
174174
175175
julia> addelement!(user, "id", "167492")
176-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f41ad580>)
176+
EzXML.Node(<ELEMENT_NODE[id]@0x00007fd9f41ad580>)
177177
178178
julia> println(user)
179179
<User><id>167492</id></User>
180180
181181
julia> addelement!(user, "name", "Kumiko Oumae")
182-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f42942d0>)
182+
EzXML.Node(<ELEMENT_NODE[name]@0x00007fd9f42942d0>)
183183
184184
julia> println(user)
185185
<User><id>167492</id><name>Kumiko Oumae</name></User>
@@ -191,34 +191,6 @@ julia> prettyprint(user)
191191
</User>
192192
```
193193

194-
On Julia 0.6, these properties can be accessed via accessor functions:
195-
```jldoctest
196-
julia> elm = ElementNode("element")
197-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f41acbc0>)
198-
199-
julia> nodetype(elm)
200-
ELEMENT_NODE
201-
202-
julia> nodename(elm)
203-
"element"
204-
205-
julia> nodepath(elm)
206-
"/element"
207-
208-
julia> nodecontent(elm)
209-
""
210-
211-
julia> println(elm)
212-
<element/>
213-
214-
julia> setnodecontent!(elm, "content")
215-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f41acbc0>)
216-
217-
julia> println(elm)
218-
<element>content</element>
219-
220-
```
221-
222194

223195
DOM
224196
---
@@ -259,15 +231,12 @@ Before traversing a document we need to get the root of the document tree.
259231
The `.root` property returns the root element (if any) of a document:
260232
```jldoctest dom
261233
julia> primates = doc.root # get the root element
262-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f4086880>)
263-
264-
julia> root(doc) # on Julia 0.6
265-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f4086880>)
234+
EzXML.Node(<ELEMENT_NODE[primates]@0x00007fd9f4086880>)
266235
267236
julia> genus = elements(primates) # `elements` returns all child elements.
268237
2-element Array{EzXML.Node,1}:
269-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f4041a40>)
270-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f40828e0>)
238+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f4041a40>)
239+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f40828e0>)
271240
272241
julia> genus[1].type, genus[1].name
273242
(ELEMENT_NODE, "genus")
@@ -328,7 +297,7 @@ julia> primates.firstnode
328297
EzXML.Node(<TEXT_NODE@0x00007fd9f409f200>)
329298
330299
julia> primates.firstelement
331-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f4041a40>)
300+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f4041a40>)
332301
333302
julia> primates.firstelement == genus[1]
334303
true
@@ -337,7 +306,7 @@ julia> primates.lastnode
337306
EzXML.Node(<TEXT_NODE@0x00007fd9f404bec0>)
338307
339308
julia> primates.lastelement
340-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f40828e0>)
309+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f40828e0>)
341310
342311
julia> primates.lastelement === genus[2]
343312
true
@@ -382,29 +351,29 @@ julia> for node in eachnode(primates)
382351
@show node
383352
end
384353
node = EzXML.Node(<TEXT_NODE@0x00007fd9f409f200>)
385-
node = EzXML.Node(<ELEMENT_NODE@0x00007fd9f4041a40>)
354+
node = EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f4041a40>)
386355
node = EzXML.Node(<TEXT_NODE@0x00007fd9f4060f70>)
387-
node = EzXML.Node(<ELEMENT_NODE@0x00007fd9f40828e0>)
356+
node = EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f40828e0>)
388357
node = EzXML.Node(<TEXT_NODE@0x00007fd9f404bec0>)
389358
390359
julia> for node in eachelement(primates)
391360
@show node
392361
end
393-
node = EzXML.Node(<ELEMENT_NODE@0x00007fd9f4041a40>)
394-
node = EzXML.Node(<ELEMENT_NODE@0x00007fd9f40828e0>)
362+
node = EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f4041a40>)
363+
node = EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f40828e0>)
395364
396365
julia> nodes(primates)
397366
5-element Array{EzXML.Node,1}:
398367
EzXML.Node(<TEXT_NODE@0x00007fd9f409f200>)
399-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f4041a40>)
368+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f4041a40>)
400369
EzXML.Node(<TEXT_NODE@0x00007fd9f4060f70>)
401-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f40828e0>)
370+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f40828e0>)
402371
EzXML.Node(<TEXT_NODE@0x00007fd9f404bec0>)
403372
404373
julia> elements(primates)
405374
2-element Array{EzXML.Node,1}:
406-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f4041a40>)
407-
EzXML.Node(<ELEMENT_NODE@0x00007fd9f40828e0>)
375+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f4041a40>)
376+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fd9f40828e0>)
408377
409378
```
410379

@@ -423,18 +392,18 @@ EzXML.Document(EzXML.Node(<DOCUMENT_NODE@0x00007fbeddc2a1d0>))
423392
424393
julia> findall("/primates", primates) # Find the "primates" element just under the document
425394
1-element Array{EzXML.Node,1}:
426-
EzXML.Node(<ELEMENT_NODE@0x00007fbeddc1e190>)
395+
EzXML.Node(<ELEMENT_NODE[primates]@0x00007fbeddc1e190>)
427396
428397
julia> findall("//genus", primates)
429398
2-element Array{EzXML.Node,1}:
430-
EzXML.Node(<ELEMENT_NODE@0x00007fbeddc12c50>)
431-
EzXML.Node(<ELEMENT_NODE@0x00007fbeddc16ea0>)
399+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fbeddc12c50>)
400+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fbeddc16ea0>)
432401
433402
julia> findfirst("//genus", primates)
434-
EzXML.Node(<ELEMENT_NODE@0x00007fbeddc12c50>)
403+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fbeddc12c50>)
435404
436405
julia> findlast("//genus", primates)
437-
EzXML.Node(<ELEMENT_NODE@0x00007fbeddc16ea0>)
406+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fbeddc16ea0>)
438407
439408
julia> println(findfirst("//genus", primates))
440409
<genus name="Homo">
@@ -447,7 +416,7 @@ If you would like to change the starting node of a query, you can pass the node
447416
as the second argument of `find*`:
448417
```jldoctest xpath
449418
julia> genus = findfirst("//genus", primates)
450-
EzXML.Node(<ELEMENT_NODE@0x00007fbeddc12c50>)
419+
EzXML.Node(<ELEMENT_NODE[genus]@0x00007fbeddc12c50>)
451420
452421
julia> println(genus)
453422
<genus name="Homo">
@@ -490,7 +459,7 @@ julia> ns = namespace(doc.root) # get the namespace
490459
491460
julia> findall("/x:parent/x:child", doc.root, ["x"=>ns]) # specify its prefix as "x"
492461
1-element Array{EzXML.Node,1}:
493-
EzXML.Node(<ELEMENT_NODE@0x00007fdc6774c990>)
462+
EzXML.Node(<ELEMENT_NODE[child]@0x00007fdc6774c990>)
494463
495464
```
496465

@@ -664,46 +633,3 @@ julia> for typ in reader
664633
julia> close(reader)
665634
666635
```
667-
668-
---
669-
670-
**(NOTE: This paragraph is for the backward compatibility of Julia 0.6. If you
671-
don't need to support Julia 0.6, you should use the `iterate` method
672-
instead.)** Iteration is advanced by the `done(<reader>)` method, which updates
673-
the current reading position of the reader and returns `false` when there is at
674-
least one node to read from the stream:
675-
```
676-
julia> reader = open(EzXML.StreamReader, "undirected.graphml")
677-
EzXML.StreamReader(<READER_NONE@0x00007f9fe8d67340>)
678-
679-
julia> done(reader) # Read the 1st node.
680-
false
681-
682-
julia> nodetype(reader)
683-
READER_ELEMENT
684-
685-
julia> nodename(reader)
686-
"graphml"
687-
688-
julia> done(reader) # Read the 2nd node.
689-
false
690-
691-
julia> nodetype(reader)
692-
READER_SIGNIFICANT_WHITESPACE
693-
694-
julia> nodename(reader)
695-
"#text"
696-
697-
julia> done(reader) # Read the 3rd node.
698-
false
699-
700-
julia> nodetype(reader)
701-
READER_ELEMENT
702-
703-
julia> nodename(reader)
704-
"graph"
705-
706-
julia> reader["edgedefault"]
707-
"undirected"
708-
709-
```

0 commit comments

Comments
 (0)