documentation cleanup

This commit is contained in:
NottyNoz 2023-03-22 19:15:41 -04:00 committed by Shish
parent e7bc6c733a
commit c4317cab0d
6 changed files with 62 additions and 43 deletions

View File

@ -17,6 +17,6 @@ class BrowserSearchInfo extends ExtensionInfo
public string $description = "Allows the user to add a browser 'plugin' to search the site with real-time suggestions";
public ?string $documentation =
"Once installed, users with an opensearch compatible browser should see their search box light up with whatever \"click here to add a search engine\" notification they have
Some code (and lots of help) by Artanis (Erik Youngren <artanis.00@gmail.com>) from the 'tagger' extension - Used with permission";
<br>
<br>Some code (and lots of help) by Artanis (<a href='mailto:artanis.00@gmail.com'>Erik Youngren</a>) from the 'tagger' extension - Used with permission";
}

View File

@ -13,5 +13,26 @@ class BulkActionsInfo extends ExtensionInfo
public array $authors = ["Matthew Barbour"=>"matthew@darkholme.net"];
public string $license = self::LICENSE_WTFPL;
public string $description = "Provides query and selection-based bulk action support";
public ?string $documentation = "Provides bulk action section in list view. Allows performing actions against a set of posts based on query or manual selection. Based on Mass Tagger by Christian Walde <walde.christian@googlemail.com>, contributions by Shish and Agasa.";
public ?string $documentation = "Provides bulk action section in list view. Allows performing actions against a set of posts based on query or manual selection. Based on Mass Tagger by <a href='mailto:walde.christian@googlemail.com'>Christian Walde</a>, contributions by Shish and Agasa.
<p>
<p>
<b>Delete</b>
<br>Deletes all selected posts.
</p>
<p>
<b>Tag</b>
<br>Add the tags to all selected posts.
<br><code>[background wallpaper]</code> + <code>[sky]</code> <code>[background wallpaper sky]</code>
<br>
<br>Remove the tags from all selected posts.
<br><code>[background wallpaper]</code> + <code>[-wallpaper]</code> <code>[background]</code>
<br>
<br>Replace the tags in all selected posts.
<br><code>[background wallpaper]</code> + <code>[sky]</code> <code>[sky]</code>
</p>
<p>
<b>Source</b>
<br>Sets the source of all selected posts.
</p>
</p>";
}

View File

@ -16,10 +16,10 @@ class CustomHtmlHeadersInfo extends ExtensionInfo
public string $description = "Allows admins to modify & set custom &lt;head&gt; content";
public ?string $documentation =
"When you go to board config you can find a block named Custom HTML Headers.
In that block you can simply place any thing you can place within &lt;head&gt;&lt;/head&gt;
This can be useful if you want to add website tracking code or other javascript.
NOTE: Only use if you know what you're doing.
You can also add your website name as prefix or suffix to the title of each page on your website.";
<br>In that block you can simply place any thing you can place within &lt;head&gt;&lt;/head&gt;
<br>
<br>This can be useful if you want to add website tracking code or other javascript.
<br>NOTE: Only use if you know what you're doing.
<br>
<br>You can also add your website name as prefix or suffix to the title of each page on your website.";
}

View File

