rdoc-f95 0.0.1 → 0.0.2
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.
- data/History.txt +5 -0
- data/README.rdoc +55 -82
- data/Rakefile +4 -2
- data/lib/rdoc-f95.rb +1 -1
- data/lib/rdoc-f95/markup/to_xhtml_texparser.rb +0 -65
- metadata +7 -7
data/History.txt
CHANGED
data/README.rdoc
CHANGED
|
@@ -1,13 +1,59 @@
|
|
|
1
|
-
=
|
|
1
|
+
= \RDocF95: Enhanced version of RDoc Fortran 90/95 parser
|
|
2
2
|
|
|
3
3
|
* Project Page: http://rubyforge.org/projects/rdoc/
|
|
4
4
|
* Documentation: http://rdoc-f95.rubyforge.org/
|
|
5
5
|
|
|
6
|
-
==
|
|
6
|
+
== DESCRIPTION:
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
RDocF95 is an improved RDoc for generation of documents of Fortran 90/95 programs.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Differences to the original one are given below.
|
|
11
|
+
|
|
12
|
+
<b>Enhancement of "parser/f95.rb"</b> ::
|
|
13
|
+
The Fortran 90/95 parse script "parser/f95.rb"
|
|
14
|
+
(In rdoc-f95, old name "parsers/parse_f95.rb" is used yet) is modified
|
|
15
|
+
in order to parse almost all entities of the Fortran 90/95 Standard.
|
|
16
|
+
|
|
17
|
+
<b>Addition of <tt>--ignore-case</tt> option </b> ::
|
|
18
|
+
In the Fortran 90/95 Standard,
|
|
19
|
+
upper case letters are not distinguished from lower case letters,
|
|
20
|
+
although original RDoc produces case-dependently
|
|
21
|
+
cross-references of Class and Methods.
|
|
22
|
+
When this options is specified,
|
|
23
|
+
upper cases are not distinguished from lower cases.
|
|
24
|
+
|
|
25
|
+
<b>Cross-reference of file names</b> ::
|
|
26
|
+
Cross-reference of file names is available as well as
|
|
27
|
+
modules, subroutines, and so on.
|
|
28
|
+
|
|
29
|
+
<b>Modification of <tt>--style</tt> option</b> ::
|
|
30
|
+
Original RDoc can not treat relative path stylesheet.
|
|
31
|
+
Application of this patch modifies this function.
|
|
32
|
+
|
|
33
|
+
<b>Conversion of TeX formula into MathML</b>::
|
|
34
|
+
TeX formula can be converted into MathML format
|
|
35
|
+
with --mathml option,
|
|
36
|
+
if <b>MathML library for Ruby version 0.6b -- 0.8</b> is installed.
|
|
37
|
+
This library is available from {Bottega of Hiraku (only JAPANESE)}[http://www.hinet.mydns.jp/~hiraku/].
|
|
38
|
+
See {RDocF95::Markup::ToXHtmlTexParser}[link:classes/RDocF95/Markup/ToXHtmlTexParser.html] about format.
|
|
39
|
+
|
|
40
|
+
<b>*** Caution ***</b>
|
|
41
|
+
Documents generated with "--mathml" option are not displayed correctly
|
|
42
|
+
according to browser and/or its setting.
|
|
43
|
+
We have been confirmed that
|
|
44
|
+
documents generated with "--mathml" option are displayed correctly
|
|
45
|
+
with {Mozilla Firefox}[http://www.mozilla.org/products/firefox/]
|
|
46
|
+
and Internet Explorer
|
|
47
|
+
(+ {MathPlayer}[http://www.dessci.com/en/products/mathplayer/]).
|
|
48
|
+
See {MathML Software - Browsers}[http://www.w3.org/Math/Software/mathml_software_cat_browsers.html]
|
|
49
|
+
for other browsers.
|
|
50
|
+
|
|
51
|
+
Some formats of comments in HTML document are changed
|
|
52
|
+
to improve the analysis features.
|
|
53
|
+
See {parse_f95.rb}[link:files/lib/rdoc-f95/parsers/parse_f95_rb.html]
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
== USAGE:
|
|
11
57
|
|
|
12
58
|
Set the environment variable *PATH* to include
|
|
13
59
|
the directory where the execution program is installed,
|
|
@@ -52,96 +98,23 @@ For more information,
|
|
|
52
98
|
see http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html
|
|
53
99
|
|
|
54
100
|
|
|
55
|
-
==
|
|
101
|
+
== TEMPLATE NOTE:
|
|
56
102
|
|
|
57
103
|
Refer to {parse_f95.rb}[link:files/lib/rdoc-f95/parsers/parse_f95_rb.html] which
|
|
58
104
|
explains parsed information, way of looking at documents,
|
|
59
105
|
the format of comment blocks in Fortran 90/95 source code.
|
|
60
106
|
If you use "--mathml" option (see below),
|
|
61
|
-
refer to
|
|
107
|
+
refer to {RDocF95::Markup::ToXHtmlTexParser}[link:classes/RDocF95/Markup/ToXHtmlTexParser.html], too.
|
|
62
108
|
For general information, see
|
|
63
109
|
http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html
|
|
64
110
|
|
|
65
|
-
== SAMPLES
|
|
111
|
+
== SAMPLES:
|
|
66
112
|
|
|
67
113
|
* {Code reference of gtool5 library that is a Fortran 90/95 library for numerical models for geophysical fluid (only JAPANESE)}[http://www.gfd-dennou.org/library/gtool/gtool5/gtool5_current/doc/develop_reference/]
|
|
68
114
|
|
|
69
115
|
* {Code reference of planetary atmospheric general circulation model DCPAM}[http://www.gfd-dennou.org/library/dcpam/dcpam5/dcpam5_current/doc/code_reference/xml]
|
|
70
116
|
|
|
71
|
-
==
|
|
72
|
-
|
|
73
|
-
This patch has been created for enhancing the Fortran 90/95 parser of RDoc .
|
|
74
|
-
{The Fortran 90/95 parse script}[http://svn.ruby-lang.org/cgi-bin/viewvc.cgi/trunk/lib/rdoc/parser/f95.rb]
|
|
75
|
-
is mainly modified, and other programs are also improved.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
The original RDoc has been developed by Dave Thomas and is now
|
|
79
|
-
maintained by Ryan Davis and Eric Hodel, etc. .
|
|
80
|
-
The RDoc is available from the Ruby source code repository.
|
|
81
|
-
See {Ruby Repository Guide}[http://www.ruby-lang.org/en/news/2006/12/22/cvs-repository-moved-to-svn/].
|
|
82
|
-
For more information about RDoc, see
|
|
83
|
-
http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html
|
|
84
|
-
or
|
|
85
|
-
{RubyForge: rdoc Project}[http://rubyforge.org/projects/rdoc]
|
|
86
|
-
|
|
87
|
-
Differences to the original one are given below.
|
|
117
|
+
== LICENSE:
|
|
88
118
|
|
|
89
|
-
|
|
90
|
-
#<b>Enhancement of an analytical performance of Fortran 90/95 source codes</b> ::
|
|
91
|
-
# See lib/rdoc-f95/parsers/parse_f95.rb for details.
|
|
92
|
-
|
|
93
|
-
#<b>Modification of format of comment blocks</b> ::
|
|
94
|
-
# See lib/rdoc-f95/parsers/parse_f95.rb for details.
|
|
95
|
-
++
|
|
96
|
-
|
|
97
|
-
<b>Addition of <tt>--ignore-case</tt> option </b> ::
|
|
98
|
-
In the Fortran 90/95 Standard,
|
|
99
|
-
upper case letters are not distinguished from lower case letters,
|
|
100
|
-
although original RDoc produces case-dependently
|
|
101
|
-
cross-references of Class and Methods.
|
|
102
|
-
When this options is specified,
|
|
103
|
-
upper cases are not distinguished from lower cases.
|
|
104
|
-
|
|
105
|
-
<b>Cross-reference of file names</b> ::
|
|
106
|
-
Cross-reference of file names is available as well as
|
|
107
|
-
modules, subroutines, and so on.
|
|
108
|
-
|
|
109
|
-
<b>Modification of <tt>--style</tt> option</b> ::
|
|
110
|
-
Original RDoc can not treat relative path stylesheet.
|
|
111
|
-
Application of this patch modifies this function.
|
|
112
|
-
|
|
113
|
-
<b>Conversion of TeX formula into MathML</b>::
|
|
114
|
-
TeX formula can be converted into MathML format
|
|
115
|
-
with --mathml option,
|
|
116
|
-
if <b>MathML library for Ruby version 0.6b -- 0.8</b> is installed.
|
|
117
|
-
This library is available from {Bottega of Hiraku (only JAPANESE)}[http://www.hinet.mydns.jp/~hiraku/].
|
|
118
|
-
See <b>RDoc::Markup::ToXHtmlTexParser</b> about format.
|
|
119
|
-
|
|
120
|
-
<b>*** Caution ***</b>
|
|
121
|
-
Documents generated with "--mathml" option are not displayed correctly
|
|
122
|
-
according to browser and/or its setting.
|
|
123
|
-
We have been confirmed that
|
|
124
|
-
documents generated with "--mathml" option are displayed correctly
|
|
125
|
-
with {Mozilla Firefox}[http://www.mozilla.org/products/firefox/]
|
|
126
|
-
and Internet Explorer
|
|
127
|
-
(+ {MathPlayer}[http://www.dessci.com/en/products/mathplayer/]).
|
|
128
|
-
See {MathML Software - Browsers}[http://www.w3.org/Math/Software/mathml_software_cat_browsers.html]
|
|
129
|
-
for other browsers.
|
|
130
|
-
|
|
131
|
-
Some formats of comments in HTML document are changed
|
|
132
|
-
to improve the analysis features.
|
|
133
|
-
See {parse_f95.rb}[link:files/lib/rdoc-f95/parsers/parse_f95_rb.html]
|
|
134
|
-
|
|
135
|
-
== LICENSE
|
|
136
|
-
|
|
137
|
-
Licence of the enhanced version of RDoc Fortran 90/95 parser
|
|
138
|
-
conforms to that of original RDoc.
|
|
119
|
+
Licence of RDocF95 conforms to that of original RDoc.
|
|
139
120
|
see http://rdoc.rubyforge.org/
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
== HISTORY
|
|
143
|
-
|
|
144
|
-
=== 0.0.1
|
|
145
|
-
|
|
146
|
-
* Initial release
|
|
147
|
-
|
data/Rakefile
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
|
|
2
|
+
$:.unshift 'lib'
|
|
2
3
|
require File.dirname(__FILE__) + '/lib/rdoc-f95'
|
|
3
4
|
|
|
4
5
|
# Generate all the Rake tasks
|
|
5
6
|
# Run 'rake -T' to see list of generated tasks (from gem root directory)
|
|
6
7
|
$hoe = Hoe.new('rdoc-f95', RDocF95::VERSION) do |p|
|
|
7
|
-
p.developer('
|
|
8
|
+
p.developer('Yasuhiro MORIKAWA', 'morikawa@gfd-dennou.org')
|
|
8
9
|
p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
|
|
9
10
|
p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
|
|
10
|
-
p.rubyforge_name =
|
|
11
|
+
p.rubyforge_name = 'rdoc'
|
|
12
|
+
#p.rubyforge_name = p.name # TODO this is default value
|
|
11
13
|
# p.extra_deps = [
|
|
12
14
|
# ['activesupport','>= 2.0.2'],
|
|
13
15
|
# ]
|
data/lib/rdoc-f95.rb
CHANGED
|
@@ -3,48 +3,6 @@ require 'rdoc-f95/markup/to_html_crossref'
|
|
|
3
3
|
require 'rdoc-f95/markup/mathml_wrapper'
|
|
4
4
|
|
|
5
5
|
##
|
|
6
|
-
#<b>Note that Japanese and English are described in parallel.</b>
|
|
7
|
-
#
|
|
8
|
-
#== TeX �ο����� MathML ���Ѵ�
|
|
9
|
-
#
|
|
10
|
-
#TeX �ǵ��Ҥ��줿������ MathML ���Ѵ����ޤ�.
|
|
11
|
-
#����饤���ɽ�����������, TeX �ο�����ʲ��Τ褦�� $ ... $ �Ǥ����ä�
|
|
12
|
-
#���Ҥ��Ƥ�������. $ ��
|
|
13
|
-
#����ˤ�Ⱦ�Ѷ�����ʸ���ʾ�����Ʋ�����.
|
|
14
|
-
#(�ʤ�, "$ID: ... $" �� "$LOG: ... $
|
|
15
|
-
#�Ȥ��ä�, CVS �Υ�����ɤȤ���
|
|
16
|
-
#�Ѥ����Ƥ�������Ͽ����Ȥ��ư����ޤ���.)
|
|
17
|
-
#
|
|
18
|
-
# ����饤���ɽ����������� $ f(x) = x^2 + 1 $ �Τ褦�˵��Ҥ��ޤ�.
|
|
19
|
-
# ($ ������˶����˺��ʤ�).
|
|
20
|
-
#
|
|
21
|
-
#�֥��å���ɽ��������, �ʲ��Τ褦�� \[ ��
|
|
22
|
-
#\] �ȤǤ����äƵ��Ҥ��Ƥ�������. \[, ��ɬ����Ƭ�˵��Ҥ��Ƥ�������.
|
|
23
|
-
#
|
|
24
|
-
# \[
|
|
25
|
-
# \sum_{i=1}^nf_n(x)
|
|
26
|
-
# \]
|
|
27
|
-
#
|
|
28
|
-
#������ʣ���Ԥ�ɽ��������ˤ�, ���Ԥ�����ʬ�� "\] \[" �Ҥ��Ƥ�������.
|
|
29
|
-
#
|
|
30
|
-
# \[
|
|
31
|
-
# d\zeta/dt + J(\psi,\zeta) = Ra \; dT/dx + \nabla\zeta, \] \[
|
|
32
|
-
# dT/dt + J(\psi,T) - d\psi/dx = \nabla T, \] \[
|
|
33
|
-
# \nabla\psi = \zeta
|
|
34
|
-
# \]
|
|
35
|
-
#
|
|
36
|
-
#TeX �ο������� MathML �Ѵ��ˤ�
|
|
37
|
-
#<b>Ruby �� MathML �饤�֥��ΥС������ 0.8</b> ����Ѥ��Ƥ��ޤ�.
|
|
38
|
-
#���Υ饤�֥���{�Ҥ餯�ι�˼}[http://www.hinet.mydns.jp/~hiraku/]
|
|
39
|
-
#�ˤƸ�������Ƥ��ޤ�. ���ѤǤ��� TeX ���ޥ�ɤξܺ٤˴ؤ��Ƥ�
|
|
40
|
-
#������Υ����ȤȤ��Ƥ�������.
|
|
41
|
-
#
|
|
42
|
-
#�������줿�ɥ�����Ȥ��������ݤˤ� MathML ���б�����
|
|
43
|
-
#�֥饦������Ѥ���ɬ�פ�
|
|
44
|
-
#����ޤ�. {MathML ���ܸ����}[http://washitake.com/MathML/]
|
|
45
|
-
#�� {MathML Software - Browsers}[http://www.w3.org/Math/Software/mathml_software_cat_browsers.html]
|
|
46
|
-
#�ʤɤȤ��Ƥ�������.
|
|
47
|
-
#
|
|
48
6
|
#
|
|
49
7
|
#== TeX is converted to MathML
|
|
50
8
|
#
|
|
@@ -84,29 +42,6 @@ require 'rdoc-f95/markup/mathml_wrapper'
|
|
|
84
42
|
#See {MathML Software - Browsers}[http://www.w3.org/Math/Software/mathml_software_cat_browsers.html], etc.
|
|
85
43
|
#
|
|
86
44
|
#
|
|
87
|
-
#== \newcommand, \newenvironment �λ�����ˡ
|
|
88
|
-
#
|
|
89
|
-
#\newcommand �� \newenvironment ̿��ˤ��ޥ�������Ѥ���ˤ�,
|
|
90
|
-
#Ruby �Υ����ɥѥ��ʲ��� '<b><tt>mathml/macro</tt></b>' �ǥ��쥯�ȥ��
|
|
91
|
-
#������, ���Υǥ��쥯�ȥ�ʲ��˥ޥ���̿������ե�������֤��Ƥ�������.
|
|
92
|
-
#�ե�����̾���䤤�ޤ���.
|
|
93
|
-
#
|
|
94
|
-
#�㤨��, '<tt>/usr/lib/ruby/1.8</tt>' �� Ruby �Υ����ɥѥ��Ǥ�����,
|
|
95
|
-
#'<tt>/usr/lib/ruby/1.8/mathml</tt>' �����
|
|
96
|
-
#'<tt>/usr/lib/ruby/1.8/mathml/macro</tt>' �ǥ��쥯�ȥ�������,
|
|
97
|
-
#���Υǥ��쥯�ȥ�ʲ���, 'D6math.sty' �Ȥ����ե������������ޤ�
|
|
98
|
-
#(���Ҥ����褦�ˤ��Υե�����̾�ϲ��Ǥ���ޤ���). ���Υե��������
|
|
99
|
-
#�ʲ��Τ褦�� \newcommand ̿��Ҥ��Ƥ������Ȥ�, '<b>\DP{}{}</b>'
|
|
100
|
-
#(����ʬ���ñ�˵��Ҥ��뤿��Υޥ���) ���ޥ�ɤ����Ѳ�ǽ�ˤʤ�ޤ�.
|
|
101
|
-
#
|
|
102
|
-
# \newcommand{\DP}[2]{\frac{\partial #1}{\partial #2}}
|
|
103
|
-
#
|
|
104
|
-
#�ϵ�ή����Ǿ����������Ƥ��� {TeX �ޥ��� (�̾�: ��Ǿ��������)}[http://www.gfd-dennou.org/library/cc-env/TeXmacro/dennou/SIGEN.htm]
|
|
105
|
-
#�˴ޤޤ�� 'D6math.sty' �� Ruby �� Mathml �饤�֥��ǻ��ѤǤ���褦��
|
|
106
|
-
#���������ѥå������� libmathml-macro-dennou-ruby[http://www.gfd-dennou.org/library/cc-env/libmathml-macro-dennou-ruby/debian/stable/] �Ȥ���
|
|
107
|
-
#���Ƥ��ޤ�. ����ץ�Ȥ������Ѥ��ƤߤƤ�������.
|
|
108
|
-
#
|
|
109
|
-
#
|
|
110
45
|
#== Usage of \newcommand and \newenvironment
|
|
111
46
|
#
|
|
112
47
|
#If you want to use macros defined by \newcommand and
|
metadata
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rdoc-f95
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
-
|
|
7
|
+
- Yasuhiro MORIKAWA
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
@@ -32,7 +32,7 @@ dependencies:
|
|
|
32
32
|
- !ruby/object:Gem::Version
|
|
33
33
|
version: 1.8.0
|
|
34
34
|
version:
|
|
35
|
-
description:
|
|
35
|
+
description: "RDocF95 is an improved RDoc for generation of documents of Fortran 90/95 programs. Differences to the original one are given below. <b>Enhancement of \"parser/f95.rb\"</b> :: The Fortran 90/95 parse script \"parser/f95.rb\" (In rdoc-f95, old name \"parsers/parse_f95.rb\" is used yet) is modified in order to parse almost all entities of the Fortran 90/95 Standard. <b>Addition of <tt>--ignore-case</tt> option </b> :: In the Fortran 90/95 Standard, upper case letters are not distinguished from lower case letters, although original RDoc produces case-dependently cross-references of Class and Methods. When this options is specified, upper cases are not distinguished from lower cases. <b>Cross-reference of file names</b> :: Cross-reference of file names is available as well as modules, subroutines, and so on. <b>Modification of <tt>--style</tt> option</b> :: Original RDoc can not treat relative path stylesheet. Application of this patch modifies this function. <b>Conversion of TeX formula into MathML</b>:: TeX formula can be converted into MathML format with --mathml option, if <b>MathML library for Ruby version 0.6b -- 0.8</b> is installed. This library is available from {Bottega of Hiraku (only JAPANESE)}[http://www.hinet.mydns.jp/~hiraku/]. See {RDocF95::Markup::ToXHtmlTexParser}[link:classes/RDocF95/Markup/ToXHtmlTexParser.html] about format. <b>*** Caution ***</b> Documents generated with \"--mathml\" option are not displayed correctly according to browser and/or its setting. We have been confirmed that documents generated with \"--mathml\" option are displayed correctly with {Mozilla Firefox}[http://www.mozilla.org/products/firefox/] and Internet Explorer (+ {MathPlayer}[http://www.dessci.com/en/products/mathplayer/]). See {MathML Software - Browsers}[http://www.w3.org/Math/Software/mathml_software_cat_browsers.html] for other browsers. Some formats of comments in HTML document are changed to improve the analysis features. See {parse_f95.rb}[link:files/lib/rdoc-f95/parsers/parse_f95_rb.html]"
|
|
36
36
|
email:
|
|
37
37
|
- morikawa@gfd-dennou.org
|
|
38
38
|
executables:
|
|
@@ -125,11 +125,11 @@ files:
|
|
|
125
125
|
- lib/rdoc-f95/tokenstream.rb
|
|
126
126
|
- lib/rdoc-f95/usage.rb
|
|
127
127
|
has_rdoc: true
|
|
128
|
-
homepage:
|
|
128
|
+
homepage: "Project Page: http://rubyforge.org/projects/rdoc/"
|
|
129
129
|
post_install_message: PostInstall.txt
|
|
130
130
|
rdoc_options:
|
|
131
131
|
- --main
|
|
132
|
-
- README.rdoc
|
|
132
|
+
- README.rdoc
|
|
133
133
|
require_paths:
|
|
134
134
|
- lib
|
|
135
135
|
required_ruby_version: !ruby/object:Gem::Requirement
|
|
@@ -146,11 +146,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
146
146
|
version:
|
|
147
147
|
requirements: []
|
|
148
148
|
|
|
149
|
-
rubyforge_project: rdoc
|
|
149
|
+
rubyforge_project: rdoc
|
|
150
150
|
rubygems_version: 1.3.1
|
|
151
151
|
signing_key:
|
|
152
152
|
specification_version: 2
|
|
153
|
-
summary:
|
|
153
|
+
summary: RDocF95 is an improved RDoc for generation of documents of Fortran 90/95 programs
|
|
154
154
|
test_files:
|
|
155
155
|
- test/test_helper.rb
|
|
156
156
|
- test/test_rdoc-f95.rb
|