HackerOne users: Testing against this community violates our program's Terms of Service and will result in your bounty being denied.

Installation?

Hello, sorry I'm new to Vanilla. I'm trying to read everywhere how to install all plugins/addons, the readme files, etc. and nothing is making sense. Do you have an easy way of installing this?

Thank you!

Comments

  • You extract and upload it to your plugins folder of vanilla installation . If it is compatible and works, you can enable it in the dashboard.

    You need to have a basic grasp of this sort of thing . Otherwise you need to learn .

  • RiverRiver MVP
    edited September 2016

    @Pouncer012 said:
    Hello, sorry I'm new to Vanilla. I'm trying to read everywhere how to install all plugins/addons, the readme files, etc. and nothing is making sense. Do you have an easy way of installing this?

    Thank you!

    have you set up the correct permissions on the folder.

    I haven't installed the plugin myself, but downloading and looking at it, I see a number of things.

    the plugin also should be cleaned up before it is uploaded, or it should be cleaned up be everyone who downloaded it.

    if a newer version than 3.1.4 of plugin occurs you should delete the folder and re-install the new version.

    probably a good idea to delete the XXX file names.

         Directory of DiscussionTopic
    
        09/04/2016  11:38 AM    <DIR>          .
        09/04/2016  11:38 AM    <DIR>          ..
        06/30/2016  10:51 AM    <DIR>          Alsosee
        08/12/2016  12:51 PM            63,762 capturefilter.JPG
        08/12/2016  12:51 PM           106,884 captureguide.JPG
        08/12/2016  12:51 PM            85,686 capturesearch.JPG
        08/12/2016  12:51 PM            86,821 capturesetting1.JPG
        08/12/2016  12:51 PM           103,419 capturesetting2.JPG
        08/12/2016  12:51 PM            80,666 capturesetting3.JPG
        08/12/2016  12:51 PM            90,109 capturesetting4.JPG
        08/12/2016  12:51 PM            49,325 capturesetting5.JPG
        08/12/2016  12:51 PM            49,325 capturesetting6.JPG
        08/12/2016  12:51 PM            69,563 capturesidepanel.JPG
    XXX 08/18/2016  06:29 AM            81,488 class.discussiontopic.plugin.3.1.3.php  
        09/01/2016  06:12 PM           105,371 class.discussiontopic.plugin.php
     XXX 08/29/2016  07:58 AM           103,262 class.discussiontopic.plugin.php.txt 
        07/08/2016  07:02 AM    <DIR>          design
        08/12/2016  12:51 PM            27,992 discussionbodymetaareasnippet.jpg
        08/12/2016  12:51 PM            30,630 discussionlistmetaareasnippet.jpg
        08/12/2016  12:51 PM             3,818 icon.png
        08/12/2016  12:51 PM         1,273,821 lexicon.txt
        07/16/2016  06:15 AM    <DIR>          locale
        09/01/2016  06:14 PM    <DIR>          modules
        08/12/2016  12:51 PM            13,221 PorterStemmer.php
        08/12/2016  12:51 PM             5,202 PosTagger.php
        08/12/2016  12:51 PM             2,267 readme.md
        08/12/2016  12:51 PM            46,969 sidepanelsnippet.jpg
        09/01/2016  06:14 PM    <DIR>          views
    
    
         Directory of DiscussionTopic\Alsosee
    
        06/30/2016  10:51 AM    <DIR>          .
        06/30/2016  10:51 AM    <DIR>          ..
        06/24/2016  09:35 AM            43,694 Capture Sidepanel.JPG
        07/03/2016  10:37 AM            80,920 class.alsosee.plugin.php
        06/17/2016  10:09 AM               267 composer.json
        06/30/2016  10:51 AM    <DIR>          design
        06/24/2016  09:22 AM             3,818 icon.png
        06/22/2016  03:57 PM         1,273,821 lexicon.txt
        06/30/2016  10:51 AM    <DIR>          locale
        06/30/2016  10:51 AM    <DIR>          modules
        06/17/2016  09:55 AM            12,899 PorterStemmer.php
        06/22/2016  03:54 PM             5,204 PosTagger.php
        06/17/2016  09:55 AM             1,426 README.md
        <b> 06/17/2016  09:57 AM             7,113 textrazor-php-master.zip </b>
        06/17/2016  10:02 AM            18,162 TextRazor.php
        06/17/2016  10:03 AM             1,080 TextRazorPHP Free LICENSE
        06/30/2016  10:51 AM    <DIR>          views
    
    
         Directory of DiscussionTopic\Alsosee\design
    
        06/30/2016  10:51 AM    <DIR>          .
        06/30/2016  10:51 AM    <DIR>          ..
        06/30/2016  06:09 AM               588 alsosee.css
        06/29/2016  10:57 AM             2,450 pluginsetup.css
    
    
         Directory of DiscussionTopic\Alsosee\locale
    
        06/30/2016  10:51 AM    <DIR>          .
        06/30/2016  10:51 AM    <DIR>          ..
    XXX    06/30/2016  10:51 AM    <DIR>          en-CA
    
    
    
        //  Delete this folder.  Vanilla 2.2 doesn't use it and the locale will never be updated so 
         Directory of DiscussionTopic\Alsosee\locale\en-CA
    
        06/30/2016  10:51 AM    <DIR>          .
        06/30/2016  10:51 AM    <DIR>          ..
    XXX    06/30/2016  10:10 AM            19,815 definitions.php
    
    
    
         Directory of DiscussionTopic\Alsosee\modules
    
        06/30/2016  10:51 AM    <DIR>          .
        06/30/2016  10:51 AM    <DIR>          ..
        06/24/2016  01:55 PM             7,181 class.alsoseemodule.php
    
    
         Directory of DiscussionTopic\Alsosee\views
    
        06/30/2016  10:51 AM    <DIR>          .
        06/30/2016  10:51 AM    <DIR>          ..
        06/29/2016  03:41 PM             1,280 Topic.php
    
    
         Directory of DiscussionTopic\design
    
        07/08/2016  07:02 AM    <DIR>          .
        07/08/2016  07:02 AM    <DIR>          ..
        08/12/2016  12:51 PM             1,078 discussiontopic.css
        08/12/2016  12:51 PM             5,550 pluginsetup.css
    
    
    
    
         Directory of DiscussionTopic\locale
    
        07/16/2016  06:15 AM    <DIR>          .
        07/16/2016  06:15 AM    <DIR>          ..
     XXX   07/08/2016  07:02 AM    <DIR>          en-CA
       08/12/2016  12:51 PM            13,433 en.php
    
    
    
    
       //  Delete this folder.  Vanilla 2.2 doesn't use it and the locale will never be updated so 
         Directory of DiscussionTopic\locale\en-CA
    
        07/08/2016  07:02 AM    <DIR>          .
        07/08/2016  07:02 AM    <DIR>          ..
     XXX   07/05/2016  06:47 PM            13,413 definitions.php
    
    
         Directory of DiscussionTopic\modules
    
        09/01/2016  06:14 PM    <DIR>          .
        09/01/2016  06:14 PM    <DIR>          ..
        08/28/2016  03:19 PM             9,732 class.discussiontopicmodule.php
    XXX 08/28/2016  03:19 PM             9,711 class.discussiontopicmodule.php.txt 
    
    
         Directory of DiscussionTopic\views
    
        09/01/2016  06:14 PM    <DIR>          .
        09/01/2016  06:14 PM    <DIR>          ..
        08/12/2016  12:51 PM            11,386 CustomizationandSetupGuide.htm
        08/27/2016  08:51 AM             1,539 Topic.php
     XXX  08/26/2016  07:31 PM             1,574 Topic.php.txt 
        08/29/2016  08:01 AM             1,719 Topicsearch.php
     XXX 08/29/2016  08:00 AM             1,718 Topicsearch.php.txt 
    

    My personal suggestion, These practices that would best be avoided when developing or uploading a plugin.

    naming files with "multiple or pseudo extensions" xxxx.php.txt poor practice
    including old locales that are non-existent in current recomended stable version of vanilla.
    including multiple class files with the same class
    including duplicates that are formatted slightly differently or just take up space
    some unused files just get loaded into cache and pollute things.

    Professional Tip.

    If you don't check a plugin before you upload it, you may be adding unnecessary or old files.

    Something to consider if a developer uploads a newly created plugin

    the developer could delete the plugin and any old versions from their test installation and then download the plugin from add-ons and install it and test the downloaded version disabling, running, and enabling. to see if it gets enable and disabled properly and all css and js files are loaded and not other junk is in it.

    I've seen several plugins in recent months where there was a glitch because the downloaded add-on was neither tested or installed by developer, otherwise they would have noticed the bugs and extra files if they closely looked at things.

    Pragmatism is all I have to offer. Avoiding the sidelines and providing centerline pro-tips.

  • @River - thanks for these comments -- I uploaded the wrong folder, the one on Github marked with the same version does not have all these file duplicates as well as the totally unnecessary Alsosee directory. However, the plugin existing files are fine. After the US Labor Day I'll upload a cleaner version with a fix for another issue reported by another user.

    Apologies to everyone (and don't tell anyone else that I am human and make mistakes).

    @Pouncer012 - since you are just starting with Vanilla I suggest that you (1) wait until I upload a newer version, (2) delete this plugin directory as River suggested, and (3) perhaps start your Vanilla experimentation with a simpler plugin (the DiscussionTopic is one of the more complex plugins from a setup point of view - it probably has more options to chose from than other plugins)

  • @river - new version without the unused files is now in the directory.
    @R_J - code now conforms to the Vanilla standard.
    @okhawaja - your long list of priority phrases should work now.

  • RiverRiver MVP
    edited September 2016

    @rbrahmson said:
    @river - new version without the unused files is now in the directory.

    yes but it would be "better and more responsible" if you have a note in your description on plugin page, and your readme about deleting the folder before installing new plugin version, otherwise people will still have the junk files from previous versions of the plugin as explained above, otherwise cache will be polluted, etc, as stated in my comment above.

    if you want to help the people who installed previous versions. - make a clear and easy to see note before they download the plugin.

    e.g. https://vanillaforums.org/addon/galleries-plugin see description here as an example. except I would bold the part about deleting folder before installing

    kudos - you have very nice descriptive images on plugin page

    Pragmatism is all I have to offer. Avoiding the sidelines and providing centerline pro-tips.

  • Hi @River - I think the extraneous folders we introduced in the previous to the last version, not earlier. Nevertheless, I updated the directory description as you suggested.

    Thanks for your feedback!

Sign In or Register to comment.