@ -13,7 +13,7 @@ class DanbooruApiInfo extends ExtensionInfo
public array $authors = ["JJS"=>"jsutinen@gmail.com"];
public string $description = "Allow Danbooru apps like Danbooru Uploader for Firefox to communicate with Shimmie";
public ?string $documentation =
"<p>Notes:
"<b>Notes</b>:
<br>danbooru API based on documentation from danbooru 1.0 -
http://attachr.com/7569
<br>I've only been able to test add_post and find_tags because I use the
@ -24,34 +24,32 @@ class DanbooruApiInfo extends ExtensionInfo
<li>find_posts - sort of works, filename is returned as the original filename and probably won't help when it comes to actually downloading it
<li>find_tags - id, name, and after_id all work but the tags parameter is ignored just like danbooru 1.0 ignores it
</ul>
CHANGELOG
13-OCT-08 8:00PM CST - JJS
Bugfix - Properly escape source attribute
17-SEP-08 10:00PM CST - JJS
Bugfix for changed page name checker in PageRequestEvent
13-APR-08 10:00PM CST - JJS
Properly escape the tags returned in find_tags and find_posts - Caught by ATravelingGeek
Updated extension info to be a bit more clear about its purpose
Deleted add_comment code as it didn't do anything anyway
01-MAR-08 7:00PM CST - JJS
Rewrote to make it compatible with Shimmie trunk again (r723 at least)
It may or may not support the new file handling stuff correctly, I'm only testing with images and the danbooru uploader for firefox
21-OCT-07 9:07PM CST - JJS
Turns out I actually did need to implement the new parameter names
for danbooru api v1.8.1. Now danbooruup should work when used with /api/danbooru/post/create.xml
Also correctly redirects the url provided by danbooruup in the event
of a duplicate image.
19-OCT-07 4:46PM CST - JJS
Add compatibility with danbooru api v1.8.1 style urls
for find_posts and add_post. NOTE: This does not implement
the changes to the parameter names, it is simply a
workaround for the latest danbooruup firefox extension.
Completely compatibility will probably involve a rewrite with a different URL
";
<br><b>CHANGELOG</b>
<br>13-OCT-08 8:00PM CST - JJS
<br>Bugfix - Properly escape source attribute
<br>
<br>17-SEP-08 10:00PM CST - JJS
<br>Bugfix for changed page name checker in PageRequestEvent
<br>
<br>13-APR-08 10:00PM CST - JJS
<br>Properly escape the tags returned in find_tags and find_posts - Caught by ATravelingGeek
<br>Updated extension info to be a bit more clear about its purpose
<br>Deleted add_comment code as it didn't do anything anyway
<br>
<br>01-MAR-08 7:00PM CST - JJS
<br>Rewrote to make it compatible with Shimmie trunk again (r723 at least)
<br>It may or may not support the new file handling stuff correctly, I'm only testing with images and the danbooru uploader for firefox
<br>
<br>21-OCT-07 9:07PM CST - JJS
<br>Turns out I actually did need to implement the new parameter names
<br>for danbooru api v1.8.1. Now danbooruup should work when used with /api/danbooru/post/create.xml
<br>Also correctly redirects the url provided by danbooruup in the event
<br>of a duplicate image.
<br>
<br>19-OCT-07 4:46PM CST - JJS
<br>Add compatibility with danbooru api v1.8.1 style urls
<br>for find_posts and add_post. NOTE: This does not implement
<br>the changes to the parameter names, it is simply a
<br>workaround for the latest danbooruup firefox extension.
<br>Completely compatibility will probably involve a rewrite with a different URL";
}

View File

@ -16,6 +16,6 @@ class QRImageInfo extends ExtensionInfo
public string $description = "Shows a QR Code for downloading a post to cell phones";
public ?string $documentation =
"Shows a QR Code for downloading a post to cell phones.
Based on Artanis's Link to Post Extension <artanis.00@gmail.com>
Further modified by Shish to remove the 7MB local QR generator and replace it with a link to google chart APIs";
<br>Based on <a href='mailto:artanis.00@gmail.com'>Artanis</a>'s Link to Post Extension.
<br>Further modified by Shish to remove the 7MB local QR generator and replace it with a link to Google Chart APIs";
}

View File

@ -211,7 +211,7 @@ class TagListTheme extends Themelet
);
$main_html .= "&nbsp;<br><a class='more' href='".make_link("tags")."'>Full List</a>\n";
$page->add_block(new Block("refine Search", $main_html, "left", 60));
$page->add_block(new Block("Refine Search", $main_html, "left", 60));
}
public function return_tag(array $row, array $tag_category_dict): array