magnolia 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. data/Rakefile +1 -1
  2. data/doc/classes/Magnolia.html +576 -0
  3. data/doc/classes/Magnolia.src/M000001.html +18 -0
  4. data/doc/classes/Magnolia.src/M000002.html +18 -0
  5. data/doc/classes/Magnolia.src/M000003.html +28 -0
  6. data/doc/classes/Magnolia.src/M000004.html +19 -0
  7. data/doc/classes/Magnolia.src/M000005.html +19 -0
  8. data/doc/classes/Magnolia.src/M000006.html +18 -0
  9. data/doc/classes/Magnolia.src/M000007.html +19 -0
  10. data/doc/classes/Magnolia.src/M000008.html +20 -0
  11. data/doc/classes/Magnolia.src/M000009.html +20 -0
  12. data/doc/classes/Magnolia.src/M000010.html +21 -0
  13. data/doc/classes/Magnolia.src/M000011.html +20 -0
  14. data/doc/classes/Magnolia/Mark.html +330 -0
  15. data/doc/classes/Magnolia/Mark.src/M000012.html +18 -0
  16. data/doc/classes/Magnolia/Mark.src/M000013.html +18 -0
  17. data/doc/classes/Magnolia/Mark.src/M000014.html +18 -0
  18. data/doc/classes/Magnolia/Mark.src/M000015.html +27 -0
  19. data/doc/classes/Magnolia/Mark.src/M000016.html +19 -0
  20. data/doc/classes/Magnolia/Mark.src/M000017.html +32 -0
  21. data/doc/classes/Magnolia/Tag.html +155 -0
  22. data/doc/classes/Magnolia/Tag.src/M000018.html +21 -0
  23. data/doc/created.rid +1 -0
  24. data/doc/files/lib/magnolia/magnolia_rb.html +186 -0
  25. data/doc/fr_class_index.html +29 -0
  26. data/doc/fr_file_index.html +27 -0
  27. data/doc/fr_method_index.html +44 -0
  28. data/doc/index.html +24 -0
  29. data/doc/rdoc-style.css +208 -0
  30. data/lib/magnolia/magnolia.rb +1 -2
  31. data/lib/magnolia/version.rb +2 -2
  32. metadata +41 -4
data/doc/classes/Magnolia.src/M000001.html ADDED
@@ -0,0 +1,18 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 63</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">api_key</span>)
15
+ <span class="ruby-constant">Magnolia</span>.<span class="ruby-identifier">set_api_key</span>(<span class="ruby-identifier">api_key</span>)
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
data/doc/classes/Magnolia.src/M000002.html ADDED
@@ -0,0 +1,18 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>set_api_key (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 69</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_api_key</span>(<span class="ruby-identifier">api_key</span>)
15
+ <span class="ruby-ivar">@@api_key</span> = <span class="ruby-identifier">api_key</span>
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
data/doc/classes/Magnolia.src/M000003.html ADDED
@@ -0,0 +1,28 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>search (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 107</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">search</span>(<span class="ruby-identifier">options</span> = {})
15
+ <span class="ruby-identifier">params</span> = { <span class="ruby-identifier">:tags</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
16
+ <span class="ruby-identifier">:person</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
17
+ <span class="ruby-identifier">:group</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
18
+ <span class="ruby-identifier">:rating</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
19
+ <span class="ruby-identifier">:from</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
20
+ <span class="ruby-identifier">:to</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
21
+ <span class="ruby-identifier">:url</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>,
22
+ <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">10</span> }
23
+ <span class="ruby-identifier">params</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">options</span>)
24
+
25
+ <span class="ruby-identifier">create_marks_from_xml</span>(<span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_find'</span>, <span class="ruby-identifier">params</span>))
26
+ <span class="ruby-keyword kw">end</span></pre>
27
+ </body>
28
+ </html>
data/doc/classes/Magnolia.src/M000004.html ADDED
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>get (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 141</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">marks</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The id must be included in order to know which bookmarks to get.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">marks</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:id</span>
16
+ <span class="ruby-identifier">create_marks_from_xml</span>(<span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_get'</span>, <span class="ruby-identifier">marks</span>))
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
data/doc/classes/Magnolia.src/M000005.html ADDED
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>add (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 168</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">mark</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The url must be included to add a mark.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:url</span>
16
+ <span class="ruby-identifier">create_marks_from_xml</span>(<span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_add'</span>, <span class="ruby-identifier">mark</span>))
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
data/doc/classes/Magnolia.src/M000006.html ADDED
@@ -0,0 +1,18 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>delete (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 187</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">marks</span> = {})
15
+ <span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_delete'</span>, <span class="ruby-identifier">marks</span>)
16
+ <span class="ruby-keyword kw">end</span></pre>
17
+ </body>
18
+ </html>
data/doc/classes/Magnolia.src/M000007.html ADDED
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>update (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 215</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update</span>(<span class="ruby-identifier">mark</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The id must be included in order to know which bookmark to update.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:id</span>
16
+ <span class="ruby-identifier">create_marks_from_xml</span>(<span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_update'</span>, <span class="ruby-identifier">mark</span>))
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
data/doc/classes/Magnolia.src/M000008.html ADDED
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>tags_add (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 236</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags_add</span>(<span class="ruby-identifier">mark</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The id must be included in order to know which bookmark to add tags to.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:id</span>
16
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The tags must be included that you want to add.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:tags</span>
17
+ <span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_tags_add'</span>, <span class="ruby-identifier">mark</span>)
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
data/doc/classes/Magnolia.src/M000009.html ADDED
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>tags_delete (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 258</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags_delete</span>(<span class="ruby-identifier">mark</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The id must be included in order to know which bookmark to add tags to.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:id</span>
16
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The tags must be included that you want to add.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:tags</span>
17
+ <span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_tags_delete'</span>, <span class="ruby-identifier">mark</span>)
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
data/doc/classes/Magnolia.src/M000010.html ADDED
@@ -0,0 +1,21 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>tags_replace (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 283</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags_replace</span>(<span class="ruby-identifier">mark</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The id must be included in order to know which bookmark to rename tags for.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:id</span>
16
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The old tag is required.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:old</span>
17
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The new tag is required.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:new</span>
18
+ <span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'bookmarks_tags_replace'</span>, <span class="ruby-identifier">mark</span>)
19
+ <span class="ruby-keyword kw">end</span></pre>
20
+ </body>
21
+ </html>
data/doc/classes/Magnolia.src/M000011.html ADDED
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>tags_find (Magnolia)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/magnolia/magnolia.rb, line 311</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags_find</span>(<span class="ruby-identifier">mark</span> = {})
15
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingData</span>, <span class="ruby-value str">'The person (screen name) is required.'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mark</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">:person</span>
16
+ <span class="ruby-identifier">root</span> = <span class="ruby-identifier">make_request</span>(<span class="ruby-value str">'tags_find'</span>, <span class="ruby-identifier">mark</span>)
17
+ <span class="ruby-identifier">create_tags_from_xml</span>(<span class="ruby-identifier">root</span>)
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
data/doc/classes/Magnolia/Mark.html ADDED
@@ -0,0 +1,330 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Magnolia::Mark</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Magnolia::Mark</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/magnolia/magnolia_rb.html">
59
+ lib/magnolia/magnolia.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ The mark class is used to store information about each bookmark after it is
84
+ found, created or updated. Each method that is not in the DONT_PROCESS
85
+ constant returns and array of <tt><a href="Mark.html">Mark</a></tt>
86
+ objects.
87
+ </p>
88
+
89
+ </div>
90
+
91
+
92
+ </div>
93
+
94
+ <div id="method-list">
95
+ <h3 class="section-bar">Methods</h3>
96
+
97
+ <div class="name-list">
98
+ <a href="#M000014">a_tag</a>&nbsp;&nbsp;
99
+ <a href="#M000016">find</a>&nbsp;&nbsp;
100
+ <a href="#M000017">from_xml</a>&nbsp;&nbsp;
101
+ <a href="#M000013">img_tag</a>&nbsp;&nbsp;
102
+ <a href="#M000012">new</a>&nbsp;&nbsp;
103
+ <a href="#M000015">save</a>&nbsp;&nbsp;
104
+ </div>
105
+ </div>
106
+
107
+ </div>
108
+
109
+
110
+ <!-- if includes -->
111
+
112
+ <div id="section">
113
+
114
+
115
+
116
+
117
+
118
+ <div id="attribute-list">
119
+ <h3 class="section-bar">Attributes</h3>
120
+
121
+ <div class="name-list">
122
+ <table>
123
+ <tr class="top-aligned-row context-row">
124
+ <td class="context-item-name">a_tag</td>
125
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
126
+ <td class="context-item-desc"></td>
127
+ </tr>
128
+ <tr class="top-aligned-row context-row">
129
+ <td class="context-item-name">created</td>
130
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
131
+ <td class="context-item-desc"></td>
132
+ </tr>
133
+ <tr class="top-aligned-row context-row">
134
+ <td class="context-item-name">description</td>
135
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
136
+ <td class="context-item-desc"></td>
137
+ </tr>
138
+ <tr class="top-aligned-row context-row">
139
+ <td class="context-item-name">id</td>
140
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
141
+ <td class="context-item-desc"></td>
142
+ </tr>
143
+ <tr class="top-aligned-row context-row">
144
+ <td class="context-item-name">img_tag</td>
145
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
146
+ <td class="context-item-desc"></td>
147
+ </tr>
148
+ <tr class="top-aligned-row context-row">
149
+ <td class="context-item-name">owner</td>
150
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
151
+ <td class="context-item-desc"></td>
152
+ </tr>
153
+ <tr class="top-aligned-row context-row">
154
+ <td class="context-item-name">private</td>
155
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
156
+ <td class="context-item-desc"></td>
157
+ </tr>
158
+ <tr class="top-aligned-row context-row">
159
+ <td class="context-item-name">rating</td>
160
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
161
+ <td class="context-item-desc"></td>
162
+ </tr>
163
+ <tr class="top-aligned-row context-row">
164
+ <td class="context-item-name">screenshot</td>
165
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
166
+ <td class="context-item-desc"></td>
167
+ </tr>
168
+ <tr class="top-aligned-row context-row">
169
+ <td class="context-item-name">tags</td>
170
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
171
+ <td class="context-item-desc"></td>
172
+ </tr>
173
+ <tr class="top-aligned-row context-row">
174
+ <td class="context-item-name">title</td>
175
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
176
+ <td class="context-item-desc"></td>
177
+ </tr>
178
+ <tr class="top-aligned-row context-row">
179
+ <td class="context-item-name">updated</td>
180
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
181
+ <td class="context-item-desc"></td>
182
+ </tr>
183
+ <tr class="top-aligned-row context-row">
184
+ <td class="context-item-name">url</td>
185
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
186
+ <td class="context-item-desc"></td>
187
+ </tr>
188
+ </table>
189
+ </div>
190
+ </div>
191
+
192
+
193
+
194
+ <!-- if method_list -->
195
+ <div id="methods">
196
+ <h3 class="section-bar">Public Class methods</h3>
197
+
198
+ <div id="method-M000016" class="method-detail">
199
+ <a name="M000016"></a>
200
+
201
+ <div class="method-heading">
202
+ <a href="Mark.src/M000016.html" target="Code" class="method-signature"
203
+ onclick="popupCode('Mark.src/M000016.html');return false;">
204
+ <span class="method-name">find</span><span class="method-args">(id)</span>
205
+ </a>
206
+ </div>
207
+
208
+ <div class="method-description">
209
+ <p>
210
+ Finds a single bookmark by it&#8216;s id (short name). If not found raises
211
+ a Magnolia::RequestError
212
+ </p>
213
+ </div>
214
+ </div>
215
+
216
+ <div id="method-M000017" class="method-detail">
217
+ <a name="M000017"></a>
218
+
219
+ <div class="method-heading">
220
+ <a href="Mark.src/M000017.html" target="Code" class="method-signature"
221
+ onclick="popupCode('Mark.src/M000017.html');return false;">
222
+ <span class="method-name">from_xml</span><span class="method-args">(xml)</span>
223
+ </a>
224
+ </div>
225
+
226
+ <div class="method-description">
227
+ <p>
228
+ Converts xml into a mark
229
+ </p>
230
+ </div>
231
+ </div>
232
+
233
+ <div id="method-M000012" class="method-detail">
234
+ <a name="M000012"></a>
235
+
236
+ <div class="method-heading">
237
+ <a href="Mark.src/M000012.html" target="Code" class="method-signature"
238
+ onclick="popupCode('Mark.src/M000012.html');return false;">
239
+ <span class="method-name">new</span><span class="method-args">()</span>
240
+ </a>
241
+ </div>
242
+
243
+ <div class="method-description">
244
+ </div>
245
+ </div>
246
+
247
+ <h3 class="section-bar">Public Instance methods</h3>
248
+
249
+ <div id="method-M000014" class="method-detail">
250
+ <a name="M000014"></a>
251
+
252
+ <div class="method-heading">
253
+ <a href="Mark.src/M000014.html" target="Code" class="method-signature"
254
+ onclick="popupCode('Mark.src/M000014.html');return false;">
255
+ <span class="method-name">a_tag</span><span class="method-args">()</span>
256
+ </a>
257
+ </div>
258
+
259
+ <div class="method-description">
260
+ <p>
261
+ Creates a link to the url of the bookmark with the title as the text
262
+ </p>
263
+ </div>
264
+ </div>
265
+
266
+ <div id="method-M000013" class="method-detail">
267
+ <a name="M000013"></a>
268
+
269
+ <div class="method-heading">
270
+ <a href="Mark.src/M000013.html" target="Code" class="method-signature"
271
+ onclick="popupCode('Mark.src/M000013.html');return false;">
272
+ <span class="method-name">img_tag</span><span class="method-args">()</span>
273
+ </a>
274
+ </div>
275
+
276
+ <div class="method-description">
277
+ <p>
278
+ Creates an image tag for the screenshot image with the title as the alt
279
+ text
280
+ </p>
281
+ </div>
282
+ </div>
283
+
284
+ <div id="method-M000015" class="method-detail">
285
+ <a name="M000015"></a>
286
+
287
+ <div class="method-heading">
288
+ <a href="Mark.src/M000015.html" target="Code" class="method-signature"
289
+ onclick="popupCode('Mark.src/M000015.html');return false;">
290
+ <span class="method-name">save</span><span class="method-args">()</span>
291
+ </a>
292
+ </div>
293
+
294
+ <div class="method-description">
295
+ <p>
296
+ This method allows working with bookmarks much like ActiveRecord.
297
+ </p>
298
+ <h2>Examples</h2>
299
+ <pre>
300
+ mark = Magnolia::Mark.new
301
+ mark.title = 'Addicted To New'
302
+ mark.url = 'http://addictedtonew.com/'
303
+ mark.tags = ['john nunemaker', 'me'] # you can also use comma-seperated list mark.tags = 'john nunemaker, me'
304
+ mark.save
305
+ puts mark.id # this is the id of the newly created bookmark
306
+ </pre>
307
+ <p>
308
+ You can also use it to update bookmarks like so:
309
+ </p>
310
+ <pre>
311
+ mark = Magnolia::Mark.find(:id =&gt; 'someshortname')
312
+ mark.title = 'Addicted To New by John Nunemaker'
313
+ mark.save
314
+ </pre>
315
+ </div>
316
+ </div>
317
+
318
+
319
+ </div>
320
+
321
+
322
+ </div>
323
+
324
+
325
+ <div id="validator-badges">
326
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
327
+ </div>
328
+
329
+ </body>
330
+ </html>