A bunch of documentation updates

Author: choptastic

doc/markdown/actions.md

@@ -1,56 +1,55 @@
 <!-- dash: Actions | Guide | ##:Section -->
 
-
 # Nitrogen Actions
 
 ## Base Action
 
-*  [Base Action](action_base.md) - All actions contain these attributes.
+- [Base Action](action_base.md) - All actions contain these attributes.
 
 ## Page Manipulation
 
-* [Redirect](redirect.md)
-* [Event](event.md)
-* [Update](update.md) (includes Update, Replace, Insert Top,
+- [Redirect](redirect.md)
+- [Event](event.md)
+- [Update](update.md) (includes Update, Replace, Insert Top,
   Insert Bottom, Insert Before, Insert, After, and Remove)
-* [Script](script.md)
-* [JS Function](js_fun.md)
-* [Open Window](open_window.md)
-* [API Actions](action_api.md)
-* [Comet Action](comet.md)
+- [Script](script.md)
+- [JS Function](js_fun.md)
+- [Open Window](open_window.md)
+- [API Actions](action_api.md)
+- [Comet Action](comet.md)
 
 ## Forms
 
-* [Set](set.md) | [Set Multiple](set_multiple.md)
-* [Disable](disable.md) | [Enable](enable.md)
-* [Make Readonly](make_readonly.md) | [Make Writable](make_writable.md)
-* [Disable Option](disable_option.md) | [Enable Option](enable_option.md)
-* [Add Option](add_option.md) | [[Remove Option](remove_option.md)
-* [If Value - Conditional Actions](if_value.md)
+- [Set](set.md) | [Set Multiple](set_multiple.md)
+- [Disable](disable.md) | [Enable](enable.md)
+- [Make Readonly](make_readonly.md) | [Make Writable](make_writable.md)
+- [Disable Option](disable_option.md) | [Enable Option](enable_option.md)
+- [Add Option](add_option.md) | [[Remove Option](remove_option.md)
+- [If Value - Conditional Actions](if_value.md)
 
 ## Form Validation
 
-* [Validate](validate.md)
-* [Clear Validation](clear_validation.md)
-* [Custom Javascript Validation](js_custom.md)
+- [Validate](validate.md)
+- [Clear Validation](clear_validation.md)
+- [Custom Javascript Validation](js_custom.md)
 
 ## Effects
 
-* [Show](show.md) | [Hide](hide.md)
-* [Appear](appear.md) | [Fade](fade.md)
-* [Slide Down](slide_down.md) | [Slide Up](slide_up.md)
-* [Toggle](toggle.md)
-* [Animate](animate.md)
-* [Effect](effect.md)
-* [Add Class](add_class.md) | [Remove Class](remove_class.md)
+- [Show](show.md) | [Hide](hide.md)
+- [Appear](appear.md) | [Fade](fade.md)
+- [Slide Down](slide_down.md) | [Slide Up](slide_up.md)
+- [Toggle](toggle.md)
+- [Animate](animate.md)
+- [Effect](effect.md)
+- [Add Class](add_class.md) | [Remove Class](remove_class.md)
 
 ## Feedback and Debugging
 
-* [Alert](alert.md)
-* [Confirm](confirm.md)
-* [Browser Console Log](console_log.md)
-* [Before Postback](before_postback.md)
+- [Alert](alert.md)
+- [Confirm](confirm.md)
+- [Browser Console Log](console_log.md)
+- [Before Postback](before_postback.md)
 
 ## See Also
 
-* [Nitrogen Element Paths](paths.md)
+- [Nitrogen Element Paths](paths.md)

doc/markdown/before_postback.md

@@ -1,25 +1,25 @@
-## Before Postback Action - #before_postback {}
+## Before Postback Action - `#before_postback{}`
 
 Adds custom javascript to be executed before every postback is performed on the
 page.
 
 ### Usage
 
 ```erlang
-	wf:wire(#before_postback{script="console.log('Sending a postback');"}).
+wf:wire(#before_postback{script="console.log('Sending a postback');"}).
 ```
 
 ### Attributes
 
-* `script`: Raw JavaScript to be executed before postback is sent.
+- `script`: Raw JavaScript to be executed before postback is sent.
 
 ### Notes
 
 The provided script will literally run before every postback on the page.
 
 ### See Also
 
-* [base action](./action_base.md)
-* [js_fun action](./js_fun.md)
-* [script action](./script.md)
-
+- [base action](./action_base.md)
+- [`#js_fun` action](./js_fun.md)
+- [`#script{}` action](./script.md)
+- [Postback Handler](postback.md)

doc/markdown/comet.md

@@ -1,21 +1,23 @@
+<!-- dash: #comet{} | Event | ###:Section -->
+
 ## Comet Action - `#comet{}`
 
 Enables asynchronous processing with Nitrogen's Comet feature.
 
 ### Usage
 
 ```erlang
-	wf:wire(#comet{
-		function = fun comet_loop/0}
-		pool = my_pool,
-		scope = local,
-	}).
-
-	comet_loop() ->
-		wf:update(my_time_element, qdate:to_string("Y-m-d h:i:s")),
-		wf:flush(),
-		timer:sleep(1000),
-		comet_loop().
+ wf:wire(#comet{
+  function = fun comet_loop/0}
+  pool = my_pool,
+  scope = local,
+ }).
+
+ comet_loop() ->
+  wf:update(my_time_element, qdate:to_string("Y-m-d h:i:s")),
+  wf:flush(),
+  timer:sleep(1000),
+  comet_loop().
 ```
 
 This action will start the `comet_loop/0` function in the background as part of
@@ -28,22 +30,22 @@ loops back to itself.
 
 ### Attributes
 
-* `function` (function with arity 0) - An Erlang function that executes in the
+- `function` (function with arity 0) - An Erlang function that executes in the
   background. The function generates actions that are then sent to the browser
   via the accumulator.
 
-* `pool` (Atom) - A pool name for the AsyncFunction process.
+- `pool` (Atom) - A pool name for the AsyncFunction process.
 
-* `scope` (Atom) - Specifies the scope of the pool. Can be either `local` or
+- `scope` (Atom) - Specifies the scope of the pool. Can be either `local` or
   `global`. A `local` pool applies only to the current series of page requests
   by a user, while a `global` pool applies to the entire system.
 
-* `dying_message` (Any Erlang Term) - A message to be sent to the member functions if
+- `dying_message` (Any Erlang Term) - A message to be sent to the member functions if
   the function dies.
 
-* `reconnect_actions` (String, Action, or List or Actions) - Nitrogen actions
+- `reconnect_actions` (String, Action, or List or Actions) - Nitrogen actions
   or JavaScript to be executed when reconnecting to the page after a
-  disconnection.  Typically, it might be something like
+  disconnection. Typically, it might be something like
   `#event{postback=attempt_reconnect}` to trigger a postback to try to
   reconnect to the comet.
 
@@ -54,11 +56,10 @@ or `wf:comet_global`. See Nitrogen's [Function Reference](./api.md)
 
 ### See Also
 
-* [base action](./action_base.md)
-* [delay_body element](./delay_body)
-* [Comet Demo1](https://nitrogenproject.com/demos/comet1)
-* [Comet Demo1](https://nitrogenproject.com/demos/comet2)
-* [Comet Demo1](https://nitrogenproject.com/demos/comet3)
-* [sync_panel demo](https://nitrogenproject.com/demos/sync_panel)
-* [delay_body demo](https://nitrogenproject.com/demos/delay_body)
-
+- [base action](./action_base.md)
+- [delay_body element](./delay_body)
+- [Comet Demo1](https://nitrogenproject.com/demos/comet1)
+- [Comet Demo1](https://nitrogenproject.com/demos/comet2)
+- [Comet Demo1](https://nitrogenproject.com/demos/comet3)
+- [sync_panel demo](https://nitrogenproject.com/demos/sync_panel)
+- [delay_body demo](https://nitrogenproject.com/demos/delay_body)

doc/markdown/old_config.md doc/markdown/config_2.3.mddoc/markdown/old_config.md renamed to doc/markdown/config_2.3.md

@@ -1,44 +1,46 @@
 <!-- dash: Base Element | Guide | ###:Section -->
 
-
-
 ## Base Element
 
-  In object-oriented parlance, all Nitrogen elements are subclasses of
-  the base element. This means that all Nitrogen elements can use the
-  attributes listed below.
+In object-oriented parlance, all Nitrogen elements are subclasses of
+the base element. This means that all Nitrogen elements can use the
+attributes listed below.
 
 ### Usage
 
 ```erlang
-   #some_element { id=myElementID, show_if=true, class="someclass", style="border: solid 1px black;" }
-
+#some_element{
+    id=myElementID,
+    show_if=true,
+    class="someclass",
+    style="border: solid 1px black;"
+}
 ```
 
 ### Attributes
 
-   * `id` (atom) - The id of the element within the element tree.  The id is
-    used to wire events and to reference the element in client side javascript.
-    See the Nitrogen wiki for more information.
+- `id` (atom) - The id of the element within the element tree. The id is
+  used to wire events and to reference the element in client side javascript.
+  See the Nitrogen wiki for more information.
+
+- `actions` (action, list of actions) - The actions to attach to the
+  element. This can be a single Nitrogen action, or a list of actions.
 
-   * `actions` (action, list of actions) - The actions to attach to the
-    element. This can be a single Nitrogen action, or a list of actions.
+- `show_if` (boolean) - If set to true, this element will be rendered.
+  Otherwise, it will not.
 
-   * `show_if` (boolean) - If set to true, this element will be rendered.
-    Otherwise, it will not.
+- `class` (atom or string) - Set the CSS class of the element.
 
-   * `class` (atom or string) - Set the CSS class of the element.
+- `title` (string) - Set the HTML `title` attribute of the element.
 
-   * `title` (string) - Set the HTML `title` attribute of the element.
+- `style` (string) - Sets inline CSS style on the element.
 
-   * `style` (string) - Sets inline CSS style on the element.
-  
-   * `html_id` (atom or string) - Sets the HTML `id` attribute of the 
-    element.
+- `html_id` (atom or string) - Sets the HTML `id` attribute of the
+  element.
+
+- `data_fields` (property list) - Sets a series of HTML `data-` fields in
+  the element. For example, the following `#panel`:
 
-   * `data_fields` (property list) - Sets a series of HTML `data-` fields in
-    the element. For example, the following `#panel`:
-  
 ```erlang
   #panel{
     data_fields=[
@@ -48,10 +50,9 @@
   }
 
 ```
-  
+
     Would produce the following pseudo-HTML:
-  
-```html
-  <div data-ship="bounty" data-action="mutiny"></div>
 
+```html
+<div data-ship="bounty" data-action="mutiny"></div>
 ```

doc/markdown/element_base.md

@@ -25,7 +25,7 @@
 
 - [Heading 1-6](basic_tag.md)
 - [Paragraph](basic_tag.md)
-- [Break](br.md)
+- [Line Break](br.md)
 - [Image](image.md)
 - [Hyperlink](link.md) | [Email Hyperlink](email_link.md)
 - [Literal](literal.md)
@@ -64,7 +64,7 @@
 - [In-Place Textbox](inplace_textbox.md)
 - [In-Place Textarea](inplace_textarea.md)
 - [Spinner](spinner.md)
-- [Quick Form](quickform.md)
+- [MISSING Quick Form](quickform.md)
 
 ## Mobile Elements
 
@@ -102,4 +102,3 @@
 ## See Also
 
 - [Nitrogen Element Paths](paths.md)
-- [jQuery Mobile Integration](jquery_mobile_integration.md)

doc/markdown/elements.md

@@ -1,6 +1,6 @@
 ## Enable Option Action - `#enable_option{}`
 
-This action tells Nitrogen to enable an item in a #dropdown field. 
+This action tells Nitrogen to enable an item in a `#dropdown` field.
 
 ### Usage
 
@@ -14,14 +14,12 @@ wf:wire(my_dropdown, #enable_option{value="item_to_enable"}).
 
 ### Attributes
 
-* `target` (Element ID) - Which `#dropdown{}` to enable the item from.
-* `value` (String) - The value of the `#option` to enable in the
+- `target` (Element ID) - Which `#dropdown{}` contains the item you want to
+  enable.
+- `value` (String) - The `value` of the `#option` you wish to enable in the
   `#dropdown{}` list.
 
 ### See Also
 
-* [base action](./action_base.md)
-* [`#disable_option` action](./disable_option.md)
-
-
-
+- [base action](./action_base.md)
+- [`#disable_option` action](./disable_option.md)