Upstream
/
Plan
mirror of https://github.com/plan-player-analytics/Plan.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update HtmlCustomization.md

This commit is contained in:
Rsl1122 2017-05-24 11:40:42 +03:00 committed by GitHub
parent 1a22afdc9e
commit c0be41794e
1 changed files with 49 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
documentation/HtmlCustomization.md
View File

@ -5,6 +5,8 @@ The plugin uses two .html files: `analysis.html` and `player.html`
If the `/plugins/Plan/` folder contains either of the files, they will be used instead of the ones found inside the .jar.
This means you can copy the html files from the jar to the folder and edit them.
Page version: **3.2.0**
## Placeholders
The plugin uses placeholders to place the values into the html. Here I will go through each placeholder.
- [PlaceholderUtils.java](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/utilities/PlaceholderUtils.java)
@ -39,7 +41,7 @@ Placeholder | Description | Example
%isonline& | `| <span class="color_2">Online</span>` or `| <span class="color_4">Offline</span>`
%deaths% | Number of deaths. | 24
%playerkills% | Number of Player kills the user has (Size of KillData list) | 14
%sessionstable% | Table containing up to 10 of the most recent online sessions. Example contains one line. | `<table class="sortable table"><thead><tr><th>Session Started</th><th>Session Ended</th><th>Session Length</th></tr></thead><tbody><tr><td sorttable_customkey="32674576">FORMATTED_TIME</td><td sorttable_customkey="432525345">FORMATTED_TIME</td><td sorttable_customkey="32213">FORMATTED_TIME</td></tr></tbody></table>`
%sessionstable% | Old feature, no longer in use. |
%sessionaverage% | A formatted version of the average length of all of the sessions. | 10m 23s
%killstable% | Table containing up to 10 of the most recent player kills. Example contains one line. | `<table class="sortable table"><thead><tr><th>Date</th><th>Killed</th><th>With</th></tr></thead><tbody><tr><td sorttable_customkey="324123421">FORMATTED_TIME</td><td>Rsl1122</td><td>DIAMOND_SWORD</td></tr></tbody></table>`
%version% | Version of the plugin | 3.2.5
@ -52,14 +54,11 @@ Placeholder | Description | Example
%gm1col% | Color of the CREATIVE box in the config | 000000
%gm2col% | Color of the ADVENTURE box in the config | ffffff
%gm3col% | Color of the SPECTATOR box in the config | 000000
%datapunchcard% | Data for the punch card graph | [{x:0, y:2},{x:1, y:2}]
%datasessiondistribution% | Data for the session length distribution graph | [54, 34, 12]
%labelssessiondistribution& | Labels for the session length distribution bars | ["0-5 min", "5-10 min", "10-15 min"]
%inaccuratedatawarning% | Replaced with a warning if the player has registered 3 minutes ago | `<div class="warn">Data might be inaccurate, player has just registered.</div>`
## Additional Inspect placeholders
Additionally some placeholders will be replaced with plugin data, these can be found here:
[HookHandler # getAdditionalInspectReplaceRules](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/data/additional/HookHandler.java#L145)
These might change in **3.1.0** so I will not put them here yet.
%plugins% | Content for the Plugins tab | `<div class="columns"><div class="about box column">CONTENT</div><div class="about box column">CONTENT</div></div>`
## Analysis placeholders
@ -87,12 +86,45 @@ Placeholder | Description | Example
%totallogins% | Total number of logins of all players | 342
%top20mostactive% | Not in use, old feature. | Error: Replace rule was not set
%recentlogins% | Buttons with links to the inspect pages of most recent players | `<p><a class="button" href="http://localhost:8804/bAkEd/player/Rsl1122">Rsl1122</a> </p>`
**Unfinished**
## Additional Analysis placeholders
Additionally some placeholders will be replaced with plugin data, these can be found here:
[HookHandler # getAdditionalAnalysisReplaceRules](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/data/additional/HookHandler.java#L127)
These might change in **3.1.0** so I will not put them here yet.
%deaths% | Total amount of deaths for all players | 43
%playerkills% | Total amount of player kills | 32
%mobkills% | Total amount of mobs killed | 432
%sessionaverage% | Formatted time amount of the average session length | 4m 30s
%version% | Version of Plan | 3.2.0
%planlite% | Replaced with an empty string. Old feature. |
%sortabletable% | Multi column table containing all players | [Created with this code](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/ui/tables/SortablePlayersTableCreator.java)
%dataday% | Data for 24h online activity | [0, 0, 0, 0, 1]
%dataweek% | Data for 7d online activity | [0, 0, 0, 0, 1]
%datamonth% | Data for 30d online activity | [0, 0, 0, 0, 1]
%labelsday% | Labels for each point on 24h graph | [FORMATTED TIMESTAMPS]
%labelsweek% | Labels for each point on 7d graph | [FORMATTED TIMESTAMPS]
%labelsmonth% | Labels for each point on 30d graph | [FORMATTED TIMESTAMPS]
%activitydata% | Data for the sectors on the activity pie | [32, 43, 3, 2]
%labelsactivity% | Labels for the sectors of activity pie | ["Active", "Inactive", "Unknown", "Banned"]
%geomapcountries% | Country Array for Chloropleth map | [...]
%geomapcodes% | Country code Array for Chloropleth map | [...]
%geomapz% | Number array for Chloropleth map | [...]
%gmdata% | Data for the sectors on the gm usage pie | [43242, 432423421, 35345, 5432534]
%gmlabels% | Labels for the sectors of gm pie. | ["Survival", "Creative", "Adventure", "Spectator"]
%genderdata% | Data for the sectors on the Gender pie | [3, 4, 5]
%gendermale% | Amount of male players | 3
%genderfemale% | Amount of female players | 4
%gendercolors% | Colors for the gender pie in the config | [#ffffff, #000000, #ffffff]
%genderfcolor% | Color of the FEMALE sector in gender pie | #ffffff
%gendermcolor% | Color of the MALE sector in gender pie | #000000
%activecol% | Color of the ACTIVE sector in config | ffffff
%inactivecol% | Color of the INACTIVE sector in config | 000000
%joinleavecol% | Color of the UNKNOWN sector in config | ffffff
%bancol% | Color of the BANNED sector in config | 000000
%playersgraphcolor% | Color code for the online graph in the config. | ffffff
%playersgraphfill% | Color code for fill of the online graph in the config. | 000000
%gm0col% | Color of the SURVIVAL box in the config | ffffff
%gm1col% | Color of the CREATIVE box in the config | 000000
%gm2col% | Color of the ADVENTURE box in the config | ffffff
%gm3col% | Color of the SPECTATOR box in the config | 000000
348e0f | Light color of green to be replaced with config value Main | ffffff
267F00 | Darker color of green to be replaced with config value MainDark | 000000
5cb239 | Lighter color of green to be replaced with config value Secondary | ffffff
89c471 | Lightest color of green to be replaced with config value Tertiary | 000000
5da341 | Darker color of green to be replaced with config value TertiaryDark | ffffff
%plugins% | Content for the Plugins tab | `<div class="columns"><div class="about box column">CONTENT</div><div class="about box column">CONTENT</div></div>`