====== structprogress Plugin ======

---- plugin ----
description: Progress type for struct
author     : saggi 
email      : saggi@gmx.de 
type       : Action
lastupdate : 2023-06-21
compatible : Igor, Jack Jackrum
depends    : struct
conflicts  : 
similar    : 
tags       : progress,progressbar

downloadurl: https://github.com/saggi-dw/dokuwiki-plugin-structprogress/zipball/main
bugtracker : https://github.com/saggi-dw/dokuwiki-plugin-structprogress/issues
sourcerepo : https://github.com/saggi-dw/dokuwiki-plugin-structprogress/
donationurl: 

screenshot_img : https://i.ibb.co/Qd2ynKT/2022-11-21-14h11-53.png
----


===== Installation =====

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[plugin:struct|struct Plugin]]

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

As with the Decimal type, a number can be entered that will be displayed in a progress bar:

{{https://i.ibb.co/Qd2ynKT/2022-11-21-14h11-53.png|Progres bar in struct}}

===== Usage =====

This plugin adds another struct type ''Progress''.

The bar is represented as x% of the maximum (100*value/max), so that also specifications like 789/1000, 80 of 85 points or 0.94/1 are possible.

^max^prefix^postfix^value^result|
|''1000''|''Progress: ''|''/1000''|''789''|{{https://i.ibb.co/gtHTRjx/2022-11-21-15h28-51.png?150}}|
|''85''|//empty//|''/85 Points''|''80''|{{https://i.ibb.co/zbJSSFp/2022-11-21-15h30-07.png?150}}|
|''1''|''cos⁡ φ: ''|//empty//|''0,94''|{{https://i.ibb.co/d5Smzz2/2022-11-21-15h33-07.png?150}}|

===== Configuration and Settings =====

^Option^Description^default^Comments|
|''max''|The Maximum Progress|''100''|Value must be greater than ''0'', otherwise the default value is used|
|''prefix''|A text displayed before the value|''empty''|In Sample: ''Progress: '' is used|
|''postfix''|A text displayed after the value|''empty''|In Sample: ''%% %%%'' is used|
|''type''|A Style Descriptor|''default''|A style for the value ''rounded'' also exist|

The ''style'' under ''type'' is accessible under the following descriptors in e.g. [[devel:css#user_styles|userstyle.css]]:

^Option^Value|
|''type''|''mystyle''|

<code>
.struct_progress-background_mystyle {
  
}

.struct_progress_mystyle {
  
}

.struct_progress_mystyle>p {
  
}
</code>

Styles that do not exist are displayed in the default style.

The following colours are used and depend on the style chosen:
^Element^Color in style^style.ini|
|Border of the Progress bar|Border color|''@ini_border''|
|Text|Main text color|''@ini_text''|
|Progress bar fill|The Neutral background color|''@ini_background_neu''|


Those colors are easily changed. The bundled styling plugin available via "admin" -> "template style setting" allows easy changes. Alternatively, one can directly edit [[devel:style.ini|style.ini]] file.

===== Development =====

=== Change Log ===
{{rss>https://github.com/saggi-dw/dokuwiki-plugin-structprogress/commits/main.atom date}}

===== Discussion =====