Permalink
Browse files

add initial draft version of the user doc

  • Loading branch information...
llaville committed Mar 26, 2015
1 parent 004ff34 commit b8d6cb5daff58daeb4f2c7c533da8286cbfdaa86
View
@@ -1,17 +1,21 @@
:author: Laurent Laville
:keywords: PHP, UML, Graphviz, PlantUML
:revnumber: 1.0.0-RC1
:revdate: 2015-03-19
:toc2:
:toc-placement: right
:brand: UmlWriter
:brandref: https://github.com/llaville/asciidoc-bootstrap-backend
:brandref: http://php5.laurent-laville.org/umlwriter/
:brandver:
:toc2:
:toc-placement: right
:jumbotron:
:jumbotron-fullwidth:
:footer:
:footer-fullwidth:
:navinfo1:
:icons!:
:iconsfont: font-awesome
:imagesdir: ./images
:idprefix: _
:gitbranch: master
:rawbaseurl: https://raw.github.com/llaville/umlwriter/{gitbranch}
:gitproject: https://github.com/llaville/umlwriter
:reflector-engine-1: https://github.com/llaville/php-reflect[Bartlett\Reflect]
:reflector-engine-2: https://github.com/Andrewsville/PHP-Token-Reflection[Andrewsville\TokenReflection]
View
@@ -0,0 +1,58 @@
= Cover
:description: UmlWriter Book
include::attributes.asciidoc[]
:navbar!:
:themeswitcher!:
:jumbotron!:
:toc!:
:toc2!:
:stylesheet: cover.css
== UmlWriter
[role="cover"]
--
[subs="none"]
++++++++++++++++++++++++++++++++++++++
<span class="fa-stack">
<i class="fa fa-sitemap fa-stack-1x iconsfont-5x" style="bottom: -0.9em; left: 0.25em;"></i>
<i class="fa fa-file-o iconsfont-9x"></i>
</span>
++++++++++++++++++++++++++++++++++++++
--
[role="bg-info"]
--
[big]#The Book#
--
[pull-left]#Published with AsciiDoc-Bootstrap backend v4#
[pull-right]#by Laurent Laville#
unfloat::[]
[role="col-md-6 panels"]
====
[panel,primary]
.Read it online
--
* image:icons/font-awesome/files-o.png[alt="multiple html files",icon="files-o",iconsfont="font-awesome"] link:getting-started.html[Multiple HTML files]
* image:icons/font-awesome/file-o.png[alt="single html file",icon="file-o",iconsfont="font-awesome"] link:umlwriter-book.html[Single HTML file]
* image:icons/font-awesome/file-pdf-o.png[alt="pdf file",icon="file",iconsfont="font-awesome"] link:umlwriter-book.pdf[PDF file]
* image:icons/font-awesome/book.png[alt="epub file",icon="book",iconsfont="font-awesome"] link:umlwriter-book.epub[ePub file]
* image:icons/font-awesome/windows.png[alt="html help file",icon="windows",iconsfont="font-awesome"] [text-danger]*HTML Help file*
--
====
[role="col-md-6 panels"]
====
[panel,info]
.Read it offline (download a zip archive)
--
* image:icons/font-awesome/files-o.png[alt="multiple html files",icon="files-o",iconsfont="font-awesome"] link:umlwriter-book.chunked.zip[Multiple HTML files]
* image:icons/font-awesome/file-o.png[alt="single html file",icon="file-o",iconsfont="font-awesome"] link:umlwriter-book.xhtml.zip[Single HTML file]
* image:icons/font-awesome/file-pdf-o.png[alt="pdf file",icon="file",iconsfont="font-awesome"] link:umlwriter-book.pdf.zip[PDF file]
* image:icons/font-awesome/book.png[alt="epub file",icon="book",iconsfont="font-awesome"] link:umlwriter-book.epub.zip[ePub file]
* image:icons/font-awesome/windows.png[alt="html help file",icon="windows",iconsfont="font-awesome"] link:umlwriter-book.chm.zip[HTML Help file]
--
====
View
BIN +17.7 KB docs/cover.png
Binary file not shown.
View
@@ -34,7 +34,7 @@ <h3>About Us</h3>
<div id="footer-text">
Version <span class="badge">{revnumber}</span><br>
Last updated {docdate} {doctime}<br>
Built with <a href="{brandref}">AsciiDoc-Bootstrap backend</a> {bootstrap-backend-version}
Built with <a href="https://github.com/llaville/asciidoc-bootstrap-backend">AsciiDoc-Bootstrap backend</a> {bootstrap-backend-version}
</div>
</div>
<div class="col-md-3">
@@ -0,0 +1,165 @@
= Getting Started
:description: Startup in 5 minutes
include::revision.asciidoc[]
include::attributes.asciidoc[]
:pharstable: http://bartlett.laurent-laville.org/get/umlwriter-1.0.0-RC2.phar
== Download
We distribute a http://www.php.net/phar[PHP Archive] (PHAR) that contains
all required dependencies of [label label-primary]#UmlWriter# bundled in a single file.
ifdef::basebackend-bootstrap[]
link:{pharstable}["Download the latest version",role="primary",icon="glyphicon-download-alt",options="block,white"]
endif::basebackend-bootstrap[]
ifndef::basebackend-bootstrap[]
link:{pharstable}[Download the latest version]
endif::basebackend-bootstrap[]
Make it executable, and put it into your `$PATH`.
[source,bash]
----
$ chmod +x umlwriter-1.0.0-RC2.phar
$ mv umlwriter-1.0.0-RC2.phar /usr/local/bin/umlwriter
$ umlwriter --version
----
You can also immediately use the PHAR after you have downloaded it.
[source,bash]
----
$ wget http://bartlett.laurent-laville.org/get/umlwriter-1.0.0-RC2.phar
$ php umlwriter-1.0.0-RC2.phar --version
----
With both methods then you have this output :
[role="output"]
====
----
umlWriter version 1.0.0-RC2
----
====
Alternatively, you can also use https://getcomposer.org/[Composer]
to create a new project from an existing [label label-primary]#UmlWriter# package.
This is the equivalent of doing a git clone checkout followed by a composer install of the vendors.
[source,bash]
----
$ php composer.phar create-project bartlett/umlwriter /path/to/install 1.0.0-RC2
----
Where +/path/to/install+ is your install directory.
== Generating a Diagram
UML diagrams produced, may be either :
* restricted to a simple class and its direct dependencies.
* restricted to a single namespace (with all its objects).
* non-restricted (all namespaces and their objects).
The following diagram processors (output formats) are available:
* Graphviz syntax with HTML-like labels
* PlantUML syntax with default fonts and colors
TIP: Detailed descriptions and examples of the diagramming languages are available on the
http://graphviz.org/[Graphviz] and http://plantuml.sourceforge.net/[PlantUML] websites.
The following reverse-engines are supported:
* {reflector-engine-1} (default in CLI mode)
* {reflector-engine-2}
== Generating a diagram statements from a Terminal
* In graphviz format with `bartlett/php-reflect` reverse-engine
+
[source,bash]
----
$ umlwriter diagram:render --reflector=reflect --processor=graphviz /path/to/data_source
----
* In graphviz format with `andrewsville/php-token-reflection` reverse-engine
+
[source,bash]
----
$ umlwriter diagram:render --reflector=tokenreflection --processor=graphviz /path/to/data_source
----
* In plantuml format with default reverse-engine (`bartlett/php-reflect`)
+
[source,bash]
----
$ umlwriter diagram:render --processor=plantuml /path/to/data_source
----
== Generating a diagram image
WARNING: You must have installed correctly graphviz or plantuml before to continue.
* With Graphviz and `png` output format
+
[source,bash]
----
$ dot -Tpng -O /path/to/gv_file
----
+
Where +/path/to/gv_file+ is a file contening Graphviz syntax statements produced by
the [label label-primary]#umlwriter# command.
* With PlantUML and `png` output format
+
[source,bash]
----
$ java -jar plantuml.jar -Tpng /path/to/puml_file -o /path/to/ouput/dir
----
+
Where +/path/to/puml_file+ is a file contening PlantUML syntax statements produced by
the [label label-primary]#umlwriter# command.
+
And +/path/to/output/dir+ is the directory where the image will be generated.
== Summary
[role="lead"]
Let's review what we've done :
* downloaded the latest stable PHAR version.
* created project using Composer.
* built your first graphviz and plantuml UML diagram (and `png` image) from any data source.
== Next
[role="lead"]
Choose your way depending of your skill level.
************************************************
.Read more
* Want to learn more about the Graphviz or PlantUML processor,
have a look on
ifdef::basebackend-html[]
link:processor-guide.html[processor's guide]
endif::basebackend-html[]
ifdef::basebackend-docbook[]
xref:_processor_guide[]
endif::basebackend-docbook[]
* Want to learn more about the compatible reverse-engine,
have a look on
ifdef::basebackend-html[]
link:reflector-guide.html[reflector's guide]
endif::basebackend-html[]
ifdef::basebackend-docbook[]
xref:_reflector_guide[]
endif::basebackend-docbook[]
************************************************
View
@@ -1,22 +1,14 @@
= {title}
:title: UmlWriter
:description: Create UML class diagrams from your PHP source.
include::revision.asciidoc[]
include::attributes.asciidoc[]
:stable: 1.0.0-RC1
:stablePubDate : Marth 19, 2015
:navbar!:
:icons!:
:toc!:
:toc2!:
:navbar!:
:themeswitcher!:
:jumboinfo:
:iconsfont: font-awesome
:jumbotron:
:jumbotron-fullwidth:
:footer:
:footer-fullwidth:
:reflector-engine-1: https://github.com/llaville/php-reflect[Bartlett\Reflect]
:reflector-engine-2: https://github.com/Andrewsville/PHP-Token-Reflection[Andrewsville\TokenReflection]
== Releases
@@ -25,10 +17,17 @@ include::attributes.asciidoc[]
[panel,primary]
.v1
--
*Release Candidate* [label label-primary]#{stable}#
*Release Candidate* [label label-primary]#{revnumber}#
It was published on {stablePubDate}.
ifdef::basebackend-bootstrap[]
link:./manual/current/en/getting-started.html["Learn more",role="primary",icon="glyphicon-book",options="block"]
endif::[]
ifndef::basebackend-bootstrap[]
link:./manual/current/en/getting-started.html[Learn more]
endif::[]
--
====
@@ -70,8 +69,9 @@ http://plantuml.sourceforge.net/[PlantUML])
.Graphviz
--
image::graphviz_sample1.png[options="responsive"]
--
Built with {rawbaseurl}/examples/graphviz.php[examples/graphviz.php]
--
====
[role="col-md-6"]
@@ -80,8 +80,9 @@ Built with {rawbaseurl}/examples/graphviz.php[examples/graphviz.php]
.PlantUML
--
image::plantuml_sample1.png[options="responsive"]
--
Built with {rawbaseurl}/examples/plantuml.php[examples/plantuml.php]
--
====
unfloat::[]
@@ -119,6 +120,6 @@ and is released under the http://creativecommons.org/licenses/by-sa/3.0/[Attribu
--
[bg-success]*Code*
All source code is released under the https://github.com/llaville/umlwriter/blob/master/LICENSE[Apache Licence Version 2.0].
All source code is released under the https://github.com/llaville/umlwriter/blob/master/LICENSE[BSD 3-Clause].
--
====
View
@@ -9,6 +9,16 @@
<li>
<a href="index.html"><span class="glyphicon glyphicon-home"></span> Home</a>
</li>
<li>
<a href="getting-started.html"><span class="glyphicon glyphicon-off"></span> Getting Started</a>
</li>
<li class="dropdown">
<a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-book"></span> Guides <b class="caret"></b></a>
<ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
<li><a tabindex="-1" href="processor-guide.html">Processor Guide</a></li>
<li><a tabindex="-1" href="reflector-guide.html">Reflector Guide</a></li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
@@ -0,0 +1,17 @@
= Processor Guide
:description: Start using UmlWriter processors
include::revision.asciidoc[]
include::attributes.asciidoc[]
ifdef::basebackend-docbook[]
[partintro]
--
WARNING: Documentation planned to be release for the stable version !
--
endif::basebackend-docbook[]
ifdef::basebackend-html[]
WARNING: Documentation planned to be release for the stable version !
endif::basebackend-html[]
@@ -0,0 +1,17 @@
= Reflector Guide
:description: Start using UmlWriter reverse-engines
include::revision.asciidoc[]
include::attributes.asciidoc[]
ifdef::basebackend-docbook[]
[partintro]
--
WARNING: Documentation planned to be release for the stable version !
--
endif::basebackend-docbook[]
ifdef::basebackend-html[]
WARNING: Documentation planned to be release for the stable version !
endif::basebackend-html[]
View
@@ -0,0 +1,3 @@
:revdate: 2015-03-26
:revnumber: 1.0.0-RC2
:stablePubDate: Marth 26, 2015
Oops, something went wrong.

0 comments on commit b8d6cb5

Please sign in to comment.