voloko-sdoc 0.2.7 → 0.2.8

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 (18) hide show
  1. data/Rakefile +37 -0
  2. data/VERSION.yml +1 -1
  3. data/lib/sdoc/generator/template/direct/_context.rhtml +2 -1
  4. data/lib/sdoc/generator/template/direct/class.rhtml +3 -3
  5. data/lib/sdoc/generator/template/direct/file.rhtml +3 -3
  6. data/lib/sdoc/generator/template/direct/index.rhtml +1 -1
  7. data/lib/sdoc/generator/template/direct/resources/css/main.css +16 -0
  8. data/lib/sdoc/generator/template/direct/resources/js/searchdoc.js +2 -1
  9. data/lib/sdoc/generator/template/direct/resources/panel/index.html +2 -0
  10. data/lib/sdoc/generator/template/merge/index.rhtml +1 -1
  11. data/lib/sdoc/generator/template/shtml/_context.rhtml +2 -1
  12. data/lib/sdoc/generator/template/shtml/class.rhtml +3 -3
  13. data/lib/sdoc/generator/template/shtml/file.rhtml +3 -3
  14. data/lib/sdoc/generator/template/shtml/index.rhtml +1 -1
  15. data/lib/sdoc/generator/template/shtml/resources/js/searchdoc.js +2 -1
  16. data/lib/sdoc/generator/template/shtml/resources/panel/index.html +2 -0
  17. data/lib/sdoc/merge.rb +4 -4
  18. metadata +6 -22
data/Rakefile ADDED
@@ -0,0 +1,37 @@
1
+ require 'rake/testtask'
2
+ require 'rake/gempackagetask'
3
+
4
+ task :default => :test
5
+
6
+ Rake::TestTask.new("test") do |t|
7
+ t.libs << 'test'
8
+ t.pattern = 'test/**/*_test.rb'
9
+ t.warning = true
10
+ t.verbose = true
11
+ end
12
+
13
+ desc "Generate file list for .gemspec"
14
+ task :gem_file_list do
15
+ f = FileList.new
16
+ f.include('lib/**/**')
17
+ f.include('rdoc/**/**')
18
+ f.exclude('rdoc/test/**/**')
19
+ print "%w(" + f.to_a.select{|file| !File.directory? file }.join(' ') + ")\n"
20
+ end
21
+
22
+ begin
23
+ require 'jeweler'
24
+ Jeweler::Tasks.new do |gem|
25
+ gem.name = "sdoc"
26
+ gem.summary = "rdoc html with javascript search index."
27
+ gem.email = "voloko@gmail.com"
28
+ gem.homepage = "http://github.com/voloko/sdoc"
29
+ gem.authors = ["Volodya Kolesnikov"]
30
+ gem.add_dependency("json", ">= 1.1.3")
31
+ gem.add_dependency("rdoc", ">= 2.4.2")
32
+
33
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
34
+ end
35
+ rescue LoadError
36
+ puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
37
+ end
data/VERSION.yml CHANGED
@@ -1,4 +1,4 @@
1
1
  ---
2
2
  :minor: 2
3
- :patch: 7
3
+ :patch: 8
4
4
  :major: 0
data/lib/sdoc/generator/template/direct/_context.rhtml CHANGED
@@ -130,7 +130,8 @@
130
130
  </div>
131
131
  <% unless (description = method.description).empty? %>
132
132
  <div class="description">
133
- <%= description %>
133
+ <%# TODO delete this dirty hack when documentation for example for JavaScriptHelper will not be cutted off by <script> tag %>
134
+ <%= description.gsub('<script>'){ |m| h(m) } %>
134
135
  </div>
135
136
  <% end %>
136
137
  <% unless method.aliases.empty? %>
data/lib/sdoc/generator/template/direct/class.rhtml CHANGED
@@ -1,10 +1,10 @@
1
- <?xml version="1.0" encoding="%charset%"?>
1
+ <?xml version="1.0" encoding="utf-8"?>
2
2
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
- <html>
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
6
  <title><%= h klass.full_name %></title>
7
- <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
7
+ <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
8
8
  <link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" />
9
9
  <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
10
10
  <script src="<%= "#{rel_prefix}/js/jquery-1.3.2.min.js" %>" type="text/javascript" charset="utf-8"></script>
