Extension:FlowchartWiki

From MediaWiki.org
Jump to: navigation, search


MediaWiki extensions manual - list
Crystal Clear action run.png
FlowchartWiki

Release status: beta

FlowchartWiki-Screenshot.png
Implementation Link markup, Tag, Database, Page action
Description Flowchartwiki creates flowcharts from the links between wikipages in a category and can be used for process modelling and process documentation.
Author(s) (tkocktalk)
Last version 1.2.0 (Dec 28th, 2010)
MediaWiki tested with 1.16
License GPL 2 or later
Download flowchartwiki-1.2.0.zip
Example see http://www.flowchartwiki.org for a demo, sample processes and full documentation.
Hooks used
ArticleSaveComplete

InternalParseBeforeLinks
LinksUpdateConstructed
ArticleDelete
TitleMoveComplete
ArticleUndelete

Check usage and version matrix

Flowchartwiki is an extension to MediaWiki for creating flowcharts from the links between wikipages in a category to support process modelling and process documentation in MediaWiki. This simplifies the self-organizing of teams and processes.

Each process-step is a wikipage and based on the tagged links between the wikipages and a type assigned to a wikipage, a flowchart diagram is created automatically. This keeps the diagram always up to date and reduces manual maintenance. The Diagram itself is clickable to simplify the navigation in the wiki. A hierarchy of Processes is supported.

In comparison to popular office software, all users of the wiki can simultaneously access the process model and keep it up to date.

Contents

New in 1.2.0 [edit]

  • Bugfix by Hiroyuki S.: long pagenames in fchw_LoadPages() (new since 1.2.0-beta2)
  • Include a link to the category-page on top of the graph, if customizing has a Page-Type "Category".
  • Position all Pages that have no Level::xxxx assigned at the bottom of the graph, sorted in alphabetical order.
  • PHP 5.3 compatibility
  • some more, see CHANGES.

Usage [edit]

How MediaWiki can be used to model processes:

  • Process = Category Page
  • Process-Step = Wiki Page
  • tagged Wiki-Links
  • Result: clickable graph

By adding a few special tags to category and wiki pages, a graph is created from the links between these pages.

Add these tags to a category page:

<CategoryBrowser />
[[ModelType::Process]]
  • The CategoryBrowser tag creates and displays the clickable flowchart on the category page.
  • The Modeltype tag selects the type of diagrams used for the process (fully customizable).

Add these tags to the individual wikipage (besides the usual Category Tag).

<CategoryBrowser />
[[NextStep::Download]]

<Dependencies />

[[Type::ProcessStep]]
[[PageName::Different_Name_in_Graph]]
[[Level::100]]
  • The CategoryBrowser tag creates and displays the flowchart on the wikipage and highlights the current page in the graph.
  • NextStep::Download tags the link to the "Download" wikipage in the process.
  • The Dependencies tag is a special version of "What links here" and shows a list of links from and to this page - including the type of the links.
  • Type::ProcessStep defines the type of this process step and determines the shape type and color used in the graph. The shape types and colors are customizable.
  • PageName::Different_Name_in_Graph is optional and overrides the default usage of the Name of the WikiPage with the "Different_Name_in_Graph".
  • Level::100 is a hint to the graphing-algorithm (graphviz) on where to place the process step in the graph.

Download instructions [edit]

Downloads are available from flowchartwiki.org www.flowchartwiki.org. For prerequisites (Graphviz) please also check the project website at http://www.flowchartwiki.org.

Installation [edit]

Installation and upgrading instructions can be found on flowchartwiki.org. A .pdf document (created by using pdfbook) with the installation-instructions from the website is also included in the flowchartwiki download.


See also [edit]

  • FlowchartWiki uses an extended/modified version of the Extension:Pdf Book extension that exports the whole process documentation including the graph images. It can be downloaded from the flowchartwiki.org download page as a separate file.
  • The Graphviz Extension Extension:GraphViz is not required, but the GraphViz Software needs to be installed.
  • Extension:WikiMindMap
  • Extension:MindMap