Permalink
Browse files

apply a few patches to the documentation

+ simplify the require_once path in example code in doc/User-defined-converters.md by using "/"s instead of the DIRECTORY_SEPARATOR constant
+ add link to the GustavBase.php file on the master branch in doc/Private-API:-GustavBase.md
+ add link to archive download of the master branch in doc/Getting-started.md
  • Loading branch information...
Lucas Krause
Lucas Krause committed Feb 24, 2015
1 parent 203c5b8 commit ab0a9bccf937a231fc11d401d2470f28f10b8721
Showing with 4 additions and 4 deletions.
  1. +2 −2 doc/Getting-started.md
  2. +1 −1 doc/Private-API:-GustavBase.md
  3. +1 −1 doc/User-defined-converters.md
View
@@ -1,7 +1,7 @@
##Installing Gustav
Installing Gustav is easy-peasy. Actually it's not even a real step.
The only thing to do is creating a FTP connection to the server or webspace and copying the [downloaded files](#) to the server. Done.
The only thing to do is creating a FTP connection to the server or webspace and copying the [downloaded files](https://github.com/futape/gustav/archive/master.zip) to the server. Done.
@@ -47,4 +47,4 @@ For more information on source files see [*Source files*](Source-files).
##Exploring Gustav
Theoretically this is everything you need to know for publishing your documents on the web using Gustav.
However, Gustav has so much more to offer. [Go and explore](Home) the Gustav universe!
However, Gustav has so much more to offer. [Go and explore](Home) the Gustav universe!
@@ -181,7 +181,7 @@ Inlines a text or a HTML code.
Removes HTML tags of a HTML code on basis of their display and semantic meaning (if enabled), decodes HTML entities and inlines the resulting plain text. *Inlining* means that whitespaces that aren't simple spaces (such as horizontal tabs or linefeed characters) are replaced with one.
If the content is treated as HTML code, sequences of whitespaces are stripped to 1 space.
For more information read the comments in the source code of this function.
For more information read the comments in the [source code](https://github.com/futape/gustav/blob/master/src/futape/gustav/GustavBase.php) of this function.
<dl>
<dt><code>$text</code></dt>
@@ -32,7 +32,7 @@ Gustav doesn't provide an option for defining aliases for user-defined converter
One clever solution is to use [`GustavContent`](API#gustavcontent)'s [`convContent()` method](Private-API%3a-GustavContent#string-convcontent-string-content-string-converter--mixed-next_converter--) which is available publically via the `GustavContentHooks` class. To create an alias you have to create a new converter file named like the alias name that should be defined and containing something like the code below. The following code defines an alias for a user-defined converter named `markdown`.
<?php
require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "..", "..", "GustavContent.php"));
require_once rtrim(__DIR__, DIRECTORY_SEPARATOR)."/../../GustavContent.php";
use futape\gustav\GustavHooks;

0 comments on commit ab0a9bc

Please sign in to comment.