mscherer 6 年 前
コミット
da8f42bbfa
2 ファイル変更10 行追加2 行削除
  1. 2 1
      docs/Helper/Format.md
  2. 8 1
      docs/Helper/Progress.md

+ 2 - 1
docs/Helper/Format.md

@@ -2,7 +2,7 @@
 
 A CakePHP helper to handle some common format topics.
 
-### Setup
+## Setup
 Include helper in your AppView class as
 ```php
 $this->addHelper('Tools.Format', [
@@ -12,6 +12,7 @@ $this->addHelper('Tools.Format', [
 
 You can store default configs also in Configure key `'Format'`.
 
+## Usage
 
 ### icon()
 Display font icons using the default namespace or an already prefixed one.

+ 8 - 1
docs/Helper/Progress.md

@@ -9,7 +9,7 @@ So for `0.9999` as well as `0.0001` etc it will not yet display the completely f
 If you want that, you need to pre-round before passing it in.
 
 
-### Setup
+## Setup
 Include helper in your AppView class as
 ```php
 $this->addHelper('Tools.Progress', [
@@ -20,6 +20,8 @@ $this->addHelper('Tools.Progress', [
 You can store default configs also in Configure key `'Progress'`.
 Mainly empty/full chars can be configured this way.
 
+## Usage
+
 ### progressBar()
 Display a text-based progress bar with the progress in percentage as title.
 ```php
@@ -48,3 +50,8 @@ It can be also used standalone.
 // For $value 0.49 it outputs: 49% 
 echo $this->Number->toPercentage($this->calculatePercentage($value), 0, ['multiply' => true]);
 ```
+
+## Tips
+
+Consider using CSS `white-space: nowrap` for the span tag if wrapping could occur based on smaller display sizes.
+Wrapping would render such a text-based progress bar a bit hard to read.