Skip to content

Commit

Permalink
Remove documentation such as FAQ into github README, Wildcard search …
Browse files Browse the repository at this point in the history 
…working with a non-zero min-prefix-len
  • Loading branch information
Justin Bauer committed Dec 20, 2018
1 parent e080f73 commit 5cf69ec
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 269 deletions.
8 changes: 4 additions & 4 deletions assests/sphinx.conf.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ index {ss_prefix}main
dict = keywords
min_stemming_len = 4
min_word_len = 2
min_prefix_len = 0
min_prefix_len = 3
min_infix_len = 0
ngram_len = 0
html_strip = 0
Expand All @@ -181,11 +181,11 @@ index {ss_prefix}delta : {ss_prefix}main
docinfo = extern

#index settings
morphology = none
morphology = stem_en
dict = keywords
min_stemming_len = 1
min_stemming_len = 4
min_word_len = 2
min_prefix_len = 0
min_prefix_len = 3
min_infix_len = 0
ngram_len = 0
html_strip = 0
Expand Down
14 changes: 3 additions & 11 deletions class.sphinxsearch.plugin.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -258,16 +258,6 @@ public function Controller_Index($Sender) {
$Sender->Render($this->getview('sphinxsearch.php'));
}

public function Controller_FAQ($Sender) {
// Prevent non-admins from accessing this page
$Sender->Permission('Vanilla.Settings.Manage');

$Sender->SetData('PluginDescription', $this->GetPluginKey('Description'));
$Sender->SetData('PluginVersion', $this->GetPluginKey('Version'));

$Sender->Render($this->GetView('faq.php'));
}