data/lib/sdoc/generator/template/direct/file.rhtml CHANGED
@@ -1,10 +1,10 @@
1
- <?xml version="1.0" encoding="%charset%"?>
1
+ <?xml version="1.0" encoding="utf-8"?>
2
2
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
- <html>
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
6
  <title><%= h file.name %></title>
7
- <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
7
+ <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
8
8
  <link rel="stylesheet" href="<%= "#{rel_prefix}/css/reset.css" %>" type="text/css" media="screen" />
9
9
  <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
10
10
  <script src="<%= "#{rel_prefix}/js/jquery-1.3.2.min.js" %>" type="text/javascript" charset="utf-8"></script>
data/lib/sdoc/generator/template/direct/index.rhtml CHANGED
@@ -3,7 +3,7 @@
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
4
4
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
- <meta http-equiv="Content-Type" content="text/html;"/>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
7
7
 
8
8
  <title><%= @options.title %></title>
9
9
  </head>
data/lib/sdoc/generator/template/direct/resources/css/main.css CHANGED
@@ -53,7 +53,22 @@ h4 {
53
53
  width: 0; height: 0;
54
54
  }
55
55
 
56
+ dt
57
+ {
58
+ margin-bottom: 0.3em;
59
+ font-weight: bold;
60
+ }
56
61
 
62
+ dd
63
+ {
64
+ margin-left: 2em;
65
+ margin-bottom: 1em;
66
+ }
67
+
68
+ dd p
69
+ {
70
+ margin-top: 0.6em;
71
+ }
57
72
 
58
73
  li
59
74
  {
@@ -120,6 +135,7 @@ pre
120
135
  color:#AAA;
121
136
  position: absolute;
122
137
  font-weight: normal;
138
+ margin: 0;
123
139
  }
124
140
 
125
141
  .methods dd
