CSV to html

Installation

This section describes how to install the plugin and get it working.

Look at inspirational examples of what you can do with the plugin here: http://wibergsweb.se/plugins/csvtohtml/

But FIRST, go through below steps!

STEP1 – INSTALLATION
1. Upload the plugin folder csvtohtml to the `/wp-content/plugins/’ directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the ‘Plugins’ screen in WordPress

STEP2 – PREPARATION
The plugin can either fetch files locally from your server (or from an external resource). The plugin supports csv-files, Excel(xlsx-files only), ods-files (spreadsheet) and json-files. If using a json-file then you should set source type to JSON. In most cases the source type should be set to guess if not using JSON.

Local fetch

1. Create a folder called csvtohtmlfiles in your wp-content/uploads/ manually (e.g. wp-content/uploads/csvtohtmlfiles should be created)
2. Upload/copy your file to this created folder (e.g. wp-content/uploads/csvtohtmlfiles/testfile.csv). This cannotbe done from media-upload (Use ftp, ssh or directly on your os to copy files to the webserver).

External fetch

1. Have an uri to your csv-file available/accessible from your computer (eg. https://[domain]/testfile.csv).

STEP3 – SHORTCODE GENERATOR
1. Begin to understand what you are able to to do with the plugin. Do this by playing around with the CSV to HTML shortcode generator. This is accessible in the admin dashboard – Tools/CSV to HTML. Do this on a desktop computer for easiest management.
2. Try and click/modify settings and see the preview of the table to the right. This preview only shows how it would look like, but functionality such as search and pagination etc isn’t going to work.
3. If you want to see the current output based on applied settings, then you should click the update/preview – button.
4. Settings are splitted into different sections in the shortcode generator page.
5. The section "Debugging" shows known errors and gives warnings depending on your settings. It turns into red when there are any errors or warnings. This doesn’t necessarily mean it won’t work but can be an indicator of somethings you must adjust.
6. You should see the "General" section as a starting point for your settings. By default all csv files that exists in wp-content/uploads are used to generate a table (*.csv).
7. Change *.csv to the name of the file you prepared in STEP2.

Local fetch

1. Set Path(local) to csvtohtmlfiles or click on the button with three dots and select csvtohtmlfiles (if you have done previous steps you should see your folder csvtohtmlfiles here). In File(s) combined to this table type the file that you put into wp-content/uploads/csvtohtmlfiles
2. If an Excel-file is selected for fetch, then it is converted to a csv-file and the Excel-file remains intact (so there are two files that has identical data in the same folder). This may seem redudantant, but this is because the plugin fetches data from the csv-file and not from the Excel-file directly.

External fetch

1. In File(s) combined to this table put in your url that you prepared in STEP2. If your external file is a google spreadsheet, make sure it’s publicy available for download and that you have the full uri to your googlesheets workbook. Also set "add extension automatically" to no.
2. If you have more files you want to combine, then just add a semicolon (;) and add filename (local or external)

STEP4 – MAKE IT WORK
10. Play around with settings until you’re satisfied. In very few cases you should change character encodings but if you’re having issues with encoding, you could try and change these settings.
11. Copy generated shortcode (above General section) and put the shortcode in a wordpress page or post to display table with the functionality you have set in the shortcode generator page.
12. If you don’t like the default design of the table(s), use your theme’s css to change the layout of your site/table etc.

If having issues that you cannot solve please send a mail to info@wibergsweb.se.
If you like the plugin, please consider donating. Please donate to paypal info@wibergsweb.se. Amount does not matter. I like coffee! 🙂

SHORTCODE
If you feel comfortable by modifying settings directly in your shortcode: Down below are settings available and what they are intended for. Value within parenthesis show the default value for the setting, so if that setting/attribute is not included in the shortcode, the default value for the setting will be applied.
The shortcode should always start with [csvtohtml_create followed by settings/attributes below. Every setting must have a space between and ] must be set at the end of the shortcode.

Another option is to go into the shortcode generator again and repeat previous steps (from STEP2).

SHORTCODE SETTINGS/ATTRIBUTES

add_ext_auto (yes) – Add fileextension .csv to file (if it’s not specified in the source_files). Set to no if you don’t want a file extension to be added automatically. A common use for this is to set this setting to no , so google documents could be accessed (they don’t have .csv at the end).

api_cdn (yes) – (Applicable when fetching json) Set this to no if you want to use wordpress api (wordpress core api could fail with cloudflare for unknown reason)

editable (no)– yes/no – The default is no. If set to yes file(s), the logged in user may edit values directly in the table (through changing values in input-fields) if logged in. Some attributes are temporarily disabled when editing but when set to no or logged out, these attributes are restored.

convert_encoding_from – When converting character encoding, define what current characterencoding that csv file has. (Not required and use only when having issues with encoding)

convert_encoding_to – When converting character encoding, define what characterencoding that csv should be encoded to. (Not required and use only when having issues with encoding)

css_max_width (760) – media query css rules/breakpoint. This is only applied when responsive is set to yes.

css_min_devicewidth (768) – media query css rules/breakpoint. This is only applied when responsive is set to yes.

css_max_devicewidth (1024) – media query css rules/breakpoint. This is only applied when responsive is set to yes.

csv_delimiter (,) – what delimiter to use in each line of csv (comma, semicolon etc)

debug_mode (no) – If set to yes then header-values and row-values would be output to screen and files like "file not found" will be displayed (otherwise it would be "silent errors")

design_template – What template from builtin templates to use in table. Possible values are: nolines, clean, funky, thick, pyjamas, pyjamascols, thinlines

downloadable (no) – If set to yes, a button is shown that creates a download of a csv

downloadable_filename (export_csvtohtml.csv) – What filename to use when downloading

downloadable_text (Download as csv) – What text to show on downloadable button

eol_detection (cr/lf) – CR = Carriage return, LF = Line feed, CR/LF = Carriage line and line feed, auto = autodetect. Only applied to external files. When using local files, new lines are automatically autodeteced.

exclude_cols – What columns to exclude in final html table (1,2,3,10-15 would exclude columns 1,2,3,10,11,12,13,14 and 15). If you want to remove the last column, then simply type last instead of entering a number.

fetch_interval – Set to daily, hourly or weekly. This is how often the actual fetch from source is done. It’s only done when requesting the page with this shortcode on. This would make sense to use for external files even if it’s possible to use with local files as well. For this to work you must specify a html_id!

fetch_lastheaders (0) – Number of specific headers (e.g. columns) to retrieve (from the end)

filter_data – What data to filter in table (specific string), e.g. FSC

filter_data_ucfirst (no) – If set to yes, first letter will be uppercase (applies only to a-z)

filter_operator (equals) – Tell how to apply the filter
between >= value1 and <= value2
equals (=)
equals_caseinsensitive (equals with case insensitive filter
urlequals equals case insensitive and search both with hypens/spaces and underscores
less <
lequal <=
more >
mequal >=
wildcard any
newdates from specific date or from todays date

filter_removechars – If having more characters than just numbers in the (cell)values, remove that/those characters so comparision will be done for numbers only (e.g. 567 will be used for comparision if $567 is displayed)

filter_col– What column to use filter on (Only ONE column)

float_divider (.) – If fetching float values from csv use this character to display another "float-divider chacter" than dot (e.g. 6,3 instead of 6.3, 1,2 instead of 1.2 etc)

groupby_col – Group by a column (e.g. If different companies are listed in that column, grouping will be done for companies)

groupby_col_header (yes) – If using groupby_col and this is set to yes, show headers on a row before all rows for this grouped value is shown

headerrows_start – Which row in file that headers will be generated from

html_id – set id of this table

html_class – set class of this table (besides default csvtohtml – class)

hidetable_load (no) – Hide table at pageload if set to yes

hidetable_reset (no) – Hide table when clicking reset button if set to yes (otherwise full table would show even if hidetable_load is set)

htmltags_autoconvert (no) – Set to yes if you want to (auto)convert links to html-links (<a>), images to <img> and mail to "maillinks" (link with mailto:).

htmltags_autoconvert_imagealt (empty string) – Set alt text for all images OR based on a specific columns value (e.g. if set to 2 then grab value from second column for the same row that image is on)

htmltags_autoconvert_newwindow (no) – If ordinary links, open them up in a new window. This attribute only has effect when htmltags_autoconvert is set to yes

include_cols – What columns to include in final html table (1,2,3,10-15 would display column 1,2,3,10,11,12,13,14 and 15). If include_cols is given, then exclude_cols is ignored.

include_rows – What rows to include in final html table (1,2,3,10-15 would display row 1,2,3,10,11,12,13,14 and 15).

json_startlevel – When using json as source_type the plugin would fetch data from first level in json hiearchy

notfound_message (no) – What message to show when searchresult not found. (search_functionality must be set to yes for this option to be valid)

pagination (no) – Tells if pagination should be used or not (yes/no). Default is no.

pagination_above_table (no) – Show pagination above table. Pagination must be set to yes for this to work.

pagination_below_table (yes) – Show pagination below table. Pagination must be set to yes for this to work.

pagination_links_max (10) – Show links (1,2,3… up to 10 links as default). Set to 0 if you do not want to show these links at all.

pagination_rows (10) – Nr of rows to show for each pagination.

pagination_start (1) – Row to start pagination with (generally always 1)

pagination_text_last (Last) – Text last for pagination. Set to "" if you do not want to show (if pagination is set to yes).

pagination_text_next (Next) – Text Next for pagination. Set to "" if you do not want to show (if pagination is set to yes).

pagination_text_prev (Prev) – Text Prev (previous) for pagination. Set to "" if you do not want to show (if pagination is set to yes).

pagination_text_start (Start) – Text start for pagination. Set to "" if you do not want to show (if pagination is set to yes).

path – relative path to uploads-folder of the wordpress – installation ( eg. /wp-content/uploads/{path} ). Applies to local files.

resetbutton_text (Reset) – Reset button text (search_functionality must be set to yes for this option to be valid)

responsive (yes) – yes/no – The default is yes, but this could be set to no if you have issues with other css on your site.

return_rows_array (no) – yes/no. Useful if you create own code and want to retrieve data only.

search_exactmatch (no) Use exact match for search (e.g. Great retrieves values such as Great, not Great Britain)

search_caseinsensitive (yes) Use case insensitive (e.g. Great and great returns Great or great on search)

search_cols – What columns to search in when using search functionality. Include and exclude cols are ignored when using this setting/attribute. If no value is given to this attribute/setting – all columns are searched.

search_functionality (no) – Make table data searchable (a searchinput field, a searchbutton and a reset-button is displayed).

searchbutton_text (Search) – Search button text (search_functionality must be set to yes for this option to be valid)

searchinput_placeholder (empty string) – Placeholder for searchinput field. Default is empty.

search_requiredchars (0) – How many characters that are required when doing a search. Default 0 tells there are no requirement.

search_requiredchars_message (empty string) – Message to user if not required characters are valid when doing a search. If this is not set, then a standard message will appear.

search_realtime (no) – Set to yes if you want the system to search without hitting any button (after user typed some characters). There’s a delay in about 1 second after user has begun typing

sort_cols – Which column(s) to sort on in format nr,nr och nr-nr (example 1,2,4 or 1-2,4)

sort_cols_order (asc) – Which order to sort columns on (asc/desc). If you have 3 columns, you can define these with different sorting like asc,desc,asc

sort_cols_userclick – Sort_cols must be set. if this is set to you, user can click to sort a specific column. This overrides sort_cols_order after first click

sort_cols_userclick_arrows – sort_cols_userclick must be set. Arrows are shown in headercolumns indicated ascending or descending order.

source_files – file(s) to include. If using more than one file – separate them with a semicolon (;). It ‘s possible to include a full url instead of a filename to fetch external csv files. It’s also possible to fetch files from a given path (with for example *.csv).

source_type (visualizer_plugin) – what type to use for identifying content in csv-files (valid types are guess and visualizer_plugin). If you’re unsure what to set, set "guess" here.

table_in_cell_cols – You can choose to have extra data in a table in a cell from specific column(s) given (same format as include_cols). exclude_cols is ignored if this is used. This could be useful if you want to do a hover-effect to show some extra data.

table_in_cell_header (More data) – Column name for added data, if table_in_cell_cols is specified and table_in_cell_header is not the default value is: "More Data"

table_in_cell_wrapperclass – Class for div surrounding table inside cell when using table_in_cell_cols

title – set title that is shown as text in top left corner of html table (If not set – nothing is shown)

total_percentage_above_table (yes) – Show total percentage of a specific value above table. Ignored if total_percentage_chechkvalue and total_percentage_col is not set.

total_percentage_below_table (no) – Show total percentage of a specific value below table. Ignored if total_percentage_chechkvalue and total_percentage_col is not set.

total_percentage_checkvalue – Check percentage of a specific value in a specific column. totals_pecentage_col must be specified.

total_percentage_col – Which column to check in. total_percentage_chechkvalue must be specified for this to work

total_percentage_text – Define what text to say when using total_percentage_checkvalue. If not defined it will only show percentage value followed by %

total_percentage_decimals (0) – Number of decimals to show when showing total percentage

totals_cols_bottom – Add totals with given columns at bottom of table (example 1,2,4 or 1-2,4)

totals_cols_bottom_empty – What string/character to show when there’s no calculation

totals_cols_bottom_title – Set a specific string when added totals (overrides totals value and totals_cols_bottom_empty)

totals_cols_bottom_title_col – Which column to set this specific title at

totals_cols_prefix (empty string) – Add prefix to the total column(s) (e.g. $10)

totals_cols_suffix (empty string) – Add suffix to the total column(s) (e.g. 10$)

SPECIAL VARIABLES / CHARACTERS
usage for filterdata: %urlparts-X where the X indicates pathlevel (e.g if %urlparts-2 path would be site/path1/path2).

usage for path: If %userlogin% is specified somewhere in path, then replace that with the actual username of logged in user (e.g. csvtohtmlfiles/%userlogin% would load different files based on which user that is logged in)

usage for entering file (local files): Wildcards for filesearch with * (e.g. beliver*.csv would include all csv files that began with beliver in it’s filename)

Look at inspirational examples of what you can do with the plugin here: http://wibergsweb.se/plugins/csvtohtml/

If having issues that you cannot solve please send a mail to info@wibergsweb.se.

If you like the plugin, please consider donating. Please donate to paypal info@wibergsweb.se. Amount does not matter. I like coffee! 🙂