diff --git a/README.md b/README.md
index df8e8ecaa84fb11f04b1dc9bb8c671cc460fc2b5..fb7ea3fc1477c9e46f92147f13c9613855e011de 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,8 @@
Copyright (c) 2014 Ulf Wiger
-
__Authors:__ [`ulf@wiger.net`](mailto:ulf@wiger.net).
-
Status:
------
More-or-less readable Markdown can be generated.
@@ -63,6 +61,7 @@ The default value is `github`.
Note that at the moment, the
[Markdown viewer plugin](https://bitbucket.org/atlassianlabs/stash-markdown-viewer-plugin) will be needed in order to render the generated documentation
as Markdown on Stash.
+
Github customizations
=====================
`pre` tags are converted into github "fenced" code blocks, i.e.
@@ -167,14 +166,3 @@ See [bin/MARKEDOC-README.md](http://github.com/uwiger/edown/blob/master/bin/MARK
**Linux**`$ sed -r -f markedoc.sed <markdown file> > <edoc file>`
-
-## Modules ##
-
-
-<table width="100%" border="0" summary="list of modules">
-<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_doclet.md" class="module">edown_doclet</a></td></tr>
-<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_layout.md" class="module">edown_layout</a></td></tr>
-<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_lib.md" class="module">edown_lib</a></td></tr>
-<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_make.md" class="module">edown_make</a></td></tr>
-<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_xmerl.md" class="module">edown_xmerl</a></td></tr></table>
-
diff --git a/doc/README.md b/doc/README.md
index 37dba3ffa1bd3420fd858ac5a389818faa2def89..6e37d0a0a537a3789d8d90a48ed1ce9e73a8dee0 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -4,10 +4,8 @@
Copyright (c) 2014 Ulf Wiger
-
__Authors:__ [`ulf@wiger.net`](mailto:ulf@wiger.net).
-
Status:
------
More-or-less readable Markdown can be generated.
@@ -63,6 +61,7 @@ The default value is `github`.
Note that at the moment, the
[Markdown viewer plugin](https://bitbucket.org/atlassianlabs/stash-markdown-viewer-plugin) will be needed in order to render the generated documentation
as Markdown on Stash.
+
Github customizations
=====================
`pre` tags are converted into github "fenced" code blocks, i.e.
@@ -167,14 +166,3 @@ See [bin/MARKEDOC-README.md](bin/MARKEDOC-README.md).
**Linux**`$ sed -r -f markedoc.sed <markdown file> > <edoc file>`
-
-## Modules ##
-
-
-<table width="100%" border="0" summary="list of modules">
-<tr><td><a href="edown_doclet.md" class="module">edown_doclet</a></td></tr>
-<tr><td><a href="edown_layout.md" class="module">edown_layout</a></td></tr>
-<tr><td><a href="edown_lib.md" class="module">edown_lib</a></td></tr>
-<tr><td><a href="edown_make.md" class="module">edown_make</a></td></tr>
-<tr><td><a href="edown_xmerl.md" class="module">edown_xmerl</a></td></tr></table>
-
diff --git a/doc/edoc-info b/doc/edoc-info
index 87b2449b28eb11d91c79e7d849292afdb95f8de1..14075fb3b5a1d1d4d94a5c8cccb7c64adff277b5 100644
--- a/doc/edoc-info
+++ b/doc/edoc-info
@@ -1,4 +1,3 @@
%% encoding: UTF-8
{application,edown}.
-{packages,[]}.
{modules,[edown_doclet,edown_layout,edown_lib,edown_make,edown_xmerl]}.
diff --git a/doc/edown_doclet.md b/doc/edown_doclet.md
index fcf01783cc211f018965ed6b8b55cdda9124a4bf..c8af9597915be6a8a8e13517035f9be5c109a2eb 100644
--- a/doc/edown_doclet.md
+++ b/doc/edown_doclet.md
@@ -5,11 +5,12 @@
* [Function Index](#index)
* [Function Details](#functions)
-
EDoc Doclet module for producing Markdown.
-Copyright (c) 2014 Ulf Wiger
+
+Copyright (c) 2014-2015 Ulf Wiger
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
+
<a name="index"></a>
## Function Index ##
@@ -26,22 +27,17 @@ __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
### run/2 ###
-
<pre><code>
run(Command::<a href="#type-doclet_gen">doclet_gen()</a> | <a href="#type-doclet_toc">doclet_toc()</a>, Ctxt::<a href="#type-edoc_context">edoc_context()</a>) -> ok
</code></pre>
<br />
-
Main doclet entry point.
-
-
Also see [`//edoc/edoc:layout/2`](http://www.erlang.org/doc/man/edoc.html#layout-2) for layout-related options, and
[`//edoc/edoc:get_doc/2`](http://www.erlang.org/doc/man/edoc.html#get_doc-2) for options related to reading source
files.
-
Options:
diff --git a/doc/edown_layout.md b/doc/edown_layout.md
index 10c00c1b1f6b7443e830b6a1b8b6d2f5c681620b..109b8a94a762967b44d51d1d244abbe1c3ca1eb8 100644
--- a/doc/edown_layout.md
+++ b/doc/edown_layout.md
@@ -5,15 +5,16 @@
* [Function Index](#index)
* [Function Details](#functions)
-
Markdown layout module for EDoc.
+
Copyright (c) 2014 Ulf Wiger
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
+
<a name="description"></a>
## Description ##
- Derived from `edoc_layout`, which is part of the Erlang/OTP application EDoc.
+Derived from `edoc_layout`, which is part of the Erlang/OTP application EDoc.
The module is intended to be used together with edoc.<a name="index"></a>
## Function Index ##
@@ -32,17 +33,14 @@ The module is intended to be used together with edoc.<a name="index"></a>
`markdown(Title, CSS, Body) -> any()`
-
<a name="module-2"></a>
### module/2 ###
`module(Element, Options) -> any()`
-
The layout function.
-
Options to the standard layout:
@@ -116,26 +114,23 @@ used for exporting the documentation. See <a href="http://www.erlang.org/doc/man
-
__See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#layout-2), [edown_doclet:layout/2](edown_doclet.md#layout-2).
+
<a name="overview-2"></a>
### overview/2 ###
`overview(E, Options) -> any()`
-
<a name="package-2"></a>
### package/2 ###
`package(E, Options) -> any()`
-
<a name="type-1"></a>
### type/1 ###
`type(E) -> any()`
-
diff --git a/doc/edown_lib.md b/doc/edown_lib.md
index 4db33d3d223fe0768feb75b8c04c8cca4b3854e6..c999693ea4d0d9181d5d57fa50e63a68ab72e508 100644
--- a/doc/edown_lib.md
+++ b/doc/edown_lib.md
@@ -5,29 +5,29 @@
* [Function Index](#index)
* [Function Details](#functions)
-
Markdown for EDoc - common support functions.
+
Copyright (c) 2014 Ulf Wiger
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
+
<a name="index"></a>
## Function Index ##
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#export-1">export/1</a></td><td></td></tr><tr><td valign="top"><a href="#get_attrval-2">get_attrval/2</a></td><td></td></tr><tr><td valign="top"><a href="#redirect_uri-1">redirect_uri/1</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#export-2">export/2</a></td><td></td></tr><tr><td valign="top"><a href="#get_attrval-2">get_attrval/2</a></td><td></td></tr><tr><td valign="top"><a href="#redirect_uri-1">redirect_uri/1</a></td><td></td></tr></table>
<a name="functions"></a>
## Function Details ##
-<a name="export-1"></a>
+<a name="export-2"></a>
-### export/1 ###
-
-`export(Data) -> any()`
+### export/2 ###
+`export(Data, Options) -> any()`
<a name="get_attrval-2"></a>
@@ -35,11 +35,9 @@ __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
`get_attrval(Name, XmlElement) -> any()`
-
<a name="redirect_uri-1"></a>
### redirect_uri/1 ###
`redirect_uri(XmlElement) -> any()`
-
diff --git a/doc/edown_make.md b/doc/edown_make.md
index 09f30f40612117e6303a537456c8191ff8c17c82..f4608633f87b9e94d705e079e4d3cb070a253702 100644
--- a/doc/edown_make.md
+++ b/doc/edown_make.md
@@ -4,7 +4,6 @@
* [Function Index](#index)
* [Function Details](#functions)
-
<a name="index"></a>
## Function Index ##
@@ -21,62 +20,45 @@
### from_script/1 ###
-
<pre><code>
from_script(Config::ConfigFile) -> ok | {error, Reason}
</code></pre>
<br />
-
Reads ConfigFile and calls [`edoc:application/3`](edoc.md#application-3)
-
-
The ConfigFile will be read using [`file:script/1`](file.md#script-1), and should return
`{App, Dir, Options}`, as required by [`edoc:application/3`](edoc.md#application-3).
-
This function does not manage dependencies. It is simply a wrapper around
[`edoc:application/3`](edoc.md#application-3).
+
<a name="main-1"></a>
### main/1 ###
-
<pre><code>
main(Args::[Config]) -> no_return()
</code></pre>
<br />
-
Escript entry point for building edown (or edoc) documentation
-
-
Usage: edown_make -config ConfigFile [-pa P] [-pz P]
-
-
Calls [from_script(ConfigFile)](#from_script-1) and then terminates,
with a normal or non-normal exit code, depending on the outcome.
-
-
Make sure `$EDOWN/edown_make` is runnable, and in the command path, and
that the edown BEAM files are in the Erlang path (e.g. using $ERL_LIBS).
The `edown_make` escript also accepts `-pa P` and/or `-pz P` flags as a
means of locating the edown byte code.
-
-
Note, however, that the function `edoc_make:main/1` only expects the
config file as an input argument, corresponding to
-
-
`escript edoc_make.beam ConfigFile`
-
(The reason for this is that if the beam file can be passed directly to
the escript command, setting the path should also be doable that way).
diff --git a/doc/edown_xmerl.md b/doc/edown_xmerl.md
index 1ad3f3bff6492ee68014645e32555eed8bc96832..5628164733154fb49a927466254a6ed89f2cede2 100644
--- a/doc/edown_xmerl.md
+++ b/doc/edown_xmerl.md
@@ -7,6 +7,7 @@
Copyright (c) 2014 Ulf Wiger
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
+
<a name="index"></a>
## Function Index ##
@@ -25,25 +26,21 @@ __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
`#element#(Tag, Data, Attrs, Parents, E) -> any()`
-
<a name="%23root%23-4"></a>
### '#root#'/4 ###
`#root#(Data, Attrs, X3, E) -> any()`
-
<a name="%23text%23-1"></a>
### '#text#'/1 ###
`#text#(Text) -> any()`
-
<a name="%23xml-inheritance%23-0"></a>
### '#xml-inheritance#'/0 ###
`#xml-inheritance#() -> any()`
-
diff --git a/src/edown_doclet.erl b/src/edown_doclet.erl
index cc70ed4f6a3dd0472e6aec1c292c3c9c8113dbd5..a81f31420ebfae567d4c527274d7bb0445cac7e7 100644
--- a/src/edown_doclet.erl
+++ b/src/edown_doclet.erl
@@ -14,7 +14,7 @@
%% limitations under the License.
%%==============================================================================
%% @author Ulf Wiger <ulf@wiger.net>
-%% @copyright 2014 Ulf Wiger
+%% @copyright 2014-2015 Ulf Wiger
%% @end
%% =============================================================================
%% Modified 2012 by Beads Land-Trujillo: get_git_branch/0, redirect_href/3
@@ -22,7 +22,6 @@
%% @doc EDoc Doclet module for producing Markdown.
-
-module(edown_doclet).
-export([run/2]).
@@ -35,21 +34,17 @@
-define(DEFAULT_FILE_SUFFIX, ".md").
-define(INDEX_FILE, "README.md").
-define(OVERVIEW_FILE, "overview.edoc").
--define(PACKAGE_SUMMARY, "package-summary.md").
-define(OVERVIEW_SUMMARY, "overview-summary.md").
--define(PACKAGES_FRAME, "packages-frame.md").
--define(MODULES_FRAME, "modules-frame.md").
-define(STYLESHEET, "stylesheet.css").
-define(IMAGE, "erlang.png").
-define(NL, "\n").
-include_lib("xmerl/include/xmerl.hrl").
-%% Sources is the list of inputs in the order they were found. Packages
-%% and Modules are sorted lists of atoms without duplicates. (They
+%% Sources is the list of inputs in the order they were found.
+%% Modules are sorted lists of atoms without duplicates. (They
%% usually include the data from the edoc-info file in the target
-%% directory, if it exists.) Note that the "empty package" is never
-%% included in Packages!
+%% directory, if it exists.)
%% @spec (Command::doclet_gen() | doclet_toc(), edoc_context()) -> ok
%% @doc Main doclet entry point.
@@ -106,21 +101,14 @@
%% INHERIT-OPTIONS: stylesheet/1
run(#doclet_gen{}=Cmd, Ctxt) ->
- %% dbg:tracer(),
- %% dbg:tpl(?MODULE,x),
- %% dbg:tpl(edown_layout,x),
- %% dbg:tpl(edown_xmerl, x),
- %% dbg:p(all,[c]),
gen(Cmd#doclet_gen.sources,
Cmd#doclet_gen.app,
- Cmd#doclet_gen.packages,
- Cmd#doclet_gen.modules,
- Cmd#doclet_gen.filemap,
+ modules(Cmd),
Ctxt);
run(#doclet_toc{}=Cmd, Ctxt) ->
toc(Cmd#doclet_toc.paths, Ctxt).
-gen(Sources, App, Packages, Modules, FileMap, Ctxt) ->
+gen(Sources, App, Modules, Ctxt) ->
Dir = Ctxt#context.dir,
Env = Ctxt#context.env,
Options0 = Ctxt#context.opts,
@@ -131,15 +119,10 @@ gen(Sources, App, Packages, Modules, FileMap, Ctxt) ->
Title = title(App, Options),
%% CSS = stylesheet(Options),
{Modules1, Error} = sources(Sources, Dir, Modules, Env, Options),
- packages(Packages, Dir, FileMap, Env, Options),
- Overview = overview(Dir, Title, Env, Options),
- Data =
- Overview
- ++ lists:concat([packages_frame(Packages) || Packages =/= []])
- ++ lists:concat([modules_frame(Modules1) || Modules1 =/= []]),
+ Data = overview(Dir, Title, Env, Options),
Text = edown_lib:export(Data, Options),
- write_file(Text, Dir, right_suffix(?INDEX_FILE, Options), '', ''),
- edoc_lib:write_info_file(App, Packages, Modules1, Dir),
+ write_file(Text, Dir, right_suffix(?INDEX_FILE, Options)),
+ write_info_file(App, Modules1, Dir),
copy_stylesheet(Dir, Options),
copy_image(Dir, Options),
make_top_level_README(Data, Options),
@@ -170,7 +153,7 @@ make_top_level_README(Data, Options) ->
Dir = filename:dirname(Path),
Filename = filename:basename(Path),
make_top_level_README(Data, Dir, Filename, BaseHRef,
- get_git_branch(), target(Options));
+ get_git_branch(), Options);
{Path, BaseHRef, Branch} ->
Dir = filename:dirname(Path),
Filename = filename:basename(Path),
@@ -294,19 +277,24 @@ sources(Sources, Dir, Modules, Env, Options) ->
%% set if it was successful. Errors are just flagged at this stage,
%% allowing all source files to be processed even if some of them fail.
-source({M, P, Name, Path}, Dir, Suffix, Env, Set, Private, Hidden,
+source({M, _, Name, Path}, Dir, Suffix, Env, Set, Private, Hidden,
+ Error, Options) ->
+ %% Old style, remove package reference
+ source({M, Name, Path}, Dir, Suffix, Env, Set, Private, Hidden,
+ Error, Options);
+source({M, Name, Path}, Dir, Suffix, Env, Set, Private, Hidden,
Error, Options) ->
File = filename:join(Path, Name),
Enc = guess_encoding(File),
case catch {ok, edoc:get_doc(File, Env, Options)} of
{ok, {Module, Doc}} ->
- check_name(Module, M, P, File),
+ check_name(Module, M, File),
case ((not is_private(Doc)) orelse Private)
andalso ((not is_hidden(Doc)) orelse Hidden) of
true ->
Text = edoc:layout(Doc, Options),
- Name1 = packages_last(M) ++ Suffix,
- write_file(Text, Dir, Name1, Name, P, Enc),
+ Name1 = atom_to_list(M) ++ Suffix,
+ write_file(Text, Dir, Name1, Name, Enc),
{sets:add_element(Module, Set), Error};
false ->
{Set, Error}
@@ -326,22 +314,27 @@ guess_encoding(File) ->
end.
write_file(Text, Dir, F) ->
- write_file(Text, Dir, F, F, '', auto).
-
-write_file(Text, Dir, Name, P) ->
- write_file(Text, Dir, Name, Name, P, auto).
+ write_file(Text, Dir, F, F, auto).
-write_file(Text, Dir, LastName, Name, P) ->
- write_file(Text, Dir, LastName, Name, P, auto).
-
-write_file(Text, Dir, LastName, Name, P, Enc) ->
+write_file(Text, Dir, LastName, Name, Enc) ->
%% edoc_lib:write_file/5 (with encoding support) was added in OTP R16B
+ %% -- and removed in 18.0; we reuse the check to detect 18, since we don't
+ %% -- care about pre-R16
case lists:member({write_file,5}, edoc_lib:module_info(exports)) of
true ->
- edoc_lib:write_file(Text, Dir, LastName, P,
+ edoc_lib:write_file(Text, Dir, LastName, '',
[{encoding, encoding(Enc, Name)}]);
false ->
- edoc_lib:write_file(Text, Dir, LastName, P)
+ edoc_lib:write_file(Text, Dir, LastName,
+ [{encoding, encoding(Enc, Name)}])
+ end.
+
+write_info_file(App, Modules, Dir) ->
+ case erlang:function_exported(edoc_lib, write_info_file, 4) of
+ true ->
+ edoc_lib:write_info_file(App, [], Modules, Dir);
+ false ->
+ edoc_lib:write_info_file(App, Modules, Dir)
end.
encoding(auto, Name) ->
@@ -350,25 +343,9 @@ encoding(Enc, _) ->
Enc.
-check_name(M, M0, P0, File) ->
- case erlang:function_exported(packages, strip_last, 1) of
- true ->
- check_name_(M, M0, P0, File);
- false ->
- ok
- end.
-
-%% If running pre-R16B OTP, where packages are still "supported".
-packages_last(M) ->
- case erlang:function_exported(packages, last, 1) of
- true -> packages:last(M);
- false -> atom_to_list(M)
- end.
-
-check_name_(M, M0, P0, File) ->
- P = list_to_atom(packages:strip_last(M)),
- N = packages:last(M),
- N0 = packages:last(M0),
+check_name(M, M0, File) ->
+ N = M,
+ N0 = M0,
case N of
[$? | _] ->
%% A module name of the form '?...' is assumed to be caused
@@ -382,84 +359,8 @@ check_name_(M, M0, P0, File) ->
true ->
ok
end
- end,
- if P =/= P0 ->
- warning("file '~s' belongs to package '~s', not '~s'.",
- [File, P, P0]);
- true ->
- ok
end.
-
-%% Generating the summary files for packages.
-
-%% INHERIT-OPTIONS: read_file/4
-%% INHERIT-OPTIONS: edoc_lib:run_layout/2
-
-packages(Packages, Dir, FileMap, Env, Options) ->
- lists:foreach(fun (P) ->
- package(P, Dir, FileMap, Env, Options)
- end,
- Packages).
-
-package(P, Dir, FileMap, Env, Opts) ->
- Tags = case FileMap(P) of
- "" ->
- [];
- File ->
- read_file(File, package, Env, Opts)
- end,
- Data = edoc_data:package(P, Tags, Env, Opts),
- F = fun (M) ->
- M:package(Data, Opts)
- end,
- Text = edoc_lib:run_layout(F, Opts),
- write_file(Text, Dir, ?PACKAGE_SUMMARY, P).
-
-
-
-packages_frame(Ps) ->
- [{h2, [{class, "indextitle"}], ["Packages"]},
- {table, [{width, "100%"}, {border, 0},
- {summary, "list of packages"}],
- lists:concat(
- [[{tr, [{td, [], [{a, [{href, package_ref(P)},
- {class, "package"}],
- [atom_to_list(P)]}]}]}]
- || P <- Ps])}].
-
-
-modules_frame(Ms) ->
- [{h2, [{class, "indextitle"}], ["Modules"]},
- {table, [{width, "100%"}, {border, 0},
- {summary, "list of modules"}],
- lists:concat(
- [[?NL,
- {tr, [{td, [],
- [{a, [{href, module_ref(M)},
- {class, "module"}],
- [atom_to_list(M)]}]}]}]
- || M <- Ms])}].
-
-module_ref(M) ->
- edoc_refs:relative_package_path(M, '') ++ ?DEFAULT_FILE_SUFFIX.
-
-package_ref(P) ->
- edoc_lib:join_uri(edoc_refs:relative_package_path(P, ''),
- ?PACKAGE_SUMMARY).
-
-
-%% xhtml(Title, CSS, Content) ->
-%% xhtml_1(Title, CSS, {body, [{bgcolor, "white"}], Content}).
-
-%% xhtml_1(Title, CSS, Body) ->
-%% {html, [?NL,
-%% {head, [?NL, {title, [Title]}, ?NL] ++ CSS},
-%% ?NL,
-%% Body,
-%% ?NL]
-%% }.
-
%% NEW-OPTIONS: overview
%% INHERIT-OPTIONS: read_file/4
%% INHERIT-OPTIONS: edoc_lib:run_layout/2
@@ -475,8 +376,6 @@ overview(Dir, Title, Env, Opts) ->
M:overview(Data, Opts)
end,
_Markdown = edoc_lib:run_layout(F, Opts).
- %% edoc_lib:write_file(Text, Dir, ?OVERVIEW_SUMMARY).
-
copy_image(Dir, Options) ->
case proplists:get_value(image, Options) of
@@ -598,3 +497,8 @@ toc(_Paths, _Ctxt) ->
%% Dir = Ctxt#context.dir,
%% Env = Ctxt#context.env,
%% app_index_file(Paths, Dir, Env, Opts).
+
+modules({doclet_gen,_,_,_,Ms,_}) -> % pre-18
+ Ms;
+modules({doclet_gen,_,_,Ms}) -> % since 18
+ Ms.