data/lib/sdoc/generator/template/direct/resources/js/searchdoc.js CHANGED
@@ -403,7 +403,8 @@ Searchdoc.Panel.prototype = $.extend({}, Searchdoc.Navigation, new function() {
403
403
  var li = document.createElement('li'),
404
404
  html = '', badge = result.badge;
405
405
  html += '<h1>' + hlt(result.title);
406
- if (result.params) html += '<i>' + result.params + '</i></h1>';
406
+ if (result.params) html += '<i>' + result.params + '</i>';
407
+ html += '</h1>';
407
408
  html += '<p>';
408
409
  if (typeof badge != 'undefined') {
409
410
  badge = badge % 6;
data/lib/sdoc/generator/template/direct/resources/panel/index.html CHANGED
@@ -12,6 +12,7 @@
12
12
  <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
13
13
  <script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
14
14
  <script type="text/javascript" charset="utf-8">
15
+ //<![CDATA[
15
16
  function placeholder() {
16
17
  if (jQuery.browser.safari) return;
17
18
  $('#search-label').click(function() {
@@ -35,6 +36,7 @@
35
36
  new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
36
37
  $('#search').focus();
37
38
  })
39
+ //]]>
38
40
  </script>
39
41
  </head>
40
42
  <body>
data/lib/sdoc/generator/template/merge/index.rhtml CHANGED
@@ -3,7 +3,7 @@
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
4
4
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
- <meta http-equiv="Content-Type" content="text/html; charset=%charset%"/>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
7
 
8
8
  <title><%= @title %></title>
9
9
  </head>
data/lib/sdoc/generator/template/shtml/_context.rhtml CHANGED
@@ -123,7 +123,8 @@
123
123
  </div>
124
124
  <% unless (description = method.description).empty? %>
125
125
  <div class="description">
126
- <%= description %>
126
+ <%# TODO delete this dirty hack when documentation for example for JavaScriptHelper will not be cutted off by <script> tag %>
127
+ <%= description.gsub('<script>'){ |m| h(m) } %>
127
128
  </div>
128
129
  <% end %>
129
130
  <% unless method.aliases.empty? %>
data/lib/sdoc/generator/template/shtml/class.rhtml CHANGED
@@ -1,10 +1,10 @@
1
- <?xml version="1.0" encoding="%charset%"?>
1
+ <?xml version="1.0" encoding="utf-8"?>
2
2
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
- <html>
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
6
  <title><%= h klass.full_name %></title>
7
- <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
7
+ <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
8
8
  <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
9
9
  <script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
10
10
  </head>
data/lib/sdoc/generator/template/shtml/file.rhtml CHANGED
@@ -1,10 +1,10 @@
1
- <?xml version="1.0" encoding="%charset%"?>
1
+ <?xml version="1.0" encoding="utf-8"?>
2
2
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
- <html>
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
6
  <title><%= h file.name %></title>
7
- <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
7
+ <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
8
8
  <link rel="stylesheet" href="<%= "#{rel_prefix}/css/main.css" %>" type="text/css" media="screen" />
9
9
  <script src="<%= "#{rel_prefix}/js/main.js" %>" type="text/javascript" charset="utf-8"></script>
10
10
  </head>
data/lib/sdoc/generator/template/shtml/index.rhtml CHANGED
@@ -3,7 +3,7 @@
3
3
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
4
4
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
  <head>
6
- <meta http-equiv="Content-Type" content="text/html;"/>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=<%= @options.charset %>" />
7
7
 
8
8
  <title><%= @options.title %></title>
9
9
  </head>
data/lib/sdoc/generator/template/shtml/resources/js/searchdoc.js CHANGED
@@ -403,7 +403,8 @@ Searchdoc.Panel.prototype = $.extend({}, Searchdoc.Navigation, new function() {
403
403
  var li = document.createElement('li'),
404
404
  html = '', badge = result.badge;
405
405
  html += '<h1>' + hlt(result.title);
406
- if (result.params) html += '<i>' + result.params + '</i></h1>';
406
+ if (result.params) html += '<i>' + result.params + '</i>';
407
+ html += '</h1>';
407
408
  html += '<p>';
408
409
  if (typeof badge != 'undefined') {
409
410
  badge = badge % 6;
data/lib/sdoc/generator/template/shtml/resources/panel/index.html CHANGED
@@ -12,6 +12,7 @@
12
12
  <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
13
13
  <script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
14
14
  <script type="text/javascript" charset="utf-8">
15
+ //<![CDATA[
15
16
  function placeholder() {
16
17
  if (jQuery.browser.safari) return;
17
18
  $('#search-label').click(function() {
@@ -35,6 +36,7 @@
35
36
  new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
36
37
  $('#search').focus();
37
38
  })
39
+ //]]>
38
40
  </script>
39
41
  </head>
40
42
  <body>
data/lib/sdoc/merge.rb CHANGED
@@ -171,7 +171,7 @@ class SDoc::Merge
171
171
  @directories.each_with_index do |dir, i|
172
172
  name = @names[i]
173
173
  index_dir = File.dirname(RDoc::Generator::SHtml::TREE_FILE)
174
- FileUtils.mkdir_p(File.join @op_dir, name)
174
+ FileUtils.mkdir_p(File.join(@op_dir, name))
175
175
 
176
176
  Dir.new(dir).each do |item|
177
177
  if File.directory?(File.join(dir, item)) && item != '.' && item != '..' && item != index_dir
@@ -199,9 +199,9 @@ class SDoc::Merge
199
199
 
200
200
  def check_directories
201
201
  @directories.each do |dir|
202
- unless File.exists?(File.join dir, FLAG_FILE) &&
203
- File.exists?(File.join dir, RDoc::Generator::SHtml::TREE_FILE) &&
204
- File.exists?(File.join dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE)
202
+ unless File.exists?(File.join(dir, FLAG_FILE)) &&
203
+ File.exists?(File.join(dir, RDoc::Generator::SHtml::TREE_FILE)) &&
204
+ File.exists?(File.join(dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE))
205
205
  error "#{dir} does not seem to be an sdoc directory"
206
206
  end
207
207
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voloko-sdoc
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.7
4
+ version: 0.2.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Volodya Kolesnikov
@@ -9,7 +9,7 @@ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
11
 
12
- date: 2009-04-09 00:00:00 -07:00
12
+ date: 2009-04-13 00:00:00 -07:00
13
13
  default_executable:
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
@@ -40,72 +40,56 @@ executables:
40
40
  extensions: []
41
41
 
42
42
  extra_rdoc_files:
43
- - README.rdoc
44
43
  - LICENSE
44
+ - README.rdoc
45
45
  files:
46
+ - LICENSE
46
47
  - README.rdoc
48
+ - Rakefile
47
49
  - VERSION.yml
48
50
  - bin/sdoc
49
51
  - bin/sdoc-merge
50
- - lib/sdoc
52
+ - lib/sdoc.rb
51
53
  - lib/sdoc/c_parser_fix.rb
52
- - lib/sdoc/generator
53
54
  - lib/sdoc/generator/shtml.rb
54
- - lib/sdoc/generator/template
55
- - lib/sdoc/generator/template/direct
56
55
  - lib/sdoc/generator/template/direct/_context.rhtml
57
56
  - lib/sdoc/generator/template/direct/class.rhtml
58
57
  - lib/sdoc/generator/template/direct/file.rhtml
59
58
  - lib/sdoc/generator/template/direct/index.rhtml
60
- - lib/sdoc/generator/template/direct/resources
61
- - lib/sdoc/generator/template/direct/resources/css
62
59
  - lib/sdoc/generator/template/direct/resources/css/main.css
63
60
  - lib/sdoc/generator/template/direct/resources/css/panel.css
64
61
  - lib/sdoc/generator/template/direct/resources/css/reset.css
65
- - lib/sdoc/generator/template/direct/resources/i
66
62
  - lib/sdoc/generator/template/direct/resources/i/arrows.png
67
63
  - lib/sdoc/generator/template/direct/resources/i/results_bg.png
68
64
  - lib/sdoc/generator/template/direct/resources/i/tree_bg.png
69
- - lib/sdoc/generator/template/direct/resources/js
70
65
  - lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js
71
66
  - lib/sdoc/generator/template/direct/resources/js/jquery-effect.js
72
67
  - lib/sdoc/generator/template/direct/resources/js/main.js
73
68
  - lib/sdoc/generator/template/direct/resources/js/searchdoc.js
74
- - lib/sdoc/generator/template/direct/resources/panel
75
69
  - lib/sdoc/generator/template/direct/resources/panel/index.html
76
- - lib/sdoc/generator/template/merge
77
70
  - lib/sdoc/generator/template/merge/index.rhtml
78
- - lib/sdoc/generator/template/shtml
79
71
  - lib/sdoc/generator/template/shtml/_context.rhtml
80
72
  - lib/sdoc/generator/template/shtml/class.rhtml
81
73
  - lib/sdoc/generator/template/shtml/file.rhtml
82
74
  - lib/sdoc/generator/template/shtml/index.rhtml
83
- - lib/sdoc/generator/template/shtml/resources
84
- - lib/sdoc/generator/template/shtml/resources/css
85
75
  - lib/sdoc/generator/template/shtml/resources/css/main.css
86
76
  - lib/sdoc/generator/template/shtml/resources/css/panel.css
87
77
  - lib/sdoc/generator/template/shtml/resources/css/reset.css
88
- - lib/sdoc/generator/template/shtml/resources/i
89
78
  - lib/sdoc/generator/template/shtml/resources/i/arrows.png
90
79
  - lib/sdoc/generator/template/shtml/resources/i/results_bg.png
91
80
  - lib/sdoc/generator/template/shtml/resources/i/tree_bg.png
92
- - lib/sdoc/generator/template/shtml/resources/js
93
81
  - lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js
94
82
  - lib/sdoc/generator/template/shtml/resources/js/main.js
95
83
  - lib/sdoc/generator/template/shtml/resources/js/searchdoc.js
96
- - lib/sdoc/generator/template/shtml/resources/panel
97
84
  - lib/sdoc/generator/template/shtml/resources/panel/index.html
98
85
  - lib/sdoc/github.rb
99
86
  - lib/sdoc/helpers.rb
100
87
  - lib/sdoc/merge.rb
101
88
  - lib/sdoc/templatable.rb
102
- - lib/sdoc.rb
103
- - LICENSE
104
89
  has_rdoc: true
105
90
  homepage: http://github.com/voloko/sdoc
106
91
  post_install_message:
107
92
  rdoc_options:
108
- - --inline-source
109
93
  - --charset=UTF-8
110
94
  require_paths:
111
95
  - lib