hoe-manualgen 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- data.tar.gz.sig +0 -0
- data/ChangeLog +333 -0
- data/History.rdoc +28 -0
- data/Manifest.txt +41 -0
- data/{README.md → README.rdoc} +11 -12
- data/Rakefile +14 -57
- data/data/hoe-manualgen/lib/api-filter.rb +2 -2
- data/data/hoe-manualgen/lib/editorial-filter.rb +16 -16
- data/data/hoe-manualgen/lib/examples-filter.rb +40 -48
- data/data/hoe-manualgen/lib/links-filter.rb +21 -21
- data/data/hoe-manualgen/resources/css/reset.css +112 -0
- data/lib/hoe/manualgen.rb +14 -15
- metadata +60 -83
- metadata.gz.sig +0 -0
- data/History.md +0 -16
@@ -0,0 +1,112 @@
|
|
1
|
+
/* @group Reset */
|
2
|
+
|
3
|
+
html,body,div,span,a,img,h1,h2,h3,h4,h5,h6,hgroup,p,dl,dialog,dt,dd,ol,ul,li,abbr,
|
4
|
+
acronym,address,b,big,blockquote,cite,code,del,dfn,em,i,ins,kbd,pre,q,samp,tt,var,
|
5
|
+
small,strong,sub,sup,object,iframe,form,fieldset,label,legend,table,caption,tbody,
|
6
|
+
tfoot,thead,tr,th,td,article,aside,footer,header,nav,section,figure,menu,time,mark,
|
7
|
+
audio,video {
|
8
|
+
font-family: inherit;
|
9
|
+
font-size: 100%;
|
10
|
+
font-weight: inherit;
|
11
|
+
font-style: inherit;
|
12
|
+
vertical-align: baseline;
|
13
|
+
white-space: normal;
|
14
|
+
text-align: left;
|
15
|
+
margin: 0;
|
16
|
+
padding: 0;
|
17
|
+
border: 0;
|
18
|
+
outline: 0;
|
19
|
+
background: transparent
|
20
|
+
}
|
21
|
+
|
22
|
+
textarea {
|
23
|
+
font-family: inherit;
|
24
|
+
font-size: 100%;
|
25
|
+
font-weight: normal;
|
26
|
+
font-style: normal;
|
27
|
+
white-space: normal;
|
28
|
+
text-align: left;
|
29
|
+
margin: 0;
|
30
|
+
padding: 0
|
31
|
+
}
|
32
|
+
|
33
|
+
article,aside,footer,header,nav,section,dialog,figure,hgroup,menu {
|
34
|
+
display: block
|
35
|
+
}
|
36
|
+
|
37
|
+
h1,h2,h3,h4,h5,h6 {
|
38
|
+
font-size: 100%;
|
39
|
+
font-weight: normal
|
40
|
+
}
|
41
|
+
|
42
|
+
del,ins {
|
43
|
+
text-decoration: none
|
44
|
+
}
|
45
|
+
|
46
|
+
ol,ul {
|
47
|
+
list-style: none
|
48
|
+
}
|
49
|
+
|
50
|
+
nav ul {
|
51
|
+
list-style-type: none
|
52
|
+
}
|
53
|
+
|
54
|
+
table {
|
55
|
+
border-collapse: separate;
|
56
|
+
border-spacing: 0;
|
57
|
+
background-color: transparent;
|
58
|
+
width: auto;
|
59
|
+
height: auto
|
60
|
+
}
|
61
|
+
|
62
|
+
:focus {
|
63
|
+
outline: 0
|
64
|
+
}
|
65
|
+
|
66
|
+
blockquote:before,blockquote:after,q:before,q:after {
|
67
|
+
content: ""
|
68
|
+
}
|
69
|
+
|
70
|
+
blockquote,q {
|
71
|
+
quotes: "" ""
|
72
|
+
}
|
73
|
+
|
74
|
+
input {
|
75
|
+
margin: 0
|
76
|
+
}
|
77
|
+
|
78
|
+
applet,basefont,dir,font,isindex,menu,s,strike,u {
|
79
|
+
font-family: inherit;
|
80
|
+
font-size: 100%;
|
81
|
+
font-weight: normal;
|
82
|
+
font-style: normal;
|
83
|
+
white-space: normal;
|
84
|
+
vertical-align: baseline;
|
85
|
+
text-decoration: inherit;
|
86
|
+
text-align: left;
|
87
|
+
color: inherit;
|
88
|
+
margin: 0;
|
89
|
+
padding: 0;
|
90
|
+
border: 0;
|
91
|
+
outline: 0
|
92
|
+
}
|
93
|
+
|
94
|
+
dir,menu {
|
95
|
+
list-style: none
|
96
|
+
}
|
97
|
+
|
98
|
+
nobr {
|
99
|
+
white-space: normal
|
100
|
+
}
|
101
|
+
|
102
|
+
blink {
|
103
|
+
text-decoration: none
|
104
|
+
}
|
105
|
+
|
106
|
+
marquee {
|
107
|
+
overflow: visible
|
108
|
+
}
|
109
|
+
|
110
|
+
/* @end */
|
111
|
+
|
112
|
+
|
data/lib/hoe/manualgen.rb
CHANGED
@@ -31,10 +31,10 @@ module Hoe::ManualGen
|
|
31
31
|
include FileUtils::DryRun if Rake.application.options.dryrun
|
32
32
|
|
33
33
|
# Library version constant
|
34
|
-
VERSION = '0.
|
34
|
+
VERSION = '0.3.0'
|
35
35
|
|
36
36
|
# Version-control revision constant
|
37
|
-
REVISION = %q$Revision:
|
37
|
+
REVISION = %q$Revision: cbd7dd95d043 $
|
38
38
|
|
39
39
|
# Configuration defaults
|
40
40
|
DEFAULT_BASE_DIR = Pathname( 'manual' )
|
@@ -60,21 +60,23 @@ module Hoe::ManualGen
|
|
60
60
|
DEFAULT_LIB_DIR,
|
61
61
|
]
|
62
62
|
|
63
|
-
|
64
|
-
module TraceFunctions
|
63
|
+
module Logging
|
65
64
|
|
66
|
-
### Output a message
|
65
|
+
### Output a logging message
|
66
|
+
def log( message )
|
67
|
+
$stderr.puts( message )
|
68
|
+
end
|
69
|
+
|
70
|
+
### Output a message if tracing or running in verbose mode
|
67
71
|
def trace( *messages )
|
68
|
-
|
69
|
-
$stderr.puts( messages )
|
72
|
+
$stderr.puts( messages.join ) if $VERBOSE || Rake.application.options.trace
|
70
73
|
end
|
71
74
|
|
72
|
-
end
|
75
|
+
end
|
73
76
|
|
74
77
|
|
75
78
|
### Manual page-generation class
|
76
79
|
class Page
|
77
|
-
include Hoe::ManualGen::TraceFunctions
|
78
80
|
|
79
81
|
### The default page configuration if none is specified.
|
80
82
|
DEFAULT_CONFIG = {
|
@@ -215,7 +217,6 @@ module Hoe::ManualGen
|
|
215
217
|
def cleanup( source )
|
216
218
|
require 'tidy'
|
217
219
|
|
218
|
-
Tidy.path = '/usr/lib/libtidy.dylib'
|
219
220
|
Tidy.open( TIDY_OPTIONS ) do |tidy|
|
220
221
|
tidy.options.output_xhtml = true
|
221
222
|
|
@@ -234,7 +235,7 @@ module Hoe::ManualGen
|
|
234
235
|
### Get (singleton) instances of the filters named in +filterlist+ and return them.
|
235
236
|
def load_filters( filterlist )
|
236
237
|
filterlist.flatten.collect do |key|
|
237
|
-
raise ArgumentError, "filter '#{key}'
|
238
|
+
raise ArgumentError, "filter '#{key}' didn't load correctly" unless
|
238
239
|
Hoe::ManualGen::PageFilter.derivatives.key?( key )
|
239
240
|
Hoe::ManualGen::PageFilter.derivatives[ key ].instance
|
240
241
|
end
|
@@ -282,7 +283,7 @@ module Hoe::ManualGen
|
|
282
283
|
|
283
284
|
### A catalog of Page objects that can be referenced by filters.
|
284
285
|
class PageCatalog
|
285
|
-
include Hoe::ManualGen::
|
286
|
+
include Hoe::ManualGen::Logging
|
286
287
|
|
287
288
|
### Create a new PageCatalog that will load Page objects for .page files
|
288
289
|
### in the specified +sourcedir+.
|
@@ -478,7 +479,7 @@ module Hoe::ManualGen
|
|
478
479
|
### An abstract filter class for manual content transformation.
|
479
480
|
class PageFilter
|
480
481
|
include Singleton,
|
481
|
-
Hoe::ManualGen::
|
482
|
+
Hoe::ManualGen::Logging
|
482
483
|
|
483
484
|
# A list of inheriting classes, keyed by normalized name
|
484
485
|
@derivatives = {}
|
@@ -574,8 +575,6 @@ module Hoe::ManualGen
|
|
574
575
|
@manual_metadata = DEFAULT_METADATA
|
575
576
|
@manual_paths = {}
|
576
577
|
|
577
|
-
$trace = Rake.application.options.trace
|
578
|
-
|
579
578
|
self.extra_dev_deps << ['hoe-manualgen', "~> #{VERSION}"] unless
|
580
579
|
self.name == 'hoe-manualgen'
|
581
580
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: hoe-manualgen
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,61 +9,49 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain:
|
12
|
-
- !
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
HIa9EgfFGSUEgvcIvaYqiN4jTUtidfEFw+Ltjs8AP9gWgSIYS6Gr38V0WGFFNzIH
|
41
|
-
|
42
|
-
aOD2wmu9oo/RffW4hS/8GuvfMzcw7CQ355wFR4KB/nyze+EsZ1Y5DerCAagMVuDQ
|
43
|
-
|
44
|
-
U0BLmWDFzPGGWlPeQCrYHCr+AcJz+NRnaHCKLZdSKj/RHuTOt+gblRex8FAh8NeA
|
45
|
-
|
46
|
-
cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
|
47
|
-
|
48
|
-
-----END CERTIFICATE-----
|
49
|
-
|
50
|
-
'
|
51
|
-
date: 2011-08-15 00:00:00.000000000Z
|
12
|
+
- !binary |-
|
13
|
+
LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURMRENDQWhTZ0F3SUJB
|
14
|
+
Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREE4TVF3d0NnWURWUVFEREFOblpX
|
15
|
+
UXgKRnpBVkJnb0praWFKay9Jc1pBRVpGZ2RmWVdWeWFXVmZNUk13RVFZS0Na
|
16
|
+
SW1pWlB5TEdRQkdSWURiM0puTUI0WApEVEV3TURreE5qRTBORGcxTVZvWERU
|
17
|
+
RXhNRGt4TmpFME5EZzFNVm93UERFTU1Bb0dBMVVFQXd3RFoyVmtNUmN3CkZR
|
18
|
+
WUtDWkltaVpQeUxHUUJHUllIWDJGbGNtbGxYekVUTUJFR0NnbVNKb21UOGl4
|
19
|
+
a0FSa1dBMjl5WnpDQ0FTSXcKRFFZSktvWklodmNOQVFFQkJRQURnZ0VQQURD
|
20
|
+
Q0FRb0NnZ0VCQUx5Ly9CRnhDMWYvY1BTbnd0SkJXb0ZpRnJpcgpoN1JpY0kr
|
21
|
+
am9xL29jVlhRcUk0VERXUHlGLzh0cWt2dCtyRDk5WDlxczJZZVI4Q1UvWWlJ
|
22
|
+
cExXclFPWVNUNzBKCnZEbjdVdmhiMm11RlZxcTYrdm9iZVRrSUxCRU82cGlv
|
23
|
+
bldERzhqU2JvM3FLbTFSaktKRHdnOXA0d05LaFB1dTgKS0d1ZS9CRmI2N0tm
|
24
|
+
bHF5QXBQbVBlYjNWZGQ5Y2xzcHpxZUZxcDdjVUJNRXBGUzZMV3h5NEdrK3F2
|
25
|
+
RkZKQkpMQgpCVUhFL0xaVkpNVnpmcEM1VXErUW1ZN0IrRkgvUXFObmRuM3RP
|
26
|
+
SGdzUGFkTFROaW11QjFzQ3VMMWE0ejNQZXBkClRlTEJFRm1FYW81RGszSy9R
|
27
|
+
OG84dmxiSUIvakJEVFV4NkRqYmd4dzc3OTA5eDZnSTlkb1U0TEQ1WE1jQ0F3
|
28
|
+
RUEKQWFNNU1EY3dDUVlEVlIwVEJBSXdBREFMQmdOVkhROEVCQU1DQkxBd0hR
|
29
|
+
WURWUjBPQkJZRUZKZW9Ha09yOWw0Qgorc2FNa1cvWlhUNFVlU3ZWTUEwR0NT
|
30
|
+
cUdTSWIzRFFFQkJRVUFBNElCQVFCRzJLT2J2WUkyZUh5eUJVSlNKM2pOCnZF
|
31
|
+
blUzZDYwem5BWGJyU2QycWIzcjFsWTFFUEREM2JjeTBNZ2dDZkdkZzNYdTU0
|
32
|
+
ejIxb3F5SWRrOHVHdFdCUEwKSElhOUVnZkZHU1VFZ3ZjSXZhWXFpTjRqVFV0
|
33
|
+
aWRmRUZ3K0x0anM4QVA5Z1dnU0lZUzZHcjM4VjBXR0ZGTnpJSAphT0Qyd211
|
34
|
+
OW9vL1JmZlc0aFMvOEd1dmZNemN3N0NRMzU1d0ZSNEtCL255emUrRXNaMVk1
|
35
|
+
RGVyQ0FhZ01WdURRClUwQkxtV0RGelBHR1dsUGVRQ3JZSENyK0FjSnorTlJu
|
36
|
+
YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
|
37
|
+
Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
|
38
|
+
cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
|
39
|
+
date: 2012-03-30 00:00:00.000000000 Z
|
52
40
|
dependencies:
|
53
41
|
- !ruby/object:Gem::Dependency
|
54
42
|
name: hoe
|
55
|
-
requirement: &
|
43
|
+
requirement: &70209483374240 !ruby/object:Gem::Requirement
|
56
44
|
none: false
|
57
45
|
requirements:
|
58
46
|
- - ~>
|
59
47
|
- !ruby/object:Gem::Version
|
60
|
-
version: '
|
48
|
+
version: '3.0'
|
61
49
|
type: :runtime
|
62
50
|
prerelease: false
|
63
|
-
version_requirements: *
|
51
|
+
version_requirements: *70209483374240
|
64
52
|
- !ruby/object:Gem::Dependency
|
65
53
|
name: RedCloth
|
66
|
-
requirement: &
|
54
|
+
requirement: &70209483373440 !ruby/object:Gem::Requirement
|
67
55
|
none: false
|
68
56
|
requirements:
|
69
57
|
- - ~>
|
@@ -71,10 +59,10 @@ dependencies:
|
|
71
59
|
version: '4.2'
|
72
60
|
type: :runtime
|
73
61
|
prerelease: false
|
74
|
-
version_requirements: *
|
62
|
+
version_requirements: *70209483373440
|
75
63
|
- !ruby/object:Gem::Dependency
|
76
64
|
name: rcodetools
|
77
|
-
requirement: &
|
65
|
+
requirement: &70209483372600 !ruby/object:Gem::Requirement
|
78
66
|
none: false
|
79
67
|
requirements:
|
80
68
|
- - ~>
|
@@ -82,21 +70,21 @@ dependencies:
|
|
82
70
|
version: '0.8'
|
83
71
|
type: :runtime
|
84
72
|
prerelease: false
|
85
|
-
version_requirements: *
|
73
|
+
version_requirements: *70209483372600
|
86
74
|
- !ruby/object:Gem::Dependency
|
87
75
|
name: hoe-mercurial
|
88
|
-
requirement: &
|
76
|
+
requirement: &70209483371900 !ruby/object:Gem::Requirement
|
89
77
|
none: false
|
90
78
|
requirements:
|
91
79
|
- - ~>
|
92
80
|
- !ruby/object:Gem::Version
|
93
|
-
version: 1.
|
81
|
+
version: 1.4.0
|
94
82
|
type: :development
|
95
83
|
prerelease: false
|
96
|
-
version_requirements: *
|
84
|
+
version_requirements: *70209483371900
|
97
85
|
- !ruby/object:Gem::Dependency
|
98
86
|
name: hoe-highline
|
99
|
-
requirement: &
|
87
|
+
requirement: &70209483387260 !ruby/object:Gem::Requirement
|
100
88
|
none: false
|
101
89
|
requirements:
|
102
90
|
- - ~>
|
@@ -104,21 +92,21 @@ dependencies:
|
|
104
92
|
version: 0.0.1
|
105
93
|
type: :development
|
106
94
|
prerelease: false
|
107
|
-
version_requirements: *
|
95
|
+
version_requirements: *70209483387260
|
108
96
|
- !ruby/object:Gem::Dependency
|
109
|
-
name:
|
110
|
-
requirement: &
|
97
|
+
name: rdoc
|
98
|
+
requirement: &70209483386360 !ruby/object:Gem::Requirement
|
111
99
|
none: false
|
112
100
|
requirements:
|
113
101
|
- - ~>
|
114
102
|
- !ruby/object:Gem::Version
|
115
|
-
version: '
|
103
|
+
version: '3.10'
|
116
104
|
type: :development
|
117
105
|
prerelease: false
|
118
|
-
version_requirements: *
|
106
|
+
version_requirements: *70209483386360
|
119
107
|
- !ruby/object:Gem::Dependency
|
120
108
|
name: tidy-ext
|
121
|
-
requirement: &
|
109
|
+
requirement: &70209483385520 !ruby/object:Gem::Requirement
|
122
110
|
none: false
|
123
111
|
requirements:
|
124
112
|
- - ~>
|
@@ -126,40 +114,28 @@ dependencies:
|
|
126
114
|
version: '0.1'
|
127
115
|
type: :development
|
128
116
|
prerelease: false
|
129
|
-
version_requirements: *
|
130
|
-
-
|
131
|
-
|
132
|
-
|
133
|
-
none: false
|
134
|
-
requirements:
|
135
|
-
- - ~>
|
136
|
-
- !ruby/object:Gem::Version
|
137
|
-
version: '2.10'
|
138
|
-
type: :development
|
139
|
-
prerelease: false
|
140
|
-
version_requirements: *70213889258840
|
141
|
-
description: ! 'A manual-generation plugin for Hoe.
|
142
|
-
|
143
|
-
|
144
|
-
This is a plugin for [Hoe][hoe] that adds tasks and resources for
|
145
|
-
|
146
|
-
generating a manual or cookbook.
|
147
|
-
|
148
|
-
|
149
|
-
It''s self-documenting, so for more, see [the latest manual for hoe-manualgen itself][hoe-manualgen-manual].'
|
117
|
+
version_requirements: *70209483385520
|
118
|
+
description: ! "A manual-generation plugin for Hoe.\n\nThis is a plugin for Hoe[http://seattlerb.rubyforge.org/hoe/]
|
119
|
+
that \nadds tasks and resources for generating a manual or cookbook.\n\nIt's self-documenting,
|
120
|
+
so for more, see\n{the latest manual for hoe-manualgen itself}[http://deveiate.org/code/hoe-manualgen/]."
|
150
121
|
email:
|
151
122
|
- ged@FaerieMUD.org
|
152
123
|
executables: []
|
153
124
|
extensions: []
|
154
125
|
extra_rdoc_files:
|
126
|
+
- History.rdoc
|
127
|
+
- Manifest.txt
|
128
|
+
- README.rdoc
|
155
129
|
- data/hoe-manualgen/lib/api-filter.rb
|
156
130
|
- data/hoe-manualgen/lib/editorial-filter.rb
|
157
131
|
- data/hoe-manualgen/lib/examples-filter.rb
|
158
132
|
- data/hoe-manualgen/lib/links-filter.rb
|
159
133
|
files:
|
160
134
|
- .autotest
|
161
|
-
-
|
162
|
-
-
|
135
|
+
- ChangeLog
|
136
|
+
- History.rdoc
|
137
|
+
- Manifest.txt
|
138
|
+
- README.rdoc
|
163
139
|
- Rakefile
|
164
140
|
- data/hoe-manualgen/layouts/default.erb.erb
|
165
141
|
- data/hoe-manualgen/lib/api-filter.rb
|
@@ -167,6 +143,7 @@ files:
|
|
167
143
|
- data/hoe-manualgen/lib/examples-filter.rb
|
168
144
|
- data/hoe-manualgen/lib/links-filter.rb
|
169
145
|
- data/hoe-manualgen/resources/css/manual.css.erb
|
146
|
+
- data/hoe-manualgen/resources/css/reset.css
|
170
147
|
- data/hoe-manualgen/resources/fonts/GraublauWeb.otf
|
171
148
|
- data/hoe-manualgen/resources/fonts/GraublauWebBold.otf
|
172
149
|
- data/hoe-manualgen/resources/fonts/Inconsolata.otf
|
@@ -201,7 +178,7 @@ licenses:
|
|
201
178
|
post_install_message:
|
202
179
|
rdoc_options:
|
203
180
|
- --main
|
204
|
-
- README.
|
181
|
+
- README.rdoc
|
205
182
|
require_paths:
|
206
183
|
- lib
|
207
184
|
required_ruby_version: !ruby/object:Gem::Requirement
|
@@ -218,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
218
195
|
version: '0'
|
219
196
|
requirements: []
|
220
197
|
rubyforge_project: hoe-manualgen
|
221
|
-
rubygems_version: 1.8.
|
198
|
+
rubygems_version: 1.8.16
|
222
199
|
signing_key:
|
223
200
|
specification_version: 3
|
224
201
|
summary: A manual-generation plugin for Hoe
|
metadata.gz.sig
CHANGED
Binary file
|
data/History.md
DELETED
@@ -1,16 +0,0 @@
|
|
1
|
-
## v0.1.1 [2011-06-29] Michael Granger <ged@FaerieMUD.org>
|
2
|
-
|
3
|
-
* Bugfix: add trace function in a mixin for outputting based on rake -t.
|
4
|
-
|
5
|
-
## v0.1.0 [2011-03-16] Michael Granger <ged@FaerieMUD.org>
|
6
|
-
|
7
|
-
* Put page filters under the same namespace as the rest
|
8
|
-
* More work on the meta-manual.
|
9
|
-
* Add page filters to the API docs
|
10
|
-
* Reorganized page filter plugins to be a bit more consistently-
|
11
|
-
named/located
|
12
|
-
|
13
|
-
## 0.0.1 [2011-01-31] Michael Granger <ged@FaerieMUD.org>
|
14
|
-
|
15
|
-
Initial release.
|
16
|
-
|