docs: add package-info.java and readme.md

(for `png` to `zopfli`)

Todo or remaining directory:
- api
- compositediagram
- core
- decoration
- flowdiagram
- golem
- klimt
- mda
- text
- utils
- webp

src/net/sourceforge/plantuml/annotation/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * Provides classes used to manage Java User Annotation on PlantUML.
+ *
+ */
+package net.sourceforge.plantuml.annotation;

src/net/sourceforge/plantuml/annotation/readme.md

@@ -0,0 +1,6 @@
+# Directory Documentation for `annotation`
+
+## Description
+This package provides classes used to manage Java User Annotation on PlantUML.
+
+Currently use to identify 'DeadCode' with the `@DeadCode` Annotation.

src/net/sourceforge/plantuml/argon2/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Provides classes used to manage the password-hashing function nammed
+ * Provides classes used to manage the Password-Hashing Function nammed
  * <a href="https://github.com/andreas1327250/argon2-java" target="_top">
  * Argon2</a>.
  *

src/net/sourceforge/plantuml/argon2/readme.md

@@ -4,19 +4,19 @@
 This package provides classes used to manage the password-hashing function nammed [Argon2](https://github.com/andreas1327250/argon2-java).
 
 ## Link
-- [:octocat:Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
+- :octocat: [Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
 
 ## Reference
 - [Argon2 _(on Wikipedia)_](https://en.wikipedia.org/wiki/Argon2)
 - [RFC 9106 (Argon2)](https://datatracker.ietf.org/doc/html/rfc9106)
-- [:octocat:P-H-C/PHC-winner-argon2](https://github.com/P-H-C/phc-winner-argon2)
+- :octocat: [P-H-C/PHC-winner-argon2](https://github.com/P-H-C/phc-winner-argon2)
 - [Password Hashing Competition (PHC)](https://www.password-hashing.net)
 - [BLAKE2](https://www.blake2.net)
 - [RFC 7693 (BLAKE2)](https://datatracker.ietf.org/doc/html/rfc7693)
 
 ## Credit
-- [:octocat:Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
+- :octocat: [Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
-- [:octocat:Alphazero/Blake2b](https://github.com/alphazero/Blake2b/)
+- :octocat: [Alphazero/Blake2b](https://github.com/alphazero/Blake2b/)
 
 ## Misc.
 

src/net/sourceforge/plantuml/brotli/package-info.java

@@ -11,5 +11,8 @@
  * </ul>
  * </p>
  * 
+ * @see net.sourceforge.plantuml.code.deflate
+ * @see net.sourceforge.plantuml.zopfli
+ * 
  */
 package net.sourceforge.plantuml.brotli;

src/net/sourceforge/plantuml/brotli/readme.md

@@ -4,14 +4,14 @@
 This package provides classes used to manage [Brotli Compression Algorithm](https://github.com/google/brotli).
 
 ## Link
-- [:octocat:Google/Brotli](https://github.com/google/brotli)
+- :octocat: [Google/Brotli](https://github.com/google/brotli)
 
 ## Reference
 - [Brotli _(on Wikipedia)_](https://en.wikipedia.org/wiki/Brotli)
 - [RFC 7932](https://datatracker.ietf.org/doc/html/rfc7932)
 
 ## Credit
-- [:octocat:Google/Brotli](https://github.com/google/brotli)
+- :octocat: [Google/Brotli](https://github.com/google/brotli)
 
 ## Misc.
 - [Brötchen _(on Wikipedia)_](https://de.wikipedia.org/wiki/Br%C3%B6tchen)

src/net/sourceforge/plantuml/code/readme.md

@@ -13,7 +13,7 @@ This package provides classes used to manage Coding and Compression.
 - [RFC 1951 (DEFLATE)](https://datatracker.ietf.org/doc/html/rfc1951)
 
 ## Credit
-- [:octocat:Nayuki/Simple-DEFLATE-decompressor](https://github.com/nayuki/Simple-DEFLATE-decompressor)
+- :octocat: [Nayuki/Simple-DEFLATE-decompressor](https://github.com/nayuki/Simple-DEFLATE-decompressor)
 
 ## Misc.
 

src/net/sourceforge/plantuml/cucadiagram/package-info.java

@@ -0,0 +1,16 @@
+/**
+ * Provides classes used to manage PlantUML Class-UseCase-Activity (CUCA) Diagram.
+ * 
+ * <p>
+ * The PlantUML CUCA Diagrams are:
+ * <ul>
+ *  <li><a href="https://plantuml.com/class-diagram" target="_top">
+ *  Class Diagram</a>;</li>
+ *  <li><a href="https://plantuml.com/use-case-diagram" target="_top">
+ *  Use Case Diagram</a>;</li>
+ *  <li><a href="https://plantuml.com/activity-diagram-legacy" target="_top">
+ *  Activity Diagram (legacy)</a>.</li>
+ * </ul>
+ * </p>
+ */
+package net.sourceforge.plantuml.cucadiagram;

src/net/sourceforge/plantuml/cucadiagram/readme.md

@@ -0,0 +1,8 @@
+# Directory Documentation for `cucadiagram`
+
+## Description
+This package provides classes used to manage PlantUML Class-UseCase-Activity (CUCA) Diagram:
+- [Class Diagram](https://plantuml.com/class-diagram)
+- [Use Case Diagram](https://plantuml.com/use-case-diagram)
+- [Activity Diagram (legacy)](https://plantuml.com/activity-diagram-legacy)
+

src/net/sourceforge/plantuml/ditaa/package-info.java

@@ -3,6 +3,7 @@
  * <a href="https://plantuml.com/ditaa" target="_top">
  * Ditaa Diagram</a>.
  *
- * @see org.stathissideris.ascii2image
+ * @see org.stathissideris.ascii2image.graphics
+ * 
  */
 package net.sourceforge.plantuml.ditaa;

src/net/sourceforge/plantuml/ditaa/readme.md

@@ -10,7 +10,7 @@ This package provides classes used to manage [PlantUML Ditaa Diagram](https://pl
 
 ## Credit
 - [`org.stathissideris.ascii2image`](../../../../org/stathissideris/ascii2image) _(included in PlantUML)_
-- [:octocat:stathissideris/ditaa](https://github.com/stathissideris/ditaa)
+- :octocat: [stathissideris/ditaa](https://github.com/stathissideris/ditaa)
 
 ## Misc.
 

src/net/sourceforge/plantuml/dot/package-info.java

@@ -3,5 +3,9 @@
  * <a href="https://plantuml.com/graphviz-dot" target="_top">
  * Graphviz dot</a> for layout engine.
  * 
+ * @see net.sourceforge.plantuml.elk
+ * @see net.sourceforge.plantuml.sdot
+ * @see net.sourceforge.plantuml.vizjs
+ * 
  */
 package net.sourceforge.plantuml.dot;

src/net/sourceforge/plantuml/dot/readme.md

@@ -12,8 +12,12 @@ This package provides classes used to export diagram with the [Graphviz dot](htt
 
 ## See also other engines
 - [PlantUML 'Eclipse Layout Kernel (ELK)' Engine](https://plantuml.com/elk)
-  - [Eclipse Layout Kernel (ELK)](https://eclipse.dev/elk/)
+  - [`elk/proxy`](./proxy/) _(included in PlantUML)_
-- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and [:octocat:plantuml/smetana](https://github.com/plantuml/smetana)
+- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
+  - [`plantuml/sdot`](../sdot/)
   - [`src/gen`](../../../../gen)
   - [`src/smetana/core`](../../../../smetana/core)
   - [`src/h`](../../../../h)
+- [PlantUML Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs)
+  - [`plantuml/vizjs`](../vizjs/) _(included in PlantUML)_
+  - :octocat: [Plantuml/Vizjs](https://github.com/plantuml/vizjs) _(not included in `plantuml/plantuml`)_

src/net/sourceforge/plantuml/ebnf/package-info.java

@@ -3,5 +3,7 @@
  * <a href="https://plantuml.com/ebnf" target="_top">
  * EBNF (Extended Backus–Naur Form) Diagram</a>.
  *
+ * @see net.sourceforge.plantuml.regexdiagram
+ * 
  */
 package net.sourceforge.plantuml.ebnf;

src/net/sourceforge/plantuml/ebnf/readme.md

@@ -7,10 +7,17 @@ This package provides classes used to manage [Extended Backus–Naur Form (EBNF)
 - [Extended Backus–Naur Form (EBNF) Diagram](https://plantuml.com/ebnf)
 
 ## Reference
+### Internal Reference
+- [QA-16529](https://forum.plantuml.net/16529/could-we-add-syntax-diagrams)
+
+### External Reference
+- [Syntax diagram _(on Wikipedia)_](https://en.wikipedia.org/wiki/Syntax_diagram)
 - [Extended Backus–Naur Form (EBNF) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
 - [ISO/IEC 14977 : 1996(E)](http://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf)
 
-## Credit
+## See also
+- [PlantUML Regular expression (Regex) Diagram](https://plantuml.com/regex)
+- [`regexdiagram`](../regexdiagram/) _(directory on plantuml)_
 
 ## Misc.
 - [Shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting_yard_algorithm)

src/net/sourceforge/plantuml/elk/package-info.java

@@ -4,6 +4,9 @@
  * Eclipse Layout Kernel (ELK)</a> for layout engine.
  *
  * @see net.sourceforge.plantuml.elk.proxy
+ * @see net.sourceforge.plantuml.dot
+ * @see net.sourceforge.plantuml.sdot
+ * @see net.sourceforge.plantuml.vizjs
  * 
  */
 package net.sourceforge.plantuml.elk;

src/net/sourceforge/plantuml/elk/readme.md

@@ -4,7 +4,7 @@
 This package provides classes used to export diagram with the [Eclipse Layout Kernel (ELK)](https://plantuml.com/elk) layout engine.
 
 ## Link
-- [PlantUML "Eclipse Layout Kernel (ELK)" Engine](https://plantuml.com/elk)
+- [PlantUML 'Eclipse Layout Kernel (ELK)' Engine](https://plantuml.com/elk)
 
 ## Reference
 - [Eclipse Layout Kernel (ELK)](https://eclipse.dev/elk/)
@@ -12,12 +12,16 @@ This package provides classes used to export diagram with the [Eclipse Layout Ke
 
 ## Credit
 - [`elk/proxy`](./proxy/) _(included in PlantUML)_
-- [:octocat:eclipse/elk](https://github.com/eclipse/elk)
+- :octocat: [eclipse/elk](https://github.com/eclipse/elk)
 
 ## See also other engines
 - [GraphViz dot](https://plantuml.com/graphviz-dot)
   - [`plantuml/dot`](../dot/)
-- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and [:octocat:plantuml/smetana](https://github.com/plantuml/smetana)
+- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
+  - [`plantuml/sdot`](../sdot/)
   - [`src/gen`](../../../../gen)
   - [`src/smetana/core`](../../../../smetana/core)
   - [`src/h`](../../../../h)
+- [PlantUML Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs)
+  - [`plantuml/vizjs`](../vizjs/) _(included in PlantUML)_
+  - :octocat: [Plantuml/Vizjs](https://github.com/plantuml/vizjs) _(not included in `plantuml/plantuml`)_

src/net/sourceforge/plantuml/emoji/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/en/creole#68305e25f5788db0" target="_top">
+ * PlantUML Emoji</a> icon set.
+ *
+ * @see net.sourceforge.plantuml.openiconic
+ * 
+ */
+package net.sourceforge.plantuml.emoji;

src/net/sourceforge/plantuml/emoji/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `emoji`
+
+## Description
+This package provides classes used to manage [PlantUML Emoji](https://plantuml.com/en/creole#68305e25f5788db0) icon set.
+
+## Link
+- [PlantUML Emoji](https://plantuml.com/en/creole#68305e25f5788db0) icon set
+
+## Credit
+- :octocat: [EmojiTwo/emojitwo](https://github.com/EmojiTwo/emojitwo)

src/net/sourceforge/plantuml/file/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage Folder and File.
+ *
+ * @see net.sourceforge.plantuml.security.SFile
+ *
+ */
+package net.sourceforge.plantuml.file;

src/net/sourceforge/plantuml/file/readme.md

@@ -0,0 +1,4 @@
+# Directory Documentation for `file`
+
+## Description
+This package provides classes used to manage Folder and File.

src/net/sourceforge/plantuml/flashcode/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Provides classes used to manage 
+ * Flashcode especially QR Code (on PlantUML).
+ *
+ * @see ext.plantuml.com.google.zxing
+ * @see net.sourceforge.plantuml.klimt.creole.atom.AtomImg#createQrcode
+ */
+package net.sourceforge.plantuml.flashcode;

src/net/sourceforge/plantuml/flashcode/readme.md

@@ -0,0 +1,15 @@
+# Directory Documentation for `flashcode`
+
+## Description
+This package provides classes used to manage Flashcode especially QR Code (on PlantUML).
+
+## Reference
+- [Barcode _(on Wikipedia)_](https://en.wikipedia.org/wiki/Barcode)
+- [QR code _(on Wikipedia)_](https://en.wikipedia.org/wiki/QR_code)
+
+## Credit
+- [`com.google.zxing`](../../../../ext/plantuml/com/google/zxing/) _(included in PlantUML)_
+- :octocat: [zxing/zxing](https://github.com/zxing/zxing)
+
+## Misc.
+- [Flashcode _(on Wikipedia)_](https://fr.wikipedia.org/wiki/Flashcode) [fr]

src/net/sourceforge/plantuml/ftp/readme.md

@@ -9,3 +9,5 @@ This package provides classes used to manage a [FTP](https://plantuml.com/ftp) s
 ## Reference
 - [QA-9235](https://forum.plantuml.net/9235/unexpected-ftp-session)
 
+## Reference
+- [File Transfer Protocol _(on Wikipedia)_](https://en.wikipedia.org/wiki/File_Transfer_Protocol)

src/net/sourceforge/plantuml/fun/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * Provides classes used to manage 
+ * PlantUML Fun icon set.
+ *
+ */
+package net.sourceforge.plantuml.fun;

src/net/sourceforge/plantuml/fun/readme.md

@@ -0,0 +1,4 @@
+# Directory Documentation for `fun`
+
+## Description
+This package provides classes used to manage Fun icon or sprite set.

src/net/sourceforge/plantuml/gitlog/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="http://alphadoc.plantuml.com/doc/markdown/en/git-diagram" target="_top">
+ * Commits Git Log Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.gitlog;

src/net/sourceforge/plantuml/gitlog/readme.md

@@ -0,0 +1,12 @@
+# Directory Documentation for `gitlog`
+
+## Description
+This package provides classes used to manage [PlantUML Commits Git Log Diagram Diagram](http://alphadoc.plantuml.com/doc/markdown/en/git-diagram).
+
+## Link
+- [PlantUML Commits Git Log Diagram Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/git-diagram)
+
+## Reference
+- [QA-13557](https://forum.plantuml.net/13557/support-for-the-different-%40start-commands)
+- [GH-493](https://github.com/plantuml/plantuml/pull/493)
+

src/net/sourceforge/plantuml/help/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Provides classes used to manage help list.
+ * Provides classes used to manage Help list.
  *
  */
 package net.sourceforge.plantuml.help;

src/net/sourceforge/plantuml/json/readme.md

@@ -9,7 +9,7 @@ This package provides classes used to manage [JSON](https://www.json.org) Data _
 - [JSON _(on Wikipedia)_](https://en.wikipedia.org/wiki/JSON)
 
 ## Credit
-- [:octocat:ralfstx/minimal-json](https://github.com/ralfstx/minimal-json)
+- :octocat: [ralfstx/minimal-json](https://github.com/ralfstx/minimal-json)
 - [`json`](../json/) _(included in PlantUML)_
 
 ## Misc.

src/net/sourceforge/plantuml/log/package-info.java

@@ -1,7 +1,5 @@
 /**
  * Provides classes used to manage Log and Logging.
  * 
- * @see java.util.logging
- *
  */
 package net.sourceforge.plantuml.log;

src/net/sourceforge/plantuml/math/readme.md

@@ -11,9 +11,9 @@ This package provides classes used to manage [PlantUML ASCII Math](https://plant
 - [JLaTeXMath](https://scilab.gitlab.io/legacy_wiki/JLaTeXMath)
 
 ## Credit
-- [:octocat:Asciimath/Asciimathml](https://github.com/asciimath/asciimathml/tree/master/asciimath-based)
+- :octocat: [Asciimath/Asciimathml](https://github.com/asciimath/asciimathml/tree/master/asciimath-based)
 - [`ASCIIMathTeXImg.java`](./ASCIIMathTeXImg.java) is an internal port of [`ASCIIMathTeXImg.js`](https://github.com/asciimath/asciimathml/blob/master/asciimath-based/ASCIIMathTeXImg.js)
-- [:octocat:Opencollab/Jlatexmath](https://github.com/opencollab/jlatexmath)
+- :octocat: [Opencollab/Jlatexmath](https://github.com/opencollab/jlatexmath)
 
 ## Dependency _(if available)_
 - `org.scilab.forge.jlatexmath`

src/net/sourceforge/plantuml/nwdiag/readme.md

@@ -11,6 +11,7 @@ This package provides classes used to manage [PlantUML Network Diagram (nwdiag)]
 
 ## Credit or Inspiration
 - [`nwdiag` of Takeshi Komiya](http://blockdiag.com/en/nwdiag/nwdiag-examples.html)
+- :octocat: [ Blockdiag/Nwdiag](https://github.com/blockdiag/nwdiag)
 
 ## Misc.
 

src/net/sourceforge/plantuml/openiconic/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/openiconic" target="_top">
+ * PlantUML Openiconic</a> icon set.
+ *
+ * @see net.sourceforge.plantuml.emoji
+ * 
+ */
+package net.sourceforge.plantuml.openiconic;

src/net/sourceforge/plantuml/openiconic/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `openiconic`
+
+## Description
+This package provides classes used to manage [PlantUML Openiconic](https://plantuml.com/openiconic) icon set.
+
+## Link
+- [PlantUML Openiconic](https://plantuml.com/openiconic) icon set
+
+## Credit
+- :octocat: [Iconic/Open-iconic](https://github.com/iconic/open-iconic)

src/net/sourceforge/plantuml/png/package-info.java

@@ -1,7 +1,7 @@
 /**
  * Provides classes used to manage 
- * <a href="https://plantuml.com/pdf" target="_top">
+ * <a href="https://plantuml.com/en/command-line#458de91d76a8569c" target="_top">
- * PDF output format</a>.
+ * PNG output format</a>.
  *
  */
-package net.sourceforge.plantuml.pdf;
+package net.sourceforge.plantuml.png;

src/net/sourceforge/plantuml/png/readme.md

@@ -1,10 +1,10 @@
-# Directory Documentation for `pdf`
+# Directory Documentation for `png`
 
 ## Description
-This package provides classes used to export diagram to a [PDF](https://plantuml.com/pdf) output format.
+This package provides classes used to export diagram to a [PNG](https://plantuml.com/en/command-line#458de91d76a8569c) output format.
 
 ## Link
-- [PDF](https://plantuml.com/pdf)
+- [PNG output format](https://plantuml.com/en/command-line#458de91d76a8569c)
 
 ## Reference
-- [PDF _(on Wikipedia)_](https://en.wikipedia.org/wiki/PDF)
+- [PNG _(on Wikipedia)_](https://en.wikipedia.org/wiki/PNG)

src/net/sourceforge/plantuml/posimo/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * Provides classes used to manage 
+ * Positioning Calculation.
+ *
+ */
+package net.sourceforge.plantuml.posimo;

src/net/sourceforge/plantuml/posimo/readme.md

@@ -0,0 +1,42 @@
+# Directory Documentation for `posimo`
+
+## Description
+This package provides classes used to manage Positioning Calculation.
+
+## Diagram
+
+```mermaid
+classDiagram
+class Positionable {
+	+ Dimension2D getSize();
+	+ Point2D getPosition();
+}
+
+class Clusterable {
+	+Cluster getParent();
+}
+
+Positionable <|-- Clusterable
+
+class Cluster
+
+Cluster *-- Cluster : subclusters
+Clusterable <|.. Cluster
+Cluster *-- Block
+Clusterable <|.. Block
+
+Path *-- "2" Cluster
+Path --> Label : has one
+Positionable <|-- Label
+
+SimpleDrawer --> Cluster
+SimpleDrawer *--> Path
+
+class GraphvizSolver {
+ + Dimension2D solve(Cluster root, Collection~Path~ paths)
+}
+GraphvizSolver --> Cluster
+GraphvizSolver *--> Path
+```
+
+_(src: [`data.txt`](./data.txt))_

src/net/sourceforge/plantuml/preproc/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/preprocessing" target="_top">
+ * Preprocessing</a> of PlantUML input.
+ *
+ * @see net.sourceforge.plantuml.preproc2
+ * @see net.sourceforge.plantuml.tim
+ * 
+ */
+package net.sourceforge.plantuml.preproc;

src/net/sourceforge/plantuml/preproc/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `preproc`
+
+## Description
+This package provides classes used to manage [PlantUML Preprocessing](https://plantuml.com/preprocessing).
+
+## See also 
+### [Legacy] Preprocessing (directory)
+- [`preproc2`](../preproc2/)
+### Current Preprocessing (directory)
+- [`tim`](../tim/)

src/net/sourceforge/plantuml/preproc2/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/preprocessing" target="_top">
+ * Preprocessing</a> of PlantUML input.
+ *
+ * @see net.sourceforge.plantuml.preproc
+ * @see net.sourceforge.plantuml.tim
+ * 
+ */
+package net.sourceforge.plantuml.preproc2;

src/net/sourceforge/plantuml/preproc2/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `preproc`
+
+## Description
+This package provides classes used to manage [PlantUML Preprocessing](https://plantuml.com/preprocessing).
+
+## See also 
+### [Legacy] Preprocessing (directory)
+- [`preproc`](../preproc/)
+### Current Preprocessing (directory)
+- [`tim`](../tim/)

src/net/sourceforge/plantuml/project/readme.md

@@ -8,8 +8,3 @@ This package provides classes used to manage [PlantUML Gantt Diagram](https://pl
 
 ## Reference
 - [Gantt chart _(on Wikipedia)_](https://en.wikipedia.org/wiki/Gantt_chart)
-
-## Credit
-
-## Misc.
-

src/net/sourceforge/plantuml/real/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * Provides classes used to manage 
+ * Real Number.
+ *
+ */
+package net.sourceforge.plantuml.real;

src/net/sourceforge/plantuml/real/readme.md

@@ -0,0 +1,7 @@
+# Directory Documentation for `real`
+
+## Description
+This package provides classes used to manage Real Number.
+
+## Reference
+- [Real number _(on Wikipedia)_](https://en.wikipedia.org/wiki/Real_number)

src/net/sourceforge/plantuml/regexdiagram/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/regex" target="_top">
+ * Regular expression (Regex) Diagram</a>.
+ *
+ * @see net.sourceforge.plantuml.ebnf
+ * 
+ */
+package net.sourceforge.plantuml.regexdiagram;

src/net/sourceforge/plantuml/regexdiagram/readme.md

@@ -0,0 +1,17 @@
+# Directory Documentation for `regexdiagram`
+
+## Description
+This package provides classes used to manage [PlantUML Regular expression (Regex) Diagram](https://plantuml.com/regex).
+
+## Link
+- [PlantUML Regular expression (Regex) Diagram](https://plantuml.com/regex)
+
+## Reference
+- [Regular expression _(on Wikipedia)_](https://en.wikipedia.org/wiki/Regular_expression)
+
+## See also
+- [PlantUML Extended Backus–Naur Form (EBNF) Diagram](https://plantuml.com/ebnf)
+- [`ebnf`](../ebnf/) _(directory on plantuml)_
+
+## Misc.
+

src/net/sourceforge/plantuml/salt/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/salt" target="_top">
+ * Salt (or Wireframe) Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.salt;

src/net/sourceforge/plantuml/salt/readme.md

@@ -0,0 +1,11 @@
+# Directory Documentation for `salt`
+
+## Description
+This package provides classes used to manage [PlantUML Salt (or Wireframe) Diagram](https://plantuml.com/salt).
+
+## Link
+- [Salt (or Wireframe) Diagram](https://plantuml.com/salt)
+
+## Reference
+- [Wireframe _(on Wikipedia)_](https://en.wikipedia.org/wiki/Website_wireframe)
+

src/net/sourceforge/plantuml/sdot/package-info.java

@@ -0,0 +1,12 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/smetana02" target="_top">
+ * Smetana <i>(internal port of GraphViz in plantuml)</i></a>
+ * for layout engine.
+ *
+ * @see net.sourceforge.plantuml.dot
+ * @see net.sourceforge.plantuml.elk
+ * @see net.sourceforge.plantuml.vizjs
+ * 
+ */
+package net.sourceforge.plantuml.sdot;

src/net/sourceforge/plantuml/sdot/readme.md

@@ -0,0 +1,26 @@
+# Directory Documentation for `sdot`
+
+## Description
+This package provides classes used to export diagram with the [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) layout engine.
+
+## Link
+- [PlantUML Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02)
+
+## Credit
+- :octocat: [plantuml/smetana](https://github.com/plantuml/smetana) _(included in PlantUML)_
+  - [`src/gen`](../../../../gen)
+  - [`src/smetana/core`](../../../../smetana/core)
+  - [`src/h`](../../../../h)
+
+## See also other engines
+- [GraphViz dot](https://plantuml.com/graphviz-dot)
+  - [`plantuml/dot`](../dot/) _(included in PlantUML)_
+- [PlantUML 'Eclipse Layout Kernel (ELK)' Engine](https://plantuml.com/elk)
+  - [`elk/proxy`](./proxy/) _(included in PlantUML)_
+- [PlantUML Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs)
+  - [`plantuml/vizjs`](../vizjs/) _(included in PlantUML)_
+  - :octocat: [Plantuml/Vizjs](https://github.com/plantuml/vizjs) _(not included in `plantuml/plantuml`)_
+
+## Misc.
+- [Bedřich Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Bed%C5%99ich_Smetana)
+- [Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Smetana_(disambiguation))

src/net/sourceforge/plantuml/security/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/security" target="_top">
+ * PlantUML Security</a>.
+ *
+ */
+package net.sourceforge.plantuml.security;

src/net/sourceforge/plantuml/security/readme.md

@@ -0,0 +1,18 @@
+# Directory Documentation for `security`
+
+## Description
+This package provides classes used to manage [PlantUML Security](https://plantuml.com/security).
+
+## Link
+
+### Security
+- [Security Profile](https://plantuml.com/security)
+
+### URL authentication
+
+| Auth. Name Doc. | Directory |
+| --- | --- |
+| [URL authentication](https://plantuml.com/url-authentication)     | [`/authentication/`](./authentication/) |
+| [BasicAuth configuration](https://plantuml.com/url-basicauth)     | [`/authentication/basicauth/`](./authentication/basicauth/) |
+| [OAuth2 configuration](https://plantuml.com/en/url-oauth)         | [`/authentication/oauth/`](./authentication/oauth/) |
+| [Token Auth configuration](https://plantuml.com/en/url-tokenauth) | [`/authentication/token/`](./authentication/token/) |

src/net/sourceforge/plantuml/sequencediagram/package-info.java

@@ -0,0 +1,15 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/sequence-diagram" target="_top">
+ * Sequence Diagram</a>.
+ *
+ * <p>
+ * There are <a href="https://plantuml.com/teoz" target="_top">2 architectures</a>:
+ * <ol>
+ * <li>{@link net.sourceforge.plantuml.sequencediagram.puma} <i>(the current)</i></li>
+ * <li>{@link net.sourceforge.plantuml.sequencediagram.teoz} <i>(the new)<br/>
+ * Can be activated using <code>!pragma teoz true</code></i></li>
+ * </ol>
+ * </p>
+ */
+package net.sourceforge.plantuml.sequencediagram;

src/net/sourceforge/plantuml/sequencediagram/readme.md

@@ -0,0 +1,20 @@
+# Directory Documentation for `sequencediagram`
+
+## Description
+This package provides classes used to manage [PlantUML Sequence Diagram](https://plantuml.com/sequence-diagram).
+
+There are [2 architectures](https://plantuml.com/teoz):
+- [`puma`](./puma/) _(the current)_
+- [`teoz`](./teoz/) _(the new)_
+
+## Link
+- [PlantUML Sequence Diagram](https://plantuml.com/sequence-diagram)
+
+## Reference
+- [Sequence Diagram _(on Wikipedia)_](https://en.wikipedia.org/wiki/Sequence_diagram)
+
+## Credit
+
+## Misc.
+- [Puma _(on Wikipedia)_](https://en.wikipedia.org/wiki/Puma)
+- [Téoz _(on Wikipedia)_](https://en.wikipedia.org/wiki/T%C3%A9oz)

src/net/sourceforge/plantuml/skin/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides classes used to manage Skin and 
+ * <a href="https://plantuml.com/skinparam" target="_top">
+ * Skinparameter</a>.
+ *
+ * @see net.sourceforge.plantuml.style
+ * @see net.sourceforge.plantuml.theme
+ * 
+ */
+package net.sourceforge.plantuml.skin;

src/net/sourceforge/plantuml/skin/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `skin`
+
+## Description
+This package provides classes used to manage `Skin` and `Skinparameter`.
+
+## Reference
+- [PlantUML Skinparam command](https://plantuml.com/skinparam)
+
+## See also
+- [`style/FromSkinparamToStyle.java`](../style/FromSkinparamToStyle.java)

src/net/sourceforge/plantuml/statediagram/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/state-diagram" target="_top">
+ * State Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.statediagram;

src/net/sourceforge/plantuml/statediagram/readme.md

@@ -0,0 +1,16 @@
+# Directory Documentation for `statediagram`
+
+## Description
+This package provides classes used to manage [PlantUML State Diagram](https://plantuml.com/state-diagram).
+
+## Link
+- [PlantUML State Diagram](https://plantuml.com/state-diagram)
+
+## Reference
+- [UML State machine _(on Wikipedia)_](https://en.wikipedia.org/wiki/UML_state_machine)
+- [Finite-state machine _(on Wikipedia)_](https://en.wikipedia.org/wiki/Finite-state_machine)
+
+## Credit
+
+## Misc.
+

src/net/sourceforge/plantuml/stats/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/statistics-report" target="_top">
+ * Statistics</a>.
+ *
+ */
+package net.sourceforge.plantuml.stats;

src/net/sourceforge/plantuml/stats/readme.md

@@ -0,0 +1,7 @@
+# Directory Documentation for `stats`
+
+## Description
+This package provides classes used to manage [PlantUML Statistics](https://plantuml.com/statistics-report).
+
+## Link
+- [PlantUML Statistics](https://plantuml.com/statistics-report)

src/net/sourceforge/plantuml/stereo/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * Provides classes used to manage Stereotype.
+ *
+ */
+package net.sourceforge.plantuml.stereo;

src/net/sourceforge/plantuml/stereo/readme.md

@@ -0,0 +1,11 @@
+# Directory Documentation for `stereo`
+
+## Description
+This package provides classes used to manage `<<Stereotype>>`.
+
+## Link
+- ['Notes and stereotypes' on PlantUML 'Class'](https://plantuml.com/en/class-diagram#59c91a18bcc97bb0)
+- ['Stereotype' tag search on PlantUML Forum](https://forum.plantuml.net/tag/stereotype)
+
+## Reference
+- [Stereotype (UML) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Stereotype_(UML))

src/net/sourceforge/plantuml/style/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/style-evolution" target="_top">
+ * Style</a>.
+ *
+ * @see net.sourceforge.plantuml.skin
+ * @see net.sourceforge.plantuml.theme
+ * 
+ */
+package net.sourceforge.plantuml.style;

src/net/sourceforge/plantuml/style/readme.md

@@ -0,0 +1,13 @@
+# Directory Documentation for `style`
+
+## Description
+This package provides classes used to manage `Style`.
+
+## Reference
+- [PlantUML Style evolution](https://plantuml.com/style-evolution)
+
+
+| Element that can be styled | Property to style |
+| --- | --- |
+| [`SName.java`](./SName.java) | [`PName.java`](./PName.java) | 
+

src/net/sourceforge/plantuml/sudoku/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/sudoku" target="_top">
+ * Sudoku Grid on PlantUML</a>.
+ *
+ */
+package net.sourceforge.plantuml.sudoku;

src/net/sourceforge/plantuml/sudoku/readme.md

@@ -0,0 +1,18 @@
+# Directory Documentation for `sudoku`
+
+## Description
+This package provides classes used to manage [Sudoku Grid](https://plantuml.com/sudoku).
+
+## Link
+- [Sudoku Diagram](https://plantuml.com/sudoku)
+
+## Reference
+- [Sudoku _(on Wikipedia)_](https://en.wikipedia.org/wiki/sudoku)
+
+## Credit
+- [`DLXEngine.java` of Rolf Sandberg](http://www.rolfsandberg.se/content/klepphelmer/Sudoku/DLXEngine.java)
+- [Rolfs Sudoku page](http://www.rolfsandberg.se/content/klepphelmer/Sudoku/)
+- [`DLXEngine.java`](./DLXEngine.java) _(included in PlantUML)_
+
+## Misc.
+

src/net/sourceforge/plantuml/svek/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/svek" target="_top">
+ * PlantUML Svek Architecture</a>.
+ *
+ * @see net.sourceforge.plantuml.dot
+ * 
+ */
+package net.sourceforge.plantuml.svek;

src/net/sourceforge/plantuml/svek/readme.md

@@ -0,0 +1,13 @@
+# Directory Documentation for `svek`
+
+## Description
+This package provides classes used to manage [PlantUML Svek Architecture](https://plantuml.com/svek).
+
+## Link
+- [PlantUML Svek Architecture](https://plantuml.com/svek)
+- [GraphViz dot](https://plantuml.com/graphviz-dot)
+  - [`plantuml/dot`](../dot/)
+
+## Misc.
+- [The Good Soldier Švejk _(on Wikipedia)_](https://en.wikipedia.org/wiki/The_Good_Soldier_%C5%A0vejk)
+- [Svek _(on Wiktionary)_](https://en.wiktionary.org/wiki/svek)

src/net/sourceforge/plantuml/swing/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/gui" target="_top">
+ * PlantUML GUI</a>.
+ *
+ */
+package net.sourceforge.plantuml.swing;

src/net/sourceforge/plantuml/swing/readme.md

@@ -0,0 +1,15 @@
+# Directory Documentation for `swing`
+
+## Description
+This package provides classes used to manage [PlantUML GUI](https://plantuml.com/gui).
+
+## Link
+- [PlantUML GUI](https://plantuml.com/gui)
+
+## Reference
+### AWT
+- [Abstract Window Toolkit (AWT) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Abstract_Window_Toolkit)
+- [The AWT documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/awt/)
+### Swing
+- [Swing _(on Wikipedia)_](https://en.wikipedia.org/wiki/Swing_(Java))
+- [The Swing API documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/swing/)

src/net/sourceforge/plantuml/syntax/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Provides classes used to manage Syntax and Language (use to print language, and 'cypher').
+ *
+ * @see net.sourceforge.plantuml.OptionPrint#printLanguage
+ * @see net.sourceforge.plantuml.utils.Cypher
+ *
+ */
+package net.sourceforge.plantuml.syntax;

src/net/sourceforge/plantuml/syntax/readme.md

@@ -0,0 +1,33 @@
+# Directory Documentation for `syntax`
+
+## Description
+This package provides classes used to manage PlantUML Syntax and Language _(use to print language, and 'cypher')_.
+
+## Reference
+- [QA-3741](https://forum.plantuml.net/3741/plantuml-jar-language-does-not-report-all-keywords)
+- [QA-5329](https://forum.plantuml.net/5329/language-definition)
+- [QA-10648](https://forum.plantuml.net/10648/keywords-predefined-symbols-codeless-language-module-bbedit)
+
+## Usage
+### With the `-language` option
+```sh
+java -jar plantuml.jar -language
+```
+In order to have the PlantUML list of:
+- `type`,
+- `keyword`,
+- `preprocessor`,
+- `skinparameter`,
+- `color`.
+
+### With the `-cypher` option
+```sh
+java -jar plantuml.jar -cypher file.puml
+```
+That generates a `file.preproc`.
+
+Ref.:
+- [Cypher option](https://plantuml.com/en/faq#76ee48737d9f7a1a)
+
+See also code here:
+- [`utils/Cypher.java`](../utils/Cypher.java)

src/net/sourceforge/plantuml/telnet/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Provides classes used to manage 
+ * Telnet server.
+ *
+ * @see net.sourceforge.plantuml.ftp
+ * 
+ */
+package net.sourceforge.plantuml.telnet;

src/net/sourceforge/plantuml/telnet/readme.md

@@ -0,0 +1,7 @@
+# Directory Documentation for `telnet`
+
+## Description
+This package provides classes used to manage a Telnet server.
+
+## Reference
+- [Telnet _(on Wikipedia)_](https://en.wikipedia.org/wiki/Telnet)

src/net/sourceforge/plantuml/theme/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides classes used to manage
+ * <a href="https://plantuml.com/theme" target="_top">
+ * Theme</a>.
+ * 
+ * @see net.sourceforge.plantuml.skin
+ * @see net.sourceforge.plantuml.style
+ * 
+ */
+package net.sourceforge.plantuml.theme;

src/net/sourceforge/plantuml/theme/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `theme`
+
+## Description
+This package provides classes used to manage `Theme`.
+
+## Reference
+- [PlantUML Theme](https://plantuml.com/theme)
+
+## See also
+- [`themes` directory](../../../../../themes/)

src/net/sourceforge/plantuml/tikz/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/latex" target="_top">
+ * LaTeX (with TikZ) output format</a>.
+ *
+ */
+package net.sourceforge.plantuml.tikz;

src/net/sourceforge/plantuml/tikz/readme.md

@@ -0,0 +1,12 @@
+# Directory Documentation for `tikz`
+
+## Description
+This package provides classes used to export diagram to a [LaTeX (with TikZ)](https://plantuml.com/latex) output format.
+
+## Link
+- [LaTeX (with TikZ) output format](https://plantuml.com/latex)
+
+## Reference
+- [QA-1798](https://forum.plantuml.net/1798/latex-tikz-support)
+- [LaTeX _(on Wikipedia)_](https://en.wikipedia.org/wiki/LaTeX)
+- [PGF/TikZ _(on Wikipedia)_](https://en.wikipedia.org/wiki/PGF/TikZ)

src/net/sourceforge/plantuml/tim/package-info.java

@@ -0,0 +1,11 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/preprocessing" target="_top">
+ * Preprocessing</a> of PlantUML input.
+ *
+ * @see net.sourceforge.plantuml.text.TLineType
+ * @see net.sourceforge.plantuml.preproc
+ * @see net.sourceforge.plantuml.preproc2
+ * 
+ */
+package net.sourceforge.plantuml.tim;

src/net/sourceforge/plantuml/tim/readme.md

@@ -0,0 +1,22 @@
+# Directory Documentation for `tim`
+
+## Description
+This package provides classes used to manage [PlantUML Preprocessing](https://plantuml.com/preprocessing).
+
+## Link of Current Preprocessing (documentation)
+- [PlantUML Preprocessing](https://plantuml.com/preprocessing)
+- [PlantUML Preprocessing JSON](https://plantuml.com/preprocessing-json)
+
+## See also [legacy] Preprocessing (directory)
+- [`preproc`](../preproc/)
+- [`preproc2`](../preproc2/)
+
+## Reference
+- [Shunting yard algorithm _(on Wikipedia)_](https://en.wikipedia.org/wiki/Shunting_yard_algorithm)
+- [Reverse Polish notation _(on Wikipedia)_](https://en.wikipedia.org/wiki/Reverse_Polish_notation)
+- [Boyer–Moore–Horspool algorithm _(on Wikipedia)_](https://en.wikipedia.org/wiki/Boyer%E2%80%93Moore%E2%80%93Horspool_algorithm)
+- [String-searching algorithm _(on Wikipedia)_](https://en.wikipedia.org/wiki/String-searching_algorithm)
+- [Trie _(on Wikipedia)_](https://en.wikipedia.org/wiki/Trie)
+
+## Misc.
+- [Tim (given name) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Tim_(given_name))

src/net/sourceforge/plantuml/timingdiagram/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/timing-diagram" target="_top">
+ * Timing Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.timingdiagram;

src/net/sourceforge/plantuml/timingdiagram/readme.md

@@ -0,0 +1,15 @@
+# Directory Documentation for `timingdiagram`
+
+## Description
+This package provides classes used to manage [PlantUML Timing Diagram](https://plantuml.com/timing-diagram).
+
+## Link
+- [PlantUML Timing Diagram](https://plantuml.com/timing-diagram)
+
+## Reference
+- [Timing diagram _(on Wikipedia)_](https://en.wikipedia.org/wiki/Timing_diagram_%28Unified_Modeling_Language%29)
+
+## Credit
+
+## Misc.
+

src/net/sourceforge/plantuml/url/package-info.java

@@ -0,0 +1,13 @@
+/**
+ * Provides classes used to manage 
+ * URL, CMap.
+ * 
+ * <p>
+ * Main use for:
+ * <ul>
+ *  <li><a href="https://plantuml.com/link" target="_top">
+ *  PlantUML Link (URL)</a></li>
+ * </ul>
+ * </p>
+ */
+package net.sourceforge.plantuml.url;

src/net/sourceforge/plantuml/url/readme.md

@@ -0,0 +1,13 @@
+# Directory Documentation for `url`
+
+## Description
+This package provides classes used to manage `URL`, `CMap`.
+
+## Link
+- [PlantUML Link (URL)](https://plantuml.com/link)
+
+## Reference
+
+## Credit
+
+## Misc.

src/net/sourceforge/plantuml/version/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/versioning-scheme" target="_top">
+ * PlantUML Version</a> and
+ * <a href="https://plantuml.com/professional" target="_top">
+ * PlantUML License</a>.
+ *
+ */
+package net.sourceforge.plantuml.version;

src/net/sourceforge/plantuml/version/readme.md

@@ -0,0 +1,9 @@
+# Directory Documentation for `version`
+
+## Description
+This package provides classes used to manage [PlantUML Version](https://plantuml.com/versioning-scheme)
+and [PlantUML License](https://plantuml.com/professional)
+
+## Link
+- [PlantUML Version](https://plantuml.com/versioning-scheme)
+- [PlantUML License](https://plantuml.com/professional)

src/net/sourceforge/plantuml/vizjs/package-info.java

@@ -0,0 +1,29 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/vizjs" target="_top">
+ * Vizjs <i>(a port to Javascript of GraphViz)</i></a>
+ * for layout engine.
+ * 
+ * <p>
+ * That uses this components:
+ * <ul>
+ *  <li><a href="https://github.com/plantuml/vizjs" target="_top">
+ *  A Java library written by Andreas Studer that embed 'viz.js'
+ *  and call 'J2V8'</a></li>
+ * </ul></p>
+ * <p>
+ * Ref.:
+ * <ul>
+ *  <li><a href="https://github.com/mdaines/viz.js" target="_top">
+ *  Vizjs <i>(a port to Javascript of GraphViz)</i></a></li>
+ *  <li><a href="http://eclipsesource.com/blogs/getting-started-with-j2v8"
+ *  target="_top">
+ *  J2V8 <i>(a highly efficient JavaScript runtime for Java)</i></a></li>
+ * </ul></p>
+ * 
+ * @see net.sourceforge.plantuml.dot
+ * @see net.sourceforge.plantuml.elk
+ * @see net.sourceforge.plantuml.sdot
+ * 
+ */
+package net.sourceforge.plantuml.vizjs;

src/net/sourceforge/plantuml/vizjs/readme.md

@@ -0,0 +1,23 @@
+# Directory Documentation for `vizjs`
+
+## Description
+This package provides classes used to export diagram with the [Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs) layout engine.
+
+## Link
+- [PlantUML Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs)
+
+## Credit
+- :octocat: [Mdaines/Viz.js](https://github.com/mdaines/viz.js) _(not included in `plantuml/plantuml`)_
+- :octocat: [Plantuml/Vizjs](https://github.com/plantuml/vizjs) _(not included in `plantuml/plantuml`)_
+
+## See also other engines
+- [GraphViz dot](https://plantuml.com/graphviz-dot)
+  - [`plantuml/dot`](../dot/) _(included in PlantUML)_
+- [PlantUML 'Eclipse Layout Kernel (ELK)' Engine](https://plantuml.com/elk)
+  - [`elk/proxy`](./proxy/) _(included in PlantUML)_
+- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
+  - [`plantuml/sdot`](../sdot/)
+  - [`src/gen`](../../../../gen)
+  - [`src/smetana/core`](../../../../smetana/core)
+  - [`src/h`](../../../../h)
+

src/net/sourceforge/plantuml/wbs/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/wbs-diagram" target="_top">
+ * WBS Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.wbs;

src/net/sourceforge/plantuml/wbs/readme.md

@@ -0,0 +1,16 @@
+# Directory Documentation for `wbs`
+
+## Description
+This package provides classes used to manage [PlantUML WBS Diagram](https://plantuml.com/wbs-diagram).
+
+## Link
+- [WBS Diagram](https://plantuml.com/wbs-diagram)
+
+## Reference
+- [Work breakdown structure (WBS) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Work_breakdown_structure)
+- [Organizational chart _(on Wikipedia)_](https://en.wikipedia.org/wiki/Organizational_chart)
+
+## Credit
+
+## Misc.
+

src/net/sourceforge/plantuml/windowsdot/package-info.java

@@ -0,0 +1,15 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://github.com/plantuml/graphviz-distributions" target="_top">
+ * an Embedded Windows Graphviz dot</a> on plantuml.
+ * 
+ * <p>
+ * The source is:
+ * <ul><li>
+ * <a href="https://github.com/plantuml/graphviz-distributions" target="_top">
+ * Plantuml/Graphviz-distributions</a>
+ * </li></ul>
+ * </p>
+ * 
+ */
+package net.sourceforge.plantuml.windowsdot;

src/net/sourceforge/plantuml/windowsdot/readme.md

@@ -0,0 +1,15 @@
+# Directory Documentation for `windowsdot`
+
+## Description
+This package provides classes used to manage [an Embedded Windows Graphviz dot](https://github.com/plantuml/graphviz-distributions) on plantuml.
+
+## Link
+- ["About the `graphviz.dat` file" on BUILDING.md](/BUILDING.md#-about-the-graphvizdat-file)
+
+## Reference
+- [Graphviz](https://graphviz.org)
+- [Graphviz _(on GitLab)_](https://gitlab.com/graphviz/graphviz/)
+
+## Credit
+  - :octocat: [Plantuml/Graphviz-distributions](https://github.com/plantuml/graphviz-distributions) 
+

src/net/sourceforge/plantuml/wire/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="http://alphadoc.plantuml.com/doc/markdown/en/wire-diagram" target="_top">
+ * Wire or Block Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.wire;

src/net/sourceforge/plantuml/wire/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `wire`
+
+## Description
+This package provides classes used to manage [PlantUML Wire or Block Diagram](http://alphadoc.plantuml.com/doc/markdown/en/wire-diagram).
+
+## Link
+- [PlantUML Wire or Block Diagram](http://alphadoc.plantuml.com/doc/markdown/en/wire-diagram)
+
+## Reference
+- [Wiring diagram _(on Wikipedia)_](https://en.wikipedia.org/wiki/Wiring_diagram)

src/net/sourceforge/plantuml/xmi/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/xmi" target="_top">
+ * XML Metadata Interchange (XMI) output format</a>.
+ *
+ */
+package net.sourceforge.plantuml.xmi;

src/net/sourceforge/plantuml/xmi/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `xmi`
+
+## Description
+This package provides classes used to export diagram to a [XML Metadata Interchange (XMI)](https://plantuml.com/xmi) output format.
+
+## Link
+- [XML Metadata Interchange (XMI) output format](https://plantuml.com/xmi)
+
+## Reference
+- [XML Metadata Interchange _(on Wikipedia)_](https://en.wikipedia.org/wiki/XML_Metadata_Interchange)

src/net/sourceforge/plantuml/xml/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Provides classes used to manage
+ * XML thread-safe lazy initialization
+ * of expensive factories
+ * with the "initialization-on-demand holder" idiom.
+ *
+ */
+package net.sourceforge.plantuml.xml;

src/net/sourceforge/plantuml/xml/readme.md

@@ -0,0 +1,10 @@
+# Directory Documentation for `xml`
+
+## Description
+This package provides classes used to manage XML thread-safe lazy initialization of expensive factories with the "initialization-on-demand holder" idiom.
+
+## Reference
+- [Initialization-on-demand holder idiom _(on Wikipedia)_](https://en.wikipedia.org/wiki/Initialization-on-demand_holder_idiom)
+
+## Credit or Inspiration
+- [How to implement thread-safe lazy initialization? _(on Stackoverflow)_](https://stackoverflow.com/a/8297830/1848731)