diff --git a/README.md b/README.md index b093dd3..b403aa3 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ your `README.md` to an `EDoc` file. 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 > ` +**FreeBSD, macOS**`$ sed -E -f markedoc.sed > ` **Linux**`$ sed -r -f markedoc.sed > ` diff --git a/bin/MARKEDOC-README.md b/bin/MARKEDOC-README.md index 4e485bd..ec9c1b8 100644 --- a/bin/MARKEDOC-README.md +++ b/bin/MARKEDOC-README.md @@ -5,7 +5,7 @@ edown markedoc 0.3.2 This is the opposite direction from what **edown** otherwise does. -markedoc translates [Markdown][] formatted texts into [Erlang][] [EDoc][] format, for inclusion into [EDoc][] generated html docs. It is for use on Linux, FreeBSD and Mac OS X and any system that you can install **[sed][Requirements]** on. +markedoc translates [Markdown][] formatted texts into [Erlang][] [EDoc][] format, for inclusion into [EDoc][] generated html docs. It is for use on Linux, FreeBSD and macOS and any system that you can install **[sed][Requirements]** on. Status: [pre-beta][Status]. Quite stable and usable. See [Status][]. @@ -17,13 +17,13 @@ Use --- At the command line for -**FreeBSD, Mac OS X** +**FreeBSD, macOS** $ sed -E -f markedoc.sed > **Linux** $ sed -r -f markedoc.sed > -Usage for Linux and FreeBSD and Mac OS X is completely the same, except for the -r instead of the -E parameter. Both mean the same but happen to have a different name. In the examples below, replace -E with -r where necessary. +Usage for Linux and FreeBSD and macOS is completely the same, except for the -r instead of the -E parameter. Both mean the same but happen to have a different name. In the examples below, replace -E with -r where necessary. Requirements ------------ @@ -34,7 +34,7 @@ Requirements Test ---- - **FreeBSD, Mac OS X** + **FreeBSD, macOS** $ samples/markedoc/test-bsd.sh **Linux** @@ -47,7 +47,7 @@ Sample From edown project root, try out: - **FreeBSD, Mac OS X** + **FreeBSD, macOS** $ sed -E -f bin/markedoc.sed samples/markedoc/SAMPLE1.md > samples/markedoc/doc/SAMPLE.edoc $ erl -noshell -run edoc_run application "'myapp'" '"samples/markedoc"' '[]' @@ -67,7 +67,7 @@ This illustrates the motivation for the markedoc as it is now: to have all code For your own projects you'd copy markedoc.sed in the right place and do something like: - **FreeBSD, Mac OS X** + **FreeBSD, macOS** $ sed -E -f bin/markedoc.sed README.md > doc/README.edoc $ erl -noshell -run edoc_run application "'myapp'" '"."' '[]' @@ -79,7 +79,7 @@ And that's it. This could also be part of your Makefile. For the intermediary RE @docfile "doc/README.edoc" -By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows allows to embed it into additional context information that should be useful for a proper html doc. +By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows to embed it into additional context information that should be useful for a proper html doc. Accordingly, the sample stub overview.edoc used for the samples here, looks like this: @@ -102,7 +102,7 @@ both worlds: This makes a tag `[example][]' into a direct jump to the headline 'Example', in both markdown and edoc. -Markdown actually uses the `[sample]: #sample' reference. EDoc, however, automatically inserts an anchor for 'Example' being a headline, and of the same name. (The links are not case sensitive.) +Markdown actually uses the `[sample]: #sample' reference. EDoc, however, automatically inserts an anchor for 'Example' being a headline, and of the same name. (The links are not case-sensitive.) If you get the reference wrong or forget to make it, the link tag will be displayed in the open, as actual `[example][]'. @@ -156,14 +156,14 @@ History * integrated into edown -02/05/11 - 0.3.1 - **more polish** - Linux, FreeBSD, Mac OS X +02/05/11 - 0.3.1 - **more polish** - Linux, FreeBSD, macOS * added weeding out of markdown anchor references (an md workaround) * added protection for & (but edoc still only accepts number codes) * fixed trip up by trailing spaces in underline headline format * checked commented out alternate code for code blocks and references. -02/03/11 - 0.3 - **rough edges polished** - Linux, FreeBSD, Mac OS X +02/03/11 - 0.3 - **rough edges polished** - Linux, FreeBSD, macOS * added doc for Linux use * added support for multi-line '[..]: ... "..."' references @@ -173,12 +173,12 @@ History * guillemots <<, >> and middle dot :: * added test batches etc/test-bsd.sh and etc/test-linux.sh * added css sample in samples/markedoc/what-you-could-see/ -* added classes for ``< li >'' list item tags for '[..]:...'-references -* fixed italic and bold merker interference bullet points -* eliminated [..]: part of '[..]:...'-references, flipping "..." to lead +* added classes for ``< li >`` list item tags for `[..]:...`-references +* fixed italic and bold marker interference bullet points +* eliminated [..]: part of `[..]:...`-references, flipping "..." to lead * dev: sample creation batch make_samples.sh added -02/02/11 - 0.2 - **basics complete** - FreeBSD / Mac OS X +02/02/11 - 0.2 - **basics complete** - FreeBSD / macOS * added support for === and --- headline format * fixed cutting off of last lines @@ -188,7 +188,7 @@ History * eliminated need for echoing '@doc' first into edoc output file * added javascript title tag setting for '[..]:...'-style references. -01/31/11 - 0.1 - **first release:** FreeBSD / Mac OS X +01/31/11 - 0.1 - **first release:** FreeBSD / macOS [Requirements]: #Requirements [Status]: #Status diff --git a/bin/markedoc.sed b/bin/markedoc.sed index 8f07353..7889646 100644 --- a/bin/markedoc.sed +++ b/bin/markedoc.sed @@ -1,15 +1,15 @@ # markedoc 0.3.2 - 02/18/11 H. Diedrich # ---------------------------------------------------------- # sed command file to convert markdown format to edoc format -# Linux, FreeBSD and Mac OS X. Windows must install sed. +# Linux, FreeBSD and macOS. Windows must install sed. # ---------------------------------------------------------- # Use it to make a markdown readme file part of an edoc file: # FrBSD: sed -E -f > -# MacOS: sed -E -f > +# macOS: sed -E -f > # Linux: sed -r -f > # As only difference, Linux uses -r where the others use -E. # ---------------------------------------------------------- -# SAMPLE USE (FreeBSD / Mac OS X): +# SAMPLE USE (FreeBSD / macOS): # sed -E -f markedoc.sed README.markdown > overview.edoc # SAMPLE USE (Linux): # sed -r -f markedoc.sed README.markdown > overview.edoc @@ -19,7 +19,7 @@ # SAMPLE RESULTS: # samples/what-you-should-see/ & samples/what-you-could-see/ # ---------------------------------------------------------- -# SAMPLE WORKFLOW (change -r to -E for FreeBSD / Mac OS X): +# SAMPLE WORKFLOW (change -r to -E for FreeBSD / macOS): # sed -r -f markedoc.sed README.md > doc/README.edoc # erl -noshell -run edoc_run application "'myapp'" '"."' '[]' # ---------------------------------------------------------- @@ -46,7 +46,7 @@ # ********************************************************** # SCRIPT # ********************************************************** -# Ach, da kommt der Meister! Herr, die Not ist groß! ~~~ +# Ach, da kommt der Meister! Herr, die Not ist groß! ~~~ # ~~~ Die ich rief, die Geister, Werd ich nun nicht los. # ---------------------------------------------------------- # This is a sed script for use with -E/-r regexes & NOT -n. @@ -114,7 +114,7 @@ s/([ \"\'\`]+@)/\1@/g # send result to stdout p - # Now make sure that that last line is not lost: + # Now make sure that the last line is not lost: # ---------------------------------------------- # get stored back g diff --git a/doc/README.md b/doc/README.md index 52810df..2ff99ed 100644 --- a/doc/README.md +++ b/doc/README.md @@ -162,7 +162,7 @@ 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 > ` +**FreeBSD, macOS**`$ sed -E -f markedoc.sed > ` **Linux**`$ sed -r -f markedoc.sed > ` diff --git a/doc/edown_layout.md b/doc/edown_layout.md index 9bfdbdd..1c919eb 100644 --- a/doc/edown_layout.md +++ b/doc/edown_layout.md @@ -94,7 +94,7 @@ specified, no stylesheet reference will be generated.
If true, the detailed function descriptions are listed by -name, otherwise they are listed in the order of occurrence in +name; otherwise, they are listed in the order of occurrence in the source file. The default value is true.
diff --git a/doc/overview.edoc b/doc/overview.edoc index ce2ec2b..171e521 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -148,7 +148,7 @@ your `README.md' to an `EDoc' file. See bin/MARKEDOC-README.md. -**FreeBSD, Mac OS X** +**FreeBSD, macOS** `$ sed -E -f markedoc.sed > ' **Linux** diff --git a/priv/scripts/check_edown.script b/priv/scripts/check_edown.script index 636f8bb..1fe14d1 100644 --- a/priv/scripts/check_edown.script +++ b/priv/scripts/check_edown.script @@ -1,6 +1,6 @@ %% -*- erlang -*- %% -%% This helper script checks if doc is being built, otherwise removes edoc dep. +%% This helper script checks if doc is being built; otherwise, removes edoc dep. %% To build docs, call `rebar get-deps doc` %% Assumes that the rebar config is bound to CONFIG diff --git a/samples/markedoc/SAMPLE3.md b/samples/markedoc/SAMPLE3.md index 447cfab..5205a2a 100644 --- a/samples/markedoc/SAMPLE3.md +++ b/samples/markedoc/SAMPLE3.md @@ -11,7 +11,7 @@ SAMPLE 3: markedoc 0.3 README of Feb 2011 **markedoc helps you keep your project's README.md in sync with your overview.edoc.** -It is for use on Linux, FreeBSD and Mac OS X and any system that you can install **[sed][Requirements]** on. +It is for use on Linux, FreeBSD and macOS and any system that you can install **[sed][Requirements]** on. Status: [pre-beta][Status]. Quite stable and usable. See [Status][]. @@ -29,13 +29,13 @@ Use --- At the command line for -**FreeBSD, Mac OS X** +**FreeBSD, macOS** $ sed -E -f markedoc.sed > **Linux** $ sed -r -f markedoc.sed > -Usage for Linux and FreeBSD and Mac OS X is completely the same, except for the -r instead of the -E parameter. Both mean the same but happen to have a different name. In the examples below, replace -E with -r where necessary. +Usage for Linux and FreeBSD and macOS is completely the same, except for the -r instead of the -E parameter. Both mean the same but happen to have a different name. In the examples below, replace -E with -r where necessary. Requirements ------------ @@ -46,7 +46,7 @@ Requirements Test ---- - **FreeBSD, Mac OS X** + **FreeBSD, macOS** $ etc/test-bsd.sh **Linux** @@ -59,7 +59,7 @@ Sample From project root (were the README.md file is), try out: - **FreeBSD, Mac OS X** + **FreeBSD, macOS** $ sed -E -f bin/markedoc.sed samples/SAMPLE1.md > samples/doc/SAMPLE.edoc $ erl -noshell -run edoc_run application "'myapp'" '"samples"' '[]' @@ -79,7 +79,7 @@ This illustrates the motivation for the markedoc as it is now: to have all code For your own projects you'd copy markedoc.sed in the right place and do something like: - **FreeBSD, Mac OS X** + **FreeBSD, macOS** $ sed -E -f bin/markedoc.sed README.md > doc/README.edoc $ erl -noshell -run edoc_run application "'myapp'" '"."' '[]' @@ -91,7 +91,7 @@ And that's it. This could also be part of your Makefile. For the intermediary RE @docfile "doc/README.edoc" -By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows allows to embed it into additional context information that should be useful for a proper html doc. +By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows to embed it into additional context information that should be useful for a proper html doc. Accordingly, the sample stub overview.edoc used for the samples here, looks like this: @@ -219,7 +219,7 @@ H. Diedrich History ------- -02/03/11 - 0.3 - **rough edges polished:** Linux, FreeBSD, Mac OS X +02/03/11 - 0.3 - **rough edges polished:** Linux, FreeBSD, macOS * added doc for Linux use * added support for multi-line '[..]: ... "..."' references @@ -230,11 +230,11 @@ History * added test batches etc/test-bsd.sh and etc/test-linux.sh * added css sample in samples/what-you-could-see/ * added classes for `
  • ' list item tags for '[..]:...'-references -* fixed italic and bold merker interference bullet points +* fixed italic and bold marker interference bullet points * eliminated [..]: part of '[..]:...'-references, flipping "..." to lead * dev: sample creation batch make_samples.sh added -02/02/11 - 0.2 - **basics complete:** FreeBSD / Mac OS X +02/02/11 - 0.2 - **basics complete:** FreeBSD / macOS * added support for === and --- headline format * fixed cutting off of last lines @@ -244,4 +244,4 @@ History * eliminated need for echoing '@doc' first into edoc output file * added javascript title tag setting for '[..]:...'-style references. -01/31/11 - 0.1 - **first release:** FreeBSD / Mac OS X +01/31/11 - 0.1 - **first release:** FreeBSD / macOS diff --git a/samples/markedoc/test-bsd.sh b/samples/markedoc/test-bsd.sh index ecf6c7d..65b9729 100755 --- a/samples/markedoc/test-bsd.sh +++ b/samples/markedoc/test-bsd.sh @@ -1,4 +1,4 @@ -echo -n "testing markedoc - FreeBSD / Mac OS X: " +echo -n "testing markedoc - FreeBSD / macOS: " echo -n "1 ... " sed -E -f bin/markedoc.sed samples/markedoc/SAMPLE1.md > samples/markedoc/doc/SAMPLE.edoc diff --git a/samples/markedoc/test-macosx.sh b/samples/markedoc/test-macosx.sh index ecf6c7d..65b9729 100755 --- a/samples/markedoc/test-macosx.sh +++ b/samples/markedoc/test-macosx.sh @@ -1,4 +1,4 @@ -echo -n "testing markedoc - FreeBSD / Mac OS X: " +echo -n "testing markedoc - FreeBSD / macOS: " echo -n "1 ... " sed -E -f bin/markedoc.sed samples/markedoc/SAMPLE1.md > samples/markedoc/doc/SAMPLE.edoc diff --git a/samples/markedoc/what-you-should-see/SAMPLE1.edoc b/samples/markedoc/what-you-should-see/SAMPLE1.edoc index 7494e7c..d10b656 100644 --- a/samples/markedoc/what-you-should-see/SAMPLE1.edoc +++ b/samples/markedoc/what-you-should-see/SAMPLE1.edoc @@ -44,7 +44,7 @@ Open Source Erlang MySQL driver efforts are currently a fractured matter, at lea
  • Yxa: The first Erlang MySQL driver seems to have been written in 2005 by Magnus Ahltorp at the Royal Institute of Technology. It is the basis for the following two. The original mysql driver source is stable since at least 2007, it is available as part of the SIP proxy Yxa 1.0 (hosted on github).
    • -
  • ejabberd: Already in 2006, a fork was created by Mickael Remond at Process One to become part of the successful instant messaging server ejabberd (also hosted at github). It can be assumed to be as stable as the Yxa branch, and it didn't change anything in the lowest level, mysql_recv.erl. The differences to the original Yxa branch mainly consists of added inspection functions that help using query results, and an independent adoption to the MySQL 4.1 client-server protocol. Also, the original Yxa branch has meanwhile adopted edoc comment format. Find a diff here, one ignoring comment lines here.
    • +
  • ejabberd: Already in 2006, a fork was created by Mickael Remond at Process One to become part of the successful instant messaging server ejabberd (also hosted at github). It can be assumed to be as stable as the Yxa branch, and it didn't change anything in the lowest level, mysql_recv.erl. The differences to the original Yxa branch mainly consists of added inspection functions that help using query results, and an independent adoption to the MySQL 4.1 client-server protocol. Also, the original Yxa branch has meanwhile adopted edoc comment format. See a Diff of ejabberd mysql driver vs yxa mysql driver, or a Diff of ejabberd mysql driver vs yxa mysql driver (comment changes ignored).
  • erlang-mysql-driver: in 2006/07 Yariv Sadan created a fork from the ejabberd branch, made it a standalone project, gave it the name that stuck, and hosted it at Google Code. Before he moved on to work at Facebook, he had added higher level handling of prepared statements and transactions, and stated that he had improved connection pooling and logging. There were changes both in the original Yxa and the ejabberd branch after the forking off that seem to never have made their way into the erlang-mysql-driver branch, which now lies dormant since Oct '07. Docs were somewhat unsatisfying, as much as for the earlier branches. In Feb '10, Dave Smith started making some
    • updates and put them on github, were the driver is now enjoying a couple of active forks that make for a convincing case in favor of the github Network graph. diff --git a/samples/markedoc/what-you-should-see/SAMPLE3.edoc b/samples/markedoc/what-you-should-see/SAMPLE3.edoc index 3cc61ea..b04e5ec 100644 --- a/samples/markedoc/what-you-should-see/SAMPLE3.edoc +++ b/samples/markedoc/what-you-should-see/SAMPLE3.edoc @@ -11,7 +11,7 @@ markedoc helps you keep your project's README.md in sync with your overview.edoc. -It is for use on Linux, FreeBSD and Mac OS X and any system that you can install sed on. +It is for use on Linux, FreeBSD and macOS and any system that you can install sed on. Status: pre-beta. Quite stable and usable. See Status. @@ -28,7 +28,7 @@ Your contribution to make markedoc stable is highly sed: is part of any Linux, FreeBSD and Mac OSX distribution, also see Notes. @@ -47,7 +47,7 @@ Usage for Linux and FreeBSD and Mac OS X is completely the same, except for the === Test === - FreeBSD, Mac OS X + FreeBSD, macOS ``` $ etc/test-bsd.sh ''' @@ -63,7 +63,7 @@ Then check html files as listed in the output. From project root (were the README.md file is), try out: - FreeBSD, Mac OS X + FreeBSD, macOS ``` $ sed -E -f bin/markedoc.sed samples/SAMPLE1.md > samples/doc/SAMPLE.edoc $ erl -noshell -run edoc_run application "'myapp'" '"samples"' '[]' @@ -91,7 +91,7 @@ This illustrates the motivation for the markedoc as it is now: to have all code For your own projects you'd copy markedoc.sed in the right place and do something like: - FreeBSD, Mac OS X + FreeBSD, macOS ``` $ sed -E -f bin/markedoc.sed README.md > doc/README.edoc $ erl -noshell -run edoc_run application "'myapp'" '"."' '[]' @@ -109,7 +109,7 @@ And that's it. This could also be part of your Makefile. For the intermediary RE @@docfile "doc/README.edoc" ''' -By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows allows to embed it into additional context information that should be useful for a proper html doc. +By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows to embed it into additional context information that should be useful for a proper html doc. Accordingly, the sample stub overview.edoc used for the samples here, looks like this: @@ -242,7 +242,7 @@ H. Diedrich hd2010@eonblast.com ``` ''' -02/03/11 - 0.3 - rough edges polished: Linux, FreeBSD, Mac OS X +02/03/11 - 0.3 - rough edges polished: Linux, FreeBSD, macOS
  • added doc for Linux use
  • added support for multi-line '[..]: ... "..."' references
    • @@ -253,13 +253,13 @@ H. Diedrich hd2010@eonblast.com
  • added test batches etc/test-bsd.sh and etc/test-linux.sh
  • added css sample in samples/what-you-could-see/
  • added classes for `
  • ' list item tags for '[..]:...'-references
    • -
  • fixed italic and bold merker interference bullet points
    • +
  • fixed italic and bold marker interference bullet points
  • eliminated [..]: part of '[..]:...'-references, flipping "..." to lead
  • dev: sample creation batch make_samples.sh added
    • ``` ''' -02/02/11 - 0.2 - basics complete: FreeBSD / Mac OS X +02/02/11 - 0.2 - basics complete: FreeBSD / macOS
  • added support for === and --- headline format
  • fixed cutting off of last lines
    • @@ -271,7 +271,7 @@ H. Diedrich hd2010@eonblast.com ``` ''' -01/31/11 - 0.1 - first release: FreeBSD / Mac OS X +01/31/11 - 0.1 - first release: FreeBSD / macOS ``` '''