diff options
-rw-r--r-- | docs/PLUGIN_API.new | 4 | ||||
-rw-r--r-- | utils/rockbox_api/index.tpl | 93 | ||||
-rw-r--r-- | utils/rockbox_api/layout.css | 43 | ||||
-rw-r--r-- | utils/rockbox_api/section.tpl | 150 |
4 files changed, 212 insertions, 78 deletions
diff --git a/docs/PLUGIN_API.new b/docs/PLUGIN_API.new index 3388fa9412..02e9c8c157 100644 --- a/docs/PLUGIN_API.new +++ b/docs/PLUGIN_API.new | |||
@@ -2221,8 +2221,8 @@ int snprintf(char *buf, size_t size, const char *fmt, ...) ATTRIBUTE_PRINTF(3, 4 | |||
2221 | \param buf | 2221 | \param buf |
2222 | \param size | 2222 | \param size |
2223 | \param fmt | 2223 | \param fmt |
2224 | \return the number of characters printed or that would have been printed if the output was truncated (not including the trailing '\0') upon success | 2224 | \return the number of characters printed or that would have been printed if the output was truncated (not including the trailing NULL character) upon success |
2225 | \description Write a formatted string =fmt= in buffer =buf= of size =size= (including the trailing '\0'). These support %c, %s, %d and %x only with the width and zero padding flag only. | 2225 | \description Write a formatted string =fmt= in buffer =buf= of size =size= (including the trailing NULL character). These support %c, %s, %d and %x only with the width and zero padding flag only. |
2226 | 2226 | ||
2227 | int sound_default(int setting) | 2227 | int sound_default(int setting) |
2228 | \group sound | 2228 | \group sound |
diff --git a/utils/rockbox_api/index.tpl b/utils/rockbox_api/index.tpl index ccbd5965ad..7412b150f1 100644 --- a/utils/rockbox_api/index.tpl +++ b/utils/rockbox_api/index.tpl | |||
@@ -2,22 +2,89 @@ | |||
2 | <html> | 2 | <html> |
3 | <head> | 3 | <head> |
4 | <link href="layout.css" rel="stylesheet" type="text/css" /> | 4 | <link href="layout.css" rel="stylesheet" type="text/css" /> |
5 | <title>Plugin API - INDEX</title> | 5 | <link rel="STYLESHEET" type="text/css" href="http://www.rockbox.org/style.css"> |
6 | <link rel="shortcut icon" href="http://www.rockbox.org/favicon.ico"> | ||
7 | <title>Rockbox Plugin API - INDEX</title> | ||
8 | <meta name="author" content="Rockbox Contributors"> | ||
6 | </head> | 9 | </head> |
7 | 10 | ||
8 | <body> | 11 | <body> |
9 | <h1>Plugin API reference</h1> | 12 | <table border=0 cellpadding=7 cellspacing=0> |
10 | <ul> | 13 | <tr valign="top"> |
11 | %GROUP_START% | 14 | <td bgcolor="#6887bb" valign="top"> |
12 | <li>%GROUP_NAME% | 15 | <br> |
13 | <ul> | 16 | <div align="center"><a href="http://www.rockbox.org/"> |
14 | %FUNCTION_START% | 17 | <img src="http://www.rockbox.org/rockbox100.png" width=99 height=30 border=0 alt="Rockbox.org home"></a> |
15 | <li><a href="%GROUP%.html#%FUNCTION%">%FUNCTION_NAME%</a></li> | 18 | </div> |
16 | %FUNCTION_END% | 19 | <div style="margin-top:20px"> |
17 | </ul> | 20 | <div class="submenu"> |
18 | </li> | 21 | Downloads |
19 | %GROUP_END% | 22 | </div> |
20 | </ul> | 23 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/package.png' align='top'> <a class="menulink" href="http://www.rockbox.org/download/">releases</a><br> |
24 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/bomb.png' align='top'> <a class="menulink" href="http://build.rockbox.org">current build</a><br> | ||
25 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/style.png' align='top'> <a class="menulink" href="http://www.rockbox.org/twiki/bin/view/Main/RockboxExtras">extras</a> | ||
26 | <div class="submenu"> | ||
27 | Documentation | ||
21 | 28 | ||
29 | </div> | ||
30 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/page_white_acrobat.png' align='top'> <a class="menulink" href="http://www.rockbox.org/manual.shtml">manual</a><br> | ||
31 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/application_edit.png' align='top'> <a class="menulink" href="http://www.rockbox.org/twiki/">wiki</a><br> | ||
32 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/book_open.png' align='top'> <a class="menulink" href="http://www.rockbox.org/twiki/bin/view/Main/DocsIndex">docs index</a> | ||
33 | <div class="submenu"> | ||
34 | Support | ||
35 | </div> | ||
36 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/email.png' align='top'> <a class="menulink" href="http://www.rockbox.org/mail/">mailing lists</a><br> | ||
37 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/group.png' align='top'> <a class="menulink" href="http://www.rockbox.org/irc/">IRC</a><br> | ||
38 | |||
39 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/comment_edit.png' align='top'> <a class="menulink" href="http://forums.rockbox.org/">forums</a> | ||
40 | <div class="submenu"> | ||
41 | Tracker | ||
42 | </div> | ||
43 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/bug.png' align='top'> <a class="menulink" href="http://www.rockbox.org/tracker/index.php?type=2">bugs</a><br> | ||
44 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/brick.png' align='top'> <a class="menulink" href="http://www.rockbox.org/tracker/index.php?type=4">patches</a><br> | ||
45 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/lightbulb.png' align='top'> <a class="menulink" href="http://www.rockbox.org/tracker/index.php?type=1">requests</a><br> | ||
46 | <div class="submenu"> | ||
47 | Search | ||
48 | </div> | ||
49 | |||
50 | <form id="fsform" action="http://www.rockbox.org/tracker/index.php" method="get" onSubmit="return fsstrip();"> | ||
51 | <input id="taskid" name="show_task" type="text" size="10" maxlength="10" accesskey="t"><br> | ||
52 | <input class="mainbutton" type="submit" value="Flyspray #"> | ||
53 | </form> | ||
54 | <br> | ||
55 | <form action="http://www.google.com/search"> | ||
56 | <input name=as_q size=10><br> | ||
57 | <input value="Search" type=submit> | ||
58 | <input type=hidden name=as_sitesearch value="www.rockbox.org"> | ||
59 | </form> | ||
60 | <p><form action="https://www.paypal.com/cgi-bin/webscr" method="get"> | ||
61 | <input type="hidden" name="cmd" value="_xclick"> | ||
62 | <input type="hidden" name="business" value="bjorn@haxx.se"> | ||
63 | <input type="hidden" name="item_name" value="Donation to the Rockbox project"> | ||
64 | <input type="hidden" name="no_shipping" value="1"> | ||
65 | <input type="hidden" name="cn" value="Note to the Rockbox team"> | ||
66 | <input type="hidden" name="currency_code" value="USD"> | ||
67 | |||
68 | <input type="hidden" name="tax" value="0"> | ||
69 | <input type="image" src="http://www.rockbox.org/paypal-donate.gif" name="submit"> | ||
70 | </form> | ||
71 | </div> | ||
72 | </td> | ||
73 | <td class="plugincontent"> | ||
74 | <h1>Plugin API reference</h1> | ||
75 | <ul> | ||
76 | %GROUP_START% | ||
77 | <li>%GROUP_NAME% | ||
78 | <ul> | ||
79 | %FUNCTION_START% | ||
80 | <li><a href="%GROUP%.html#%FUNCTION%">%FUNCTION_NAME%</a></li> | ||
81 | %FUNCTION_END% | ||
82 | </ul> | ||
83 | </li> | ||
84 | %GROUP_END% | ||
85 | </ul> | ||
86 | </td> | ||
87 | </tr> | ||
88 | </table> | ||
22 | </body> | 89 | </body> |
23 | </html> \ No newline at end of file | 90 | </html> \ No newline at end of file |
diff --git a/utils/rockbox_api/layout.css b/utils/rockbox_api/layout.css index 09e7391197..09aaff11a3 100644 --- a/utils/rockbox_api/layout.css +++ b/utils/rockbox_api/layout.css | |||
@@ -1,77 +1,77 @@ | |||
1 | body | 1 | .plugincontent |
2 | { | 2 | { |
3 | font-family: Verdana; | 3 | font-family: Verdana; |
4 | } | 4 | } |
5 | 5 | ||
6 | li | 6 | .plugincontent li |
7 | { | 7 | { |
8 | font-size: 10px; | 8 | font-size: 10px; |
9 | } | 9 | } |
10 | 10 | ||
11 | code | 11 | .plugincontent code |
12 | { | 12 | { |
13 | color: #00A; | 13 | color: #00A; |
14 | } | 14 | } |
15 | 15 | ||
16 | .see, .see a | 16 | .plugincontent .see, .plugincontent .see a |
17 | { | 17 | { |
18 | color: #559; | 18 | color: #559; |
19 | } | 19 | } |
20 | 20 | ||
21 | .group | 21 | .plugincontent .group |
22 | { | 22 | { |
23 | font-size: 12px; | 23 | font-size: 12px; |
24 | } | 24 | } |
25 | 25 | ||
26 | .group h3 | 26 | .plugincontent .group h3 |
27 | { | 27 | { |
28 | font-size: 14px; | 28 | font-size: 14px; |
29 | } | 29 | } |
30 | 30 | ||
31 | h2 | 31 | .plugincontent h2 |
32 | { | 32 | { |
33 | color: #D11; | 33 | color: #D11; |
34 | } | 34 | } |
35 | 35 | ||
36 | a | 36 | .plugincontent a |
37 | { | 37 | { |
38 | color: blue; | 38 | color: blue; |
39 | } | 39 | } |
40 | 40 | ||
41 | a:hover | 41 | .plugincontent a:hover |
42 | { | 42 | { |
43 | color: red; | 43 | color: red; |
44 | } | 44 | } |
45 | 45 | ||
46 | .top | 46 | .plugincontent .top |
47 | { | 47 | { |
48 | font-size: 10px; | 48 | font-size: 10px; |
49 | color: green; | 49 | color: green; |
50 | } | 50 | } |
51 | 51 | ||
52 | .extra | 52 | .plugincontent .extra |
53 | { | 53 | { |
54 | font-weight: bold; | 54 | font-weight: bold; |
55 | color: #992; | 55 | color: #992; |
56 | } | 56 | } |
57 | 57 | ||
58 | dl | 58 | .plugincontent dl |
59 | { | 59 | { |
60 | border-left: 1px solid #CCC; | 60 | border-left: 1px solid #CCC; |
61 | padding-left: 10px; | 61 | padding-left: 10px; |
62 | } | 62 | } |
63 | 63 | ||
64 | dt, dd | 64 | .plugincontent dt, .plugincontent dd |
65 | { | 65 | { |
66 | font-style: normal; | 66 | font-style: normal; |
67 | } | 67 | } |
68 | 68 | ||
69 | dd | 69 | .plugincontent dd |
70 | { | 70 | { |
71 | margin-left: 12em; | 71 | margin-left: 12em; |
72 | } | 72 | } |
73 | 73 | ||
74 | dt | 74 | .plugincontent dt |
75 | { | 75 | { |
76 | clear: left; | 76 | clear: left; |
77 | display: block; | 77 | display: block; |
@@ -80,29 +80,28 @@ dt | |||
80 | width: 12em; | 80 | width: 12em; |
81 | } | 81 | } |
82 | 82 | ||
83 | hr | 83 | .plugincontent hr |
84 | { | 84 | { |
85 | border: 1px solid #CCCCCC; | 85 | border: 1px solid #CCCCCC; |
86 | margin: 1em 0; | 86 | margin: 1em 0; |
87 | } | 87 | } |
88 | 88 | ||
89 | #content | 89 | .plugincontent #content |
90 | { | 90 | { |
91 | margin-left: 14em; | 91 | margin-left: 14em; |
92 | margin-right: 1em; | 92 | margin-right: 1em; |
93 | padding: 0; | 93 | padding: 0; |
94 | } | 94 | } |
95 | 95 | ||
96 | #menu | 96 | .plugincontent #menu |
97 | { | 97 | { |
98 | position: fixed; | 98 | position: absolute; |
99 | top: 0px; | 99 | left: 120px; /* I hate IE */ |
100 | left: 0px; | ||
101 | width: 14em; | 100 | width: 14em; |
102 | padding: 0; | 101 | padding: 0; |
103 | } | 102 | } |
104 | 103 | ||
105 | #menu ul | 104 | .plugincontent #menu ul |
106 | { | 105 | { |
107 | padding-left: 1em; | 106 | padding-left: 1em; |
108 | } \ No newline at end of file | 107 | } \ No newline at end of file |
diff --git a/utils/rockbox_api/section.tpl b/utils/rockbox_api/section.tpl index 874703cb9c..77304c1a65 100644 --- a/utils/rockbox_api/section.tpl +++ b/utils/rockbox_api/section.tpl | |||
@@ -1,50 +1,118 @@ | |||
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
2 | <html> | 2 | <html> |
3 | <head> | 3 | <head> |
4 | <link href="layout.css" rel="stylesheet" type="text/css" /> | 4 | <link href="layout.css" rel="stylesheet" type="text/css" /> |
5 | <title>Plugin API - %GROUP_NAME%</title> | 5 | <link rel="STYLESHEET" type="text/css" href="http://www.rockbox.org/style.css"> |
6 | <link rel="shortcut icon" href="http://www.rockbox.org/favicon.ico"> | ||
7 | <title>Rockbox Plugin API - %GROUP_NAME%</title> | ||
8 | <meta name="author" content="Rockbox Contributors"> | ||
6 | </head> | 9 | </head> |
7 | 10 | ||
8 | <body> | 11 | <body> |
9 | <div id="menu">%MENU%</div> | 12 | <table border=0 cellpadding=7 cellspacing=0> |
10 | <div id="content"> | 13 | <tr valign="top"> |
11 | <a link="top"></a> | 14 | <td bgcolor="#6887bb" valign="top"> |
12 | <h2>%GROUP_NAME%</h2> | 15 | <br> |
13 | <span class="group"> | 16 | <div align="center"> |
14 | %FUNCTION_START% | 17 | <a href="http://www.rockbox.org/"> |
15 | <a id="%FUNCTION_NAME%"></a> | 18 | <img src="http://www.rockbox.org/rockbox100.png" width=99 height=30 border=0 alt="Rockbox.org home"></a> |
16 | <h3>%FUNCTION%</h3> | ||
17 | |||
18 | %DESCRIPTION_START% | ||
19 | %FUNCTION_DESCRIPTION% | ||
20 | <br /><br /> | ||
21 | %DESCRIPTION_END% | ||
22 | |||
23 | %PARAMETER_START% | ||
24 | <span class="extra">Parameters:</span> | ||
25 | <dl> | ||
26 | %PARAMETERS_START% | ||
27 | <dt>%PARAM1%</dt><dd>%PARAM2%</dd> | ||
28 | %PARAMETERS_END% | ||
29 | </dl> | ||
30 | %PARAMETER_END% | ||
31 | |||
32 | %RETURN_START% | ||
33 | <span class="extra">Returns:</span> %RETURN%<br /><br /> | ||
34 | %RETURN_END% | ||
35 | |||
36 | %CONDITIONS_START% | ||
37 | <span class="extra">Conditions:</span> %CONDITIONS%<br /><br /> | ||
38 | %CONDITIONS_END% | ||
39 | |||
40 | %SEE_START% | ||
41 | <span class="see">Also see %SEE%</span><br /><br /> | ||
42 | %SEE_END% | ||
43 | |||
44 | <a href="#top" class="top">To top</a><hr /> | ||
45 | |||
46 | %FUNCTION_END% | ||
47 | </span> | ||
48 | </div> | 19 | </div> |
20 | <div style="margin-top:20px"> | ||
21 | <div class="submenu"> | ||
22 | Downloads | ||
23 | </div> | ||
24 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/package.png' align='top'> <a class="menulink" href="http://www.rockbox.org/download/">releases</a><br> | ||
25 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/bomb.png' align='top'> <a class="menulink" href="http://build.rockbox.org">current build</a><br> | ||
26 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/style.png' align='top'> <a class="menulink" href="http://www.rockbox.org/twiki/bin/view/Main/RockboxExtras">extras</a> | ||
27 | <div class="submenu"> | ||
28 | Documentation | ||
29 | |||
30 | </div> | ||
31 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/page_white_acrobat.png' align='top'> <a class="menulink" href="http://www.rockbox.org/manual.shtml">manual</a><br> | ||
32 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/application_edit.png' align='top'> <a class="menulink" href="http://www.rockbox.org/twiki/">wiki</a><br> | ||
33 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/book_open.png' align='top'> <a class="menulink" href="http://www.rockbox.org/twiki/bin/view/Main/DocsIndex">docs index</a> | ||
34 | <div class="submenu"> | ||
35 | Support | ||
36 | </div> | ||
37 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/email.png' align='top'> <a class="menulink" href="http://www.rockbox.org/mail/">mailing lists</a><br> | ||
38 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/group.png' align='top'> <a class="menulink" href="http://www.rockbox.org/irc/">IRC</a><br> | ||
39 | |||
40 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/comment_edit.png' align='top'> <a class="menulink" href="http://forums.rockbox.org/">forums</a> | ||
41 | <div class="submenu"> | ||
42 | Tracker | ||
43 | </div> | ||
44 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/bug.png' align='top'> <a class="menulink" href="http://www.rockbox.org/tracker/index.php?type=2">bugs</a><br> | ||
45 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/brick.png' align='top'> <a class="menulink" href="http://www.rockbox.org/tracker/index.php?type=4">patches</a><br> | ||
46 | <img width=16 height=16 src='http://www.rockbox.org/silk_icons/lightbulb.png' align='top'> <a class="menulink" href="http://www.rockbox.org/tracker/index.php?type=1">requests</a><br> | ||
47 | <div class="submenu"> | ||
48 | Search | ||
49 | </div> | ||
50 | |||
51 | <form id="fsform" action="http://www.rockbox.org/tracker/index.php" method="get" onSubmit="return fsstrip();"> | ||
52 | <input id="taskid" name="show_task" type="text" size="10" maxlength="10" accesskey="t"><br> | ||
53 | <input class="mainbutton" type="submit" value="Flyspray #"> | ||
54 | </form> | ||
55 | <br> | ||
56 | <form action="http://www.google.com/search"> | ||
57 | <input name=as_q size=10><br> | ||
58 | <input value="Search" type=submit> | ||
59 | <input type=hidden name=as_sitesearch value="www.rockbox.org"> | ||
60 | </form> | ||
61 | <p><form action="https://www.paypal.com/cgi-bin/webscr" method="get"> | ||
62 | <input type="hidden" name="cmd" value="_xclick"> | ||
63 | <input type="hidden" name="business" value="bjorn@haxx.se"> | ||
64 | <input type="hidden" name="item_name" value="Donation to the Rockbox project"> | ||
65 | <input type="hidden" name="no_shipping" value="1"> | ||
66 | <input type="hidden" name="cn" value="Note to the Rockbox team"> | ||
67 | <input type="hidden" name="currency_code" value="USD"> | ||
68 | |||
69 | <input type="hidden" name="tax" value="0"> | ||
70 | <input type="image" src="http://www.rockbox.org/paypal-donate.gif" name="submit"> | ||
71 | </form> | ||
72 | </div> | ||
73 | </td> | ||
74 | <td class="plugincontent"> | ||
75 | <div id="menu">%MENU%</div> | ||
76 | <div id="content"> | ||
77 | <a id="top"></a> | ||
78 | <h2>%GROUP_NAME%</h2> | ||
79 | <span class="group"> | ||
80 | %FUNCTION_START% | ||
81 | <a id="%FUNCTION_NAME%"></a> | ||
82 | <h3>%FUNCTION%</h3> | ||
83 | |||
84 | %DESCRIPTION_START% | ||
85 | %FUNCTION_DESCRIPTION% | ||
86 | <br /><br /> | ||
87 | %DESCRIPTION_END% | ||
88 | |||
89 | %PARAMETER_START% | ||
90 | <span class="extra">Parameters:</span> | ||
91 | <dl> | ||
92 | %PARAMETERS_START% | ||
93 | <dt>%PARAM1%</dt><dd>%PARAM2%</dd> | ||
94 | %PARAMETERS_END% | ||
95 | </dl> | ||
96 | %PARAMETER_END% | ||
97 | |||
98 | %RETURN_START% | ||
99 | <span class="extra">Returns:</span> %RETURN%<br /><br /> | ||
100 | %RETURN_END% | ||
101 | |||
102 | %CONDITIONS_START% | ||
103 | <span class="extra">Conditions:</span> %CONDITIONS%<br /><br /> | ||
104 | %CONDITIONS_END% | ||
105 | |||
106 | %SEE_START% | ||
107 | <span class="see">Also see %SEE%</span><br /><br /> | ||
108 | %SEE_END% | ||
109 | |||
110 | <a href="#top" class="top">To top</a><hr /> | ||
111 | %FUNCTION_END% | ||
112 | </span> | ||
113 | </div> | ||
114 | </td> | ||
115 | </tr> | ||
116 | </table> | ||
49 | </body> | 117 | </body> |
50 | </html> \ No newline at end of file | 118 | </html> \ No newline at end of file |