diff --git a/NOTICE b/NOTICE index 4d1ea3eea1fe1361448c1427027f5d23d2e31979..974350cf3d286f3526e55ee5023dff666dae5bf7 100644 --- a/NOTICE +++ b/NOTICE @@ -5,6 +5,6 @@ EDoc was written by Richard Carlsson, (c) 2001-2007 Richard Carlsson. It is part of Erlang/OTP (http://www.erlang.org) and available via the Erlang Public License (EPL). -Original idea and implementation for EDown: ulf.wiger@erlang-solutions.com +Original idea and implementation for EDown: ulf@wiger.net Markedoc contributed by Henning Dietrich <hd2010@eonblast.com> \ No newline at end of file diff --git a/README.md b/README.md index f5e22f103a31606150c076b80cb6ae1071a58e86..e59416064937b30c99b03df493542aeb793bb8b5 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,17 @@ # Edown - Markdown generated from Edoc # -Copyright (c) 2010 Erlang Solutions Ltd +Copyright (c) 2014 Ulf Wiger -__Authors:__ [`ulf.wiger@feuerlabs.com`](mailto:ulf.wiger@feuerlabs.com). +__Authors:__ [`ulf@wiger.net`](mailto:ulf@wiger.net). Status: ------ More-or-less readable Markdown can be generated. -A doclet needs to be written that also creates -a markdown-based index and overview. Currently, the +A doclet needs to be written that also creates +a markdown-based index and overview. Currently, the edoc_doclet creates an index.html and overview.html, which do not point to the .md files. @@ -42,7 +42,7 @@ Markdown links. Example: -`{top_level_readme, {"./README.md", "http://github.com/esl/edown"}}` +`{top_level_readme, {"./README.md", "http://github.com/uwiger/edown"}}` The conversion function will fetch the current branch name from git, and fail if it cannot do so. @@ -95,9 +95,9 @@ incr(X) -> Rebar customizations ==================== A set of escripts can be found under -[edown/priv/scripts/](http://github.com/esl/gproc/blob/master/priv/scripts/), which +[edown/priv/scripts/](http://github.com/uwiger/edown/blob/master/priv/scripts/), which can be used to customize the `rebar` built process. The -[rebar.config.script](http://github.com/esl/gproc/blob/master/priv/scripts/rebar.config.script) +[rebar.config.script](http://github.com/uwiger/edown/blob/master/priv/scripts/rebar.config.script) file should be copied into your application, next to `rebar.config`. It will sense if `doc` is a current target, and will then include `edown` in the `deps`; otherwise, it removes it. This way, you will @@ -138,30 +138,30 @@ One way to solve this is to use the escripts found under NOTE ==== -EDoc provides a plugin structure, so that one may specify own -layout modules, export modules, and doclets. However, there is -some overlap esp. between the layout and doclet modules, and +EDoc provides a plugin structure, so that one may specify own +layout modules, export modules, and doclets. However, there is +some overlap esp. between the layout and doclet modules, and several functions are expected to produce files on their own. This causes a problem for EDown, since it cannot handle frames. Instead, it would probably like to create one overview file with different sections. It would have been better to have a framework -where some plugin functions identify the different files to be +where some plugin functions identify the different files to be written, and the outline of each, other plugins convert to suitable -content representation (e.g. HTML or Markdown), and EDoc then +content representation (e.g. HTML or Markdown), and EDoc then writes the files necessary. For now, EDown focuses on producing reasonable Markdown, rather -than complying fully with the plugin framework. That is, the +than complying fully with the plugin framework. That is, the edown_doclet module will not go out of its way to function together with any other layout module than edown_layout, and vice versa. markedoc ======== -The sed script bin/markedoc works in the opposite direction and converts -your `README.md` to an `EDoc` file. +The sed script bin/markedoc works in the opposite direction and converts +your `README.md` to an `EDoc` file. -See [bin/MARKEDOC-README.md](http://github.com/esl/gproc/blob/master/bin/MARKEDOC-README.md). +See [bin/MARKEDOC-README.md](http://github.com/uwiger/edown/blob/master/bin/MARKEDOC-README.md). **FreeBSD, Mac OS X**`$ sed -E -f markedoc.sed <markdown file> > <edoc file>` @@ -172,9 +172,9 @@ See [bin/MARKEDOC-README.md](http://github.com/esl/gproc/blob/master/bin/MARKEDO <table width="100%" border="0" summary="list of modules"> -<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/edown_doclet.md" class="module">edown_doclet</a></td></tr> -<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/edown_layout.md" class="module">edown_layout</a></td></tr> -<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/edown_lib.md" class="module">edown_lib</a></td></tr> -<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/edown_make.md" class="module">edown_make</a></td></tr> -<tr><td><a href="http://github.com/esl/gproc/blob/master/doc/edown_xmerl.md" class="module">edown_xmerl</a></td></tr></table> +<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 new file mode 100644 index 0000000000000000000000000000000000000000..482aba080eadbb9c3f541f31c275c07401a2d211 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,180 @@ + + +# Edown - Markdown generated from Edoc # + +Copyright (c) 2014 Ulf Wiger + + +__Authors:__ [`ulf@wiger.net`](mailto:ulf@wiger.net). + + +Status: +------ +More-or-less readable Markdown can be generated. +A doclet needs to be written that also creates +a markdown-based index and overview. Currently, the +edoc_doclet creates an index.html and overview.html, +which do not point to the .md files. + +To generate markdown edoc, run: + +``` + +edoc:application(App, [{doclet, edown_doclet} | OtherOpts]). + +``` + +The `edown_xmerl` module is used as an xmerl export module. +It converts xmerl's "simple xml" to Markdown syntax. Note that +GH-flavored Markdown allows HTML markup (at least common tags), +but doesn't expand markdown markup inside HTML markup, so the +`edown_xmerl` module has to know the context in which it operates. + +Top-level README +---------------- + +Using the option `{top_level_readme, {File, BaseHref}}`, a github-friendly +`README.md` in the top directory can be generated from the `overview.edoc`. +This file is the same as the `doc/README.md` file already generated, +but with relative links corrected (using `BaseHref`) so that they actually +work. This step is needed since Github doesn't support relative paths in +Markdown links. + +Example: + +`{top_level_readme, {"./README.md", "http://github.com/uwiger/edown"}}` + +The conversion function will fetch the current branch name from git, +and fail if it cannot do so. + +It is also possible to add the branch information specifically: +`{top_level_readme, {File, BaseHref, Branch}}`, although this shouldn't be +necessary as long as edown can derive the branch name from git. + +Using Atlassian Stash as target +------------------------------- + +The option `{edown_target, github | stash}` can be used to control which +is the intended host repository. This affects how links are rewritten in +order to find related files and stay on the correct branch. + +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. + +``` +```...''' +``` + +. If language-specific syntax highlighting is desired, +this can be achieved by adding a 'lang' attribute, e.g. + +``` +<pre lang="erlang"> +incr(X) -> + %% This should be formatted with Erlang syntax highlighting + X + 1. +</pre> +``` + +which should format like this: + +```erlang + +incr(X) -> + %% This should be formatted with Erlang syntax highlighting + X + 1. + +``` + +Rebar customizations +==================== +A set of escripts can be found under +[edown/priv/scripts/](priv/scripts/), which +can be used to customize the `rebar` built process. The +[rebar.config.script](priv/scripts/rebar.config.script) +file should be copied into your application, next to `rebar.config`. +It will sense if `doc` is a current target, and will then include +`edown` in the `deps`; otherwise, it removes it. This way, you will +not have to pull down `edown` unless you really want to build the +docs. It will also locate edown along your path, in which case +it doesn't need to pull it down again. + +The script will also start the `inets` application, so that you +can include URLs as part of a `doc_path` option (see below). + +Links to other EDown-generated docs +=================================== +There is a way to configure Edoc/Edown to get URLs right even +when linking to other Edown-generated docs on Github. + +First, you need to specify paths to the `edoc-info` files for +each repository as part of `edoc_opts` in your rebar.config, e.g. + +``` + {doc_path, ["http://raw.github.com/uwiger/setup/master/doc", + "http://raw.github.com/uwiger/gproc/master/doc"]} +``` + +Note (1) that we use "http:://...", not "https://...", since +Edoc doesn't recognize the latter. Also note that we use URLs +to the raw files. This is for Edoc as it fetches the `edoc-info` +files. Edown will detect and rewrite such links in the generated +output, since "raw" links wouldn't work for the markdown files. + +The next issue is that Edoc uses httpd_client to fetch the +`edoc-info` files, which requires `inets` to be started. To +further complicate matters, `ssl` (and thus `crypto` and +`public_key`) must also be started, since Github will +redirect to https. + +One way to solve this is to use the escripts found under +`edown/priv/scripts`. + +NOTE +==== +EDoc provides a plugin structure, so that one may specify own +layout modules, export modules, and doclets. However, there is +some overlap esp. between the layout and doclet modules, and +several functions are expected to produce files on their own. +This causes a problem for EDown, since it cannot handle frames. +Instead, it would probably like to create one overview file with +different sections. It would have been better to have a framework +where some plugin functions identify the different files to be +written, and the outline of each, other plugins convert to suitable +content representation (e.g. HTML or Markdown), and EDoc then +writes the files necessary. + +For now, EDown focuses on producing reasonable Markdown, rather +than complying fully with the plugin framework. That is, the +edown_doclet module will not go out of its way to function together +with any other layout module than edown_layout, and vice versa. + +markedoc +======== + +The sed script bin/markedoc works in the opposite direction and converts +your `README.md` to an `EDoc` file. + +See [bin/MARKEDOC-README.md](bin/MARKEDOC-README.md). + +**FreeBSD, Mac OS X**`$ sed -E -f markedoc.sed <markdown file> > <edoc file>` + +**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/edown_doclet.md b/doc/edown_doclet.md index 34e8bc31dfaddc694f719b444fa7e09496236739..fcf01783cc211f018965ed6b8b55cdda9124a4bf 100644 --- a/doc/edown_doclet.md +++ b/doc/edown_doclet.md @@ -7,7 +7,7 @@ EDoc Doclet module for producing Markdown. -Copyright (c) 2010 Erlang Solutions Ltd +Copyright (c) 2014 Ulf Wiger __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)). <a name="index"></a> @@ -30,9 +30,7 @@ __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)). <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></br> - +<br /> Main doclet entry point. diff --git a/doc/edown_layout.md b/doc/edown_layout.md index 0cb8ac1a665cda30075e9ee275e33f0fab5d1de9..10c00c1b1f6b7443e830b6a1b8b6d2f5c681620b 100644 --- a/doc/edown_layout.md +++ b/doc/edown_layout.md @@ -7,7 +7,7 @@ Markdown layout module for EDoc. -Copyright (c) 2010 Erlang Solutions Ltd +Copyright (c) 2014 Ulf Wiger __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)). <a name="description"></a> diff --git a/doc/edown_lib.md b/doc/edown_lib.md index 99ecf8074c786ad85d0c093bfba1f9676eafa515..4db33d3d223fe0768feb75b8c04c8cca4b3854e6 100644 --- a/doc/edown_lib.md +++ b/doc/edown_lib.md @@ -7,9 +7,9 @@ Markdown for EDoc - common support functions. -Copyright (c) 2010 Erlang Solutions Ltd +Copyright (c) 2014 Ulf Wiger -__Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)). +__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)). <a name="index"></a> ## Function Index ## diff --git a/doc/edown_make.md b/doc/edown_make.md index 9100d36cc685547dc259d5b70df7dd4490c48224..09f30f40612117e6303a537456c8191ff8c17c82 100644 --- a/doc/edown_make.md +++ b/doc/edown_make.md @@ -25,9 +25,7 @@ <pre><code> from_script(Config::ConfigFile) -> ok | {error, Reason} </code></pre> - -<br></br> - +<br /> Reads ConfigFile and calls [`edoc:application/3`](edoc.md#application-3) @@ -48,9 +46,7 @@ This function does not manage dependencies. It is simply a wrapper around <pre><code> main(Args::[Config]) -> no_return() </code></pre> - -<br></br> - +<br /> Escript entry point for building edown (or edoc) documentation diff --git a/doc/edown_xmerl.md b/doc/edown_xmerl.md index 0dcf1ee00627415cec99c48d2b03e044d768c263..1ad3f3bff6492ee68014645e32555eed8bc96832 100644 --- a/doc/edown_xmerl.md +++ b/doc/edown_xmerl.md @@ -4,7 +4,7 @@ * [Function Index](#index) * [Function Details](#functions) -Copyright (c) 2010 Erlang Solutions Ltd +Copyright (c) 2014 Ulf Wiger __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)). <a name="index"></a> diff --git a/doc/overview.edoc b/doc/overview.edoc index 7f854732a024e7444c1a7daf91cde8bfac5a5d28..ddc88f737f885aefd1dc02f6051485e505a103b9 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -1,5 +1,5 @@ -@author <ulf.wiger@feuerlabs.com> -@copyright 2010 Erlang Solutions Ltd +@author <ulf@wiger.net> +@copyright 2014 Ulf Wiger @title Edown - Markdown generated from Edoc @@ -7,8 +7,8 @@ Status: ------ More-or-less readable Markdown can be generated. -A doclet needs to be written that also creates -a markdown-based index and overview. Currently, the +A doclet needs to be written that also creates +a markdown-based index and overview. Currently, the edoc_doclet creates an index.html and overview.html, which do not point to the .md files. @@ -36,7 +36,7 @@ Markdown links. Example: -`{top_level_readme, {"./README.md", "http://github.com/esl/edown"}}' +`{top_level_readme, {"./README.md", "http://github.com/uwiger/edown"}}' The conversion function will fetch the current branch name from git, and fail if it cannot do so. @@ -123,28 +123,28 @@ One way to solve this is to use the escripts found under NOTE ==== -EDoc provides a plugin structure, so that one may specify own -layout modules, export modules, and doclets. However, there is -some overlap esp. between the layout and doclet modules, and +EDoc provides a plugin structure, so that one may specify own +layout modules, export modules, and doclets. However, there is +some overlap esp. between the layout and doclet modules, and several functions are expected to produce files on their own. This causes a problem for EDown, since it cannot handle frames. Instead, it would probably like to create one overview file with different sections. It would have been better to have a framework -where some plugin functions identify the different files to be +where some plugin functions identify the different files to be written, and the outline of each, other plugins convert to suitable -content representation (e.g. HTML or Markdown), and EDoc then +content representation (e.g. HTML or Markdown), and EDoc then writes the files necessary. For now, EDown focuses on producing reasonable Markdown, rather -than complying fully with the plugin framework. That is, the +than complying fully with the plugin framework. That is, the edown_doclet module will not go out of its way to function together with any other layout module than edown_layout, and vice versa. markedoc ======== -The sed script bin/markedoc works in the opposite direction and converts -your `README.md' to an `EDoc' file. +The sed script bin/markedoc works in the opposite direction and converts +your `README.md' to an `EDoc' file. See <a href="bin/MARKEDOC-README.md">bin/MARKEDOC-README.md</a>. diff --git a/make_doc b/make_doc index 810a9e53cc6818faf483f178fc2b0737ff73b28e..8ba01c2e8d0e41523bdb8f1c2b96f4b8c50bcf5b 100755 --- a/make_doc +++ b/make_doc @@ -8,7 +8,7 @@ %% main([]) -> code:add_patha("ebin"), - Default = "esl", + Default = "uwiger", U = case os:getenv("TGT") of [] -> Default; false -> Default; diff --git a/samples/markedoc/SAMPLE2.md b/samples/markedoc/SAMPLE2.md index a984c81dff694879e801ed83f8d835008ccefa9d..3fae25a04aeb500e0e572a3b99116404dc43b3a5 100644 --- a/samples/markedoc/SAMPLE2.md +++ b/samples/markedoc/SAMPLE2.md @@ -8,14 +8,14 @@ SAMPLE 2: EDown Readme of Jan 2011 -------------------------------------------------------------- ''' -<ulf.wiger@erlang-solutions.com> +<ulf@wiger.net> Status: ------- More-or-less readable Markdown can be generated. -A doclet needs to be written that also creates -a markdown-based index and overview. Currently, the +A doclet needs to be written that also creates +a markdown-based index and overview. Currently, the edoc_doclet creates an index.html and overview.html, which do not point to the .md files. @@ -26,25 +26,25 @@ To generate markdown edoc, run: The `edown_xmerl` module is used as an xmerl export module. It converts xmerl's "simple xml" to Markdown syntax. Note that GH-flavored Markdown allows HTML markup (at least common tags), -but doesn't expand markdown markup inside HTML markup, so the +but doesn't expand markdown markup inside HTML markup, so the `edown_xmerl` module has to know the context in which it operates. NOTE ---- -EDoc provides a plugin structure, so that one may specify own -layout modules, export modules, and doclets. However, there is -some overlap esp. between the layout and doclet modules, and +EDoc provides a plugin structure, so that one may specify own +layout modules, export modules, and doclets. However, there is +some overlap esp. between the layout and doclet modules, and several functions are expected to produce files on their own. This causes a problem for EDown, since it cannot handle frames. Instead, it would probably like to create one overview file with different sections. It would have been better to have a framework -where some plugin functions identify the different files to be +where some plugin functions identify the different files to be written, and the outline of each, other plugins convert to suitable -content representation (e.g. HTML or Markdown), and EDoc then +content representation (e.g. HTML or Markdown), and EDoc then writes the files necessary. For now, EDown focuses on producing reasonable Markdown, rather -than complying fully with the plugin framework. That is, the +than complying fully with the plugin framework. That is, the edown_doclet module will not go out of its way to function together with any other layout module than edown_layout, and vice versa. \ No newline at end of file diff --git a/samples/markedoc/what-you-should-see/SAMPLE2.edoc b/samples/markedoc/what-you-should-see/SAMPLE2.edoc index b8924d62cc34817a825f8076cd457d284d9952a2..e65c0f3df425c0832818452562fa1a09f921ec0f 100644 --- a/samples/markedoc/what-you-should-see/SAMPLE2.edoc +++ b/samples/markedoc/what-you-should-see/SAMPLE2.edoc @@ -8,13 +8,13 @@ -------------------------------------------------------------- ''' -<a href="mailto:ulf.wiger@erlang-solutions.com">ulf.wiger@erlang-solutions.com</a> +<a href="mailto:ulf@wiger.net">ulf@wiger.net</a> === Status: === More-or-less readable Markdown can be generated. -A doclet needs to be written that also creates -a markdown-based index and overview. Currently, the +A doclet needs to be written that also creates +a markdown-based index and overview. Currently, the edoc_doclet creates an index.html and overview.html, which do not point to the .md files. @@ -25,25 +25,25 @@ To generate markdown edoc, run: The <code>edown_xmerl</code> module is used as an xmerl export module. It converts xmerl's "simple xml" to Markdown syntax. Note that GH-flavored Markdown allows HTML markup (at least common tags), -but doesn't expand markdown markup inside HTML markup, so the +but doesn't expand markdown markup inside HTML markup, so the <code>edown_xmerl</code> module has to know the context in which it operates. === NOTE === -EDoc provides a plugin structure, so that one may specify own -layout modules, export modules, and doclets. However, there is -some overlap esp. between the layout and doclet modules, and +EDoc provides a plugin structure, so that one may specify own +layout modules, export modules, and doclets. However, there is +some overlap esp. between the layout and doclet modules, and several functions are expected to produce files on their own. This causes a problem for EDown, since it cannot handle frames. Instead, it would probably like to create one overview file with different sections. It would have been better to have a framework -where some plugin functions identify the different files to be +where some plugin functions identify the different files to be written, and the outline of each, other plugins convert to suitable -content representation (e.g. HTML or Markdown), and EDoc then +content representation (e.g. HTML or Markdown), and EDoc then writes the files necessary. For now, EDown focuses on producing reasonable Markdown, rather -than complying fully with the plugin framework. That is, the +than complying fully with the plugin framework. That is, the edown_doclet module will not go out of its way to function together with any other layout module than edown_layout, and vice versa. <script> diff --git a/samples/markedoc/what-you-should-see/sample2.html b/samples/markedoc/what-you-should-see/sample2.html index 99e9d48fa4f4c016baf9b053728d46e5aa0513b0..fca95e478e3f4d0ce4e476d848cea94ca54b3c4e 100644 --- a/samples/markedoc/what-you-should-see/sample2.html +++ b/samples/markedoc/what-you-should-see/sample2.html @@ -17,13 +17,13 @@ | from markdown into an edoc. | --------------------------------------------------------------</pre> -<p><a href="mailto:ulf.wiger@erlang-solutions.com">ulf.wiger@erlang-solutions.com</a></p> +<p><a href="mailto:ulf@wiger.net">ulf@wiger.net</a></p> <h4><a name="Status:">Status:</a></h4> <p>More-or-less readable Markdown can be generated. -A doclet needs to be written that also creates -a markdown-based index and overview. Currently, the +A doclet needs to be written that also creates +a markdown-based index and overview. Currently, the edoc_doclet creates an index.html and overview.html, which do not point to the .md files.</p> @@ -34,25 +34,25 @@ which do not point to the .md files.</p> <p>The <code>edown_xmerl</code> module is used as an xmerl export module. It converts xmerl's "simple xml" to Markdown syntax. Note that GH-flavored Markdown allows HTML markup (at least common tags), -but doesn't expand markdown markup inside HTML markup, so the +but doesn't expand markdown markup inside HTML markup, so the <code>edown_xmerl</code> module has to know the context in which it operates.</p> <h4><a name="NOTE">NOTE</a></h4> -<p>EDoc provides a plugin structure, so that one may specify own -layout modules, export modules, and doclets. However, there is -some overlap esp. between the layout and doclet modules, and +<p>EDoc provides a plugin structure, so that one may specify own +layout modules, export modules, and doclets. However, there is +some overlap esp. between the layout and doclet modules, and several functions are expected to produce files on their own. This causes a problem for EDown, since it cannot handle frames. Instead, it would probably like to create one overview file with different sections. It would have been better to have a framework -where some plugin functions identify the different files to be +where some plugin functions identify the different files to be written, and the outline of each, other plugins convert to suitable -content representation (e.g. HTML or Markdown), and EDoc then +content representation (e.g. HTML or Markdown), and EDoc then writes the files necessary.</p> For now, EDown focuses on producing reasonable Markdown, rather -than complying fully with the plugin framework. That is, the +than complying fully with the plugin framework. That is, the edown_doclet module will not go out of its way to function together with any other layout module than edown_layout, and vice versa. <script> diff --git a/src/edown.app.src b/src/edown.app.src index f12835c3ab249d1d047e4f77a695578811de18ed..27b9d9948476704f691fedbe52fb7f7126220006 100644 --- a/src/edown.app.src +++ b/src/edown.app.src @@ -1,6 +1,6 @@ %% -*- erlang -*- %%============================================================================== -%% Copyright 2010 Erlang Solutions Ltd. +%% Copyright 2014 Ulf Wiger %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. diff --git a/src/edown_doclet.erl b/src/edown_doclet.erl index 3cf03ebb65ac547077cd23d682f1b4ac17c740e1..3ede284411a381851e07658fa17c9a72bab69891 100644 --- a/src/edown_doclet.erl +++ b/src/edown_doclet.erl @@ -1,5 +1,5 @@ %%============================================================================== -%% Copyright 2010 Erlang Solutions Ltd. +%% Copyright 2014 Ulf Wiger %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ %% limitations under the License. %%============================================================================== %% @author Ulf Wiger <ulf@wiger.net> -%% @copyright 2010 Erlang Solutions Ltd +%% @copyright 2014 Ulf Wiger %% @end %% ============================================================================= %% Modified 2012 by Beads Land-Trujillo: get_git_branch/0, redirect_href/3 diff --git a/src/edown_layout.erl b/src/edown_layout.erl index 2d1fbcce7844986c9e0b319319d20dc7eeb17a88..0bad2ab78da39bbd9534f74b2d12eb108f07f21b 100644 --- a/src/edown_layout.erl +++ b/src/edown_layout.erl @@ -1,5 +1,5 @@ %%============================================================================== -%% Copyright 2010 Erlang Solutions Ltd. +%% Copyright 2014 Ulf Wiger %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ %% limitations under the License. %%============================================================================== %% @author Ulf Wiger <ulf@wiger.net> -%% @copyright 2010 Erlang Solutions Ltd +%% @copyright 2014 Ulf Wiger %% @end %% ===================================================================== diff --git a/src/edown_lib.erl b/src/edown_lib.erl index bcd0bba4a28dab8616ab4e1a26c0f9c73f648168..7f82996a0aa40a5080eefd22979d062592c9065d 100644 --- a/src/edown_lib.erl +++ b/src/edown_lib.erl @@ -1,5 +1,5 @@ %%============================================================================== -%% Copyright 2010 Erlang Solutions Ltd. +%% Copyright 2014 Ulf Wiger %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -13,8 +13,8 @@ %% See the License for the specific language governing permissions and %% limitations under the License. %%============================================================================== -%% @author Ulf Wiger <ulf.wiger@erlang-solutions.com> -%% @copyright 2010 Erlang Solutions Ltd +%% @author Ulf Wiger <ulf@wiger.net> +%% @copyright 2014 Ulf Wiger %% @end %% ===================================================================== diff --git a/src/edown_xmerl.erl b/src/edown_xmerl.erl index 3d33997a8438a65cd1c6baa00fef550b0ce138f5..c11e80847b5dfa6140c47d52c87900974396b5ed 100644 --- a/src/edown_xmerl.erl +++ b/src/edown_xmerl.erl @@ -1,5 +1,5 @@ %%============================================================================== -%% Copyright 2010 Erlang Solutions Ltd. +%% Copyright 2014 Ulf Wiger %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ %% limitations under the License. %%============================================================================== %% @author Ulf Wiger <ulf@wiger.net> -%% @copyright 2010 Erlang Solutions Ltd +%% @copyright 2014 Ulf Wiger %% @end %% ============================================================================= %% Modified 2012 by Beads Land-Trujillo: '#text#'/1, brstrip/1