Plugin Directory

Changeset 3259859


Ignore:
Timestamp:
03/21/2025 06:05:57 PM (13 months ago)
Author:
wibergsweb
Message:

readme installation guide update

Location:
csv-to-html
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • csv-to-html/tags/3.54/readme.txt

    r3258805 r3259859  
    2222== Installation ==
    2323
    24 This section describes how to install the plugin and get it working.
     24This section describes how to install the plugin and get it working. There are actually three steps. 1. Load csv-file or files into your wp-content/uploads directory. 2. Apply settings in form or manually in shortcode generator. 3. Copy and paste into page/post/widget.
    2525
    2626Look at inspirational examples of what you can do with the plugin here: <http://wibergsweb.se/plugins/csvtohtml/>
    2727
    28 But **FIRST**, go through below steps!
     28A more *detailed descrption* of how to get this plugin working:
    2929
    3030**STEP1 - INSTALLATION**
     
    3737= Local fetch =
    38381. Create a folder called csvtohtmlfiles in your wp-content/uploads/ manually (e.g. wp-content/uploads/csvtohtmlfiles should be created)
    39 2. Upload/copy your file to this created folder (e.g. wp-content/uploads/csvtohtmlfiles/testfile.csv). This **cannot**be done from media-upload (Use ftp, ssh or directly on your os to copy files to the webserver).
     392. Upload/copy your file to this created folder (e.g. wp-content/uploads/csvtohtmlfiles/testfile.csv). This **cannot** be done from media-upload (Use ftp, ssh or directly on your os to copy files to the webserver).
    4040
    4141= External fetch =
     
    4343
    4444**STEP3 - SHORTCODE GENERATOR**
    45 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.
     451. 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 - CSV to HTML/Shortcode generator or through the plugins page. Do this on a desktop computer for easiest management.
    46462. 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.
    47473. If you want to see the current output based on applied settings, then you should click the update/preview - button.
    48484. Settings are splitted into different sections in the shortcode generator page.
    49495. The section &quot;Debugging&quot; 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.
    50 6. You should see the &quot;General&quot; 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).
     506. You should see the &quot;File management&quot; 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).
    51517. Change *.csv to the name of the file you prepared in STEP2.
    5252
    5353= Local fetch =
    54 8. **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
     548. **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 **Fetch file(s)** type the file(s) that you put into wp-content/uploads/csvtohtmlfiles
    55559. 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.
    5656
     
    6161**STEP4 - MAKE IT WORK**
    626210. 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.
    63 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.
     6311. Copy generated shortcode and put the shortcode in a wordpress page or post to display table with the functionality you have set in the shortcode generator page.
    646412. 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.
     65
     66**SHORTCODE**
     67You can apply settings through text inputs, radiobuttons, select lists etc or simply adjust shorcode directly and click for a new preview/update. When you are done, simply paste the shortcode into a post or page (or widget if theme supports that).
    6568
    6669If having issues that you cannot solve please send a mail to info@wibergsweb.se.
    6770If you like the plugin, please consider donating. Please donate to paypal info@wibergsweb.se. Amount does not matter. I like coffee! :-)
    68 
    69 **SHORTCODE**
    70 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.
    71 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.
    72 
    73 Another option is to go into the shortcode generator again and repeat previous steps (from STEP2).
    74 
    7571
    7672== Frequently Asked Questions ==
  • csv-to-html/trunk/readme.txt

    r3258805 r3259859  
    2222== Installation ==
    2323
    24 This section describes how to install the plugin and get it working.
     24This section describes how to install the plugin and get it working. There are actually three steps. 1. Load csv-file or files into your wp-content/uploads directory. 2. Apply settings in form or manually in shortcode generator. 3. Copy and paste into page/post/widget.
    2525
    2626Look at inspirational examples of what you can do with the plugin here: <http://wibergsweb.se/plugins/csvtohtml/>
    2727
    28 But **FIRST**, go through below steps!
     28A more *detailed descrption* of how to get this plugin working:
    2929
    3030**STEP1 - INSTALLATION**
     
    3737= Local fetch =
    38381. Create a folder called csvtohtmlfiles in your wp-content/uploads/ manually (e.g. wp-content/uploads/csvtohtmlfiles should be created)
    39 2. Upload/copy your file to this created folder (e.g. wp-content/uploads/csvtohtmlfiles/testfile.csv). This **cannot**be done from media-upload (Use ftp, ssh or directly on your os to copy files to the webserver).
     392. Upload/copy your file to this created folder (e.g. wp-content/uploads/csvtohtmlfiles/testfile.csv). This **cannot** be done from media-upload (Use ftp, ssh or directly on your os to copy files to the webserver).
    4040
    4141= External fetch =
     
    4343
    4444**STEP3 - SHORTCODE GENERATOR**
    45 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.
     451. 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 - CSV to HTML/Shortcode generator or through the plugins page. Do this on a desktop computer for easiest management.
    46462. 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.
    47473. If you want to see the current output based on applied settings, then you should click the update/preview - button.
    48484. Settings are splitted into different sections in the shortcode generator page.
    49495. The section &quot;Debugging&quot; 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.
    50 6. You should see the &quot;General&quot; 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).
     506. You should see the &quot;File management&quot; 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).
    51517. Change *.csv to the name of the file you prepared in STEP2.
    5252
    5353= Local fetch =
    54 8. **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
     548. **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 **Fetch file(s)** type the file(s) that you put into wp-content/uploads/csvtohtmlfiles
    55559. 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.
    5656
     
    6161**STEP4 - MAKE IT WORK**
    626210. 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.
    63 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.
     6311. Copy generated shortcode and put the shortcode in a wordpress page or post to display table with the functionality you have set in the shortcode generator page.
    646412. 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.
     65
     66**SHORTCODE**
     67You can apply settings through text inputs, radiobuttons, select lists etc or simply adjust shorcode directly and click for a new preview/update. When you are done, simply paste the shortcode into a post or page (or widget if theme supports that).
    6568
    6669If having issues that you cannot solve please send a mail to info@wibergsweb.se.
    6770If you like the plugin, please consider donating. Please donate to paypal info@wibergsweb.se. Amount does not matter. I like coffee! :-)
    68 
    69 **SHORTCODE**
    70 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.
    71 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.
    72 
    73 Another option is to go into the shortcode generator again and repeat previous steps (from STEP2).
    74 
    7571
    7672== Frequently Asked Questions ==
Note: See TracChangeset for help on using the changeset viewer.