/**
* main entry point for the install wizard
* input parameters for wizard are in the $_GET buffer
Expand Down Expand Up @@ -421,7 +411,9 @@ public function SearchController_Render_Before($Sender) {
if (empty($_GET) || isset($_GET['tar'])) {
//Load main search page
$SearchHelpModule = new SearchHelpModule();
$Sender->AddAsset('LeftPanel', $SearchHelpModule, 'LeftPanel');

// This loads a panel that shows how to search
//$Sender->AddAsset('LeftPanel', $SearchHelpModule, 'LeftPanel');

$Sender->AddAsset('BottomPanel', '', 'BottomPanel');
$Sender->AddCssFile('/plugins/SphinxSearch/design/mainsearch.css');
Expand Down
113 changes: 0 additions & 113 deletions views/faq.php
View file

This file was deleted.

4 changes: 2 additions & 2 deletions views/settings.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@


</style>
<h1><?php echo T($this->Data['Title']) . ' - ' . $this->Data['PluginVersion']; ?></h1>
<h1><?php echo T($this->Data['Title']) ?></h1>
<div class="Info">
<?php echo T($this->Data['PluginDescription']); ?>
</div>
<h3><?php echo 'Quick Links'; ?></h3>
<div class="Info">
<ul>
<li><?php echo Anchor('Back To Control Panel', 'plugin/sphinxsearch'); ?></li>
<li><?php echo Anchor('Back To Sphinx Search', 'plugin/sphinxsearch'); ?></li>
</ul>
</div>
<h3>Settings</h3>
Expand Down
147 changes: 21 additions & 126 deletions views/sphinxsearch.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@
<?php
echo '<h2>', T('Need More Help?'), '</h2>';
echo '<ul>';
echo '<li>', Anchor(T('FAQ'), 'plugin/sphinxsearch/faq'), '</li>';
echo '<li>', Anchor(T('Github'), 'https://github.com/bauerjj/SphinxSearch'), '</li>';
echo '<li>', Anchor(T('Offical Sphinx Documentation'), 'http://sphinxsearch.com/docs/current.html'), '</li>';
echo '</ul>';
?>
</div>
<h1><?php echo T($this->Data['Title']) . ' - ' . $this->Data['PluginVersion']; ?></h1>
<h1><?php echo T($this->Data['Title']) ?></h1>
<div class="Info">
<?php echo T($this->Data['PluginDescription']); ?>
</div>
Expand All @@ -93,18 +93,33 @@
<ol>
<li><?php echo Anchor('Install Wizard', 'plugin/sphinxsearch/installwizard'); ?></li>
<li><?php echo Anchor('Settings', 'plugin/sphinxsearch/settings'); ?></li>
<li><?php echo Anchor('FAQ', 'plugin/sphinxsearch/faq'); ?></li>
</ol>
</div>
<h3>Control Panel</h3>
<br/>
<div class="Infoo">
<h2>System Info:</h4>

<?php
echo '<ul>
<li><strong>Application Version:</strong> ', APPLICATION_VERSION, '</li>
<li><strong>PHP Version:</strong> ', PHP_VERSION, '</li>
<li><strong>Operating System:</strong> ', PHP_OS, '</li>
<li><strong>Distro:</strong>' . exec('cat /etc/issue') . '</li>
';

if (array_key_exists('SERVER_SOFTWARE', $_SERVER))
echo '<li><strong>Server Software:</strong> ', $_SERVER['SERVER_SOFTWARE'], "</li>\n";
echo '</ul>';
?>
<br/>
</div>
<div id="ControlPanel">
<br/>
<table class="CPanel Searchd">
<tbody>
<tr>
<th class="Desc">Searchd: </th>
<th>Status</th>
<th class="Desc">Sphinx Daemon </th>
<th></th>
</tr>
<tr>
<td>Status: </td>
Expand All @@ -118,126 +133,6 @@
</div>
<br/>

<h3>Changelog</h3>
20190101
<ol>
<li>Update for Vanilla 2.5/6 and Sphinx 2.3.2-beta. Note, Sphinx 3 will NOT work with this version. Sphinx 3 is still a WIP as of begining of 2019. Until Ubuntu and other major distros ship Sphinx3, I won't be supporting it. Please make a github issue if you want Sphinx 3 support since major API changes were made. </li>
<li>TODO: Use SphinxQL instead of the API -> http://sphinxsearch.com/blog/2013/07/23/from-api-to-sphinxql-and-back-again/
</ol>
<br>
20170116
<ol>
<li>Fixes security issue of exposing sphinx configuration into the analytics tool</li>
<li>Fixes cron job generation</li>
</ol>
<br>
20140115
<ol>
<li>Deleted non-working links in the control panel</li>
</ol>
<br>
20140114
<ol>
<li> Support for v2.1b</li>
<li> Changed the default search to "Extended" mode</li>
<li> The quick search options now show syntax help</li>
<li> Slightly changed the installer to be more user friendly. Cron tasks installs are optional</li>
<li> Updated the installer instructions</li>
</ol>
<br>
20131210
<ol>
<li> The indexer/searchd/conf paths are now optional during the install since only the auto generated cron files used those inputs</li>
</ol>
<br>
20131205
<ol>
<li> Removed the complicated installer. Now all installs must be done before running the plugin</li>
<li> Removed all non-plugin related configurations from the settings menu. User must edit the generated sphinx.conf file directly</li>
<li> Fixed a bug where the number of related threads on the bottom of each discussion was using the limit as inserted in the
settings page for the sidebar widget. Now the settings work as intended and operate independent of each LIMIT.</li>
<li>fixed "sleek" to "sleak"</li>
</ol>
<br/>
20130330
<ol>
<li> Whenever the advanced search is expanded, the div will stay collapsed for subsequent searches until it is toggled</li>
<li> Fixed a bug where the xx amount of search results were not being reconstructed back to their original ranking order from sphinx. This caused the results within each page to be mixed randomly!</li>
<li> Fixed a bug where sometimes the results will say "xx results found" but no results actually shown. This is because the default page landing was NOT being set correctly to 1. This is repeatable when a
previous search on a large page number is then followed by a search that returns a few results on a smaller pagination scale than the previously viewed one. No results will be shown since the GET query string tells sphinx to return the previous search's offset</li>
<li>Instead of checking if sphinx is installed and ready, the plugin now forces the default search to ALWAYS be sphinx until the plugin is disabled. Any errors should now be spit out on any page that fetches a query from sphinx</li>
<li>Added a message indicating that apache may not have the correct read/write permissions</li>
</ol>
<br/>
20130214
<ol>
<li>Fixed a HUGE bug that caused all sphinx searches to also perform a regular MYSQL "LIKE" search!</li>
<li>Put a big reminder about enabling pretty URL's in the dasbhoard</li>
<li>Added better debug messages during install wizard and reminders to turn on error reporting</li>
<li>Added a check to enforce Pretty URL's for the time being</li>
<li>Now sphinx escapes every search query. Check your charset</li>
<li>Added default charset for English/Russian</li>
<li>Added debug info to the main results page. Now Sphinx will spit out any errors in your face!</li>
<li>Fixed issue where regular users could would not see the suggested threads when starting a new thread </li>
<li>Fixed queries with any numeric character references in them</li>
<li>Added link to view stats cron in the install wizard</li>
<li>Added icon image of the sphinx eye</li>
<li>Added permissions check for related discussions o main/regular discussions view</li>
<li>Fixed incorect query string from '?q=' to '?Search=' in the Related threads box on main results page</li>
<li>Added option for different charsets in sphinx.conf template file</li>
<li>Added hbf as a live demo that is better than my site as well as link back to main plugin site to readme</li>
<li>Verified read permission in viewfile @Gillingham</li>
<li>Fixed example cron files that were not pointing to correct paths @Gillingham</li>
</ol>
<br/>
20130105
<ol>
<li>Fixed search results not respecting user permissions (added another attribute to sphinx to filter on)</li>
<li>Updated release file to 2.0.6</li>
<li>Relocated definitions file to make it easier to edit</li>
<li>Deleted hard coded statements in config template that would override automatic settings set in plugin's settings page</li>
<li>Added more locale definitions to hitbox widget</li>
<li>Fixed incorrect query string in the results page. Any filtering done in the result page would only take affect for that single page! Now all pages are affected (fixed)</li>
<li>Fixed pagination results which would sometimes render blank results page. Now only 'MaxMatches' amount of results will be displayed (default is 1000 docs)</li>
<li>Fixed numerous spelling mistakes</li>
</ol>
<br/>
20120912
<ol>
<li>deleted old debug stuff that caused fatal error when auto completing</li>
<li>fixed problem with php classes not included...now just include all files in root of plugin </li>
</ol>
<br/>
20120905
<ol>
<li>Created temporary workaround that fixed non-Roman search phrases from being executed correctly </li>
<li>Fixed stats cron file location to its actual location</li>
<li>Fixed the RelatedPost widget from adding a query when it should not be</li>
<li>Added slight HTML edit to support traditional plugin/theme </li>
</ol>
<br/>
20120807
<ol>
<li>Added debug table to control panel</li>
<li>Fixed cron files to index at common times - also corrected file paths and comments</li>
<li>Deleted "Reload Connections" button...it was useless</li>
</ol>
<br/>
20120806
<ol>
<li>Added mysql_sock to config</li>
<li>Added mysql_db to config</li>
<li>Added localhost entry to wizard</li>
<li>Fixed FAQ link</li>
<li>Added an update entry to FAQ</li>
</ol>
<br/>
20120805
<ol>
<li>Initial Release</li>
</ol>
<br/>

<?php

function Success($Text) {
Expand Down
15 changes: 2 additions & 13 deletions views/wizard.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,28 +43,17 @@
}

</style>
<div class="Help Aside">
<?php
echo '<h2>', T('Need More Help?'), '</h2>';
echo '<ul>';
echo '<li>', Anchor(T('Install FAQ'), 'plugin/sphinxsearch/sphinxsearch/faq'), '</li>';
echo '<li>', Anchor(T('Offical Sphinx Documentation'), 'http://sphinxsearch.com/docs/current.html'), '</li>';
echo '</ul>';
?>
</div>
<h1><?php echo T($this->Data['Title']) . ' - ' . $this->Data['PluginVersion']; ?></h1>
<h1><?php echo T($this->Data['Title'])?></h1>
<div class="Info">
<?php echo T($this->Data['PluginDescription']); ?>
</div>
<h3><?php echo 'Quick Links'; ?></h3>
<div class="Info">
<ul>
<li><?php echo Anchor('Back To Control Panel', 'plugin/sphinxsearch'); ?></li>
<li><?php echo Anchor('Back To Sphinx Search', 'plugin/sphinxsearch'); ?></li>
</ul>
</div>
<h3>Install Wizard</h3>
<br/>
<br/>
<?php
echo $this->Form->Open(array('id' => 'Form'));
echo $this->Form->Errors();
Expand Down

0 comments on commit 5cf69ec

Please sign in to comment.