Mega Cool Author Page Tool (Batteries Now Included)

ERMAHGERD STAHP

This is a template page used internally by the SCP Wiki.

PLEASE DO NOT TOUCH THIS PAGE
WITHOUT STAFF PERMISSION


rating: +18+x

Introduction

Howdy there, and thank you for checking out this author page tool! This tool is designed to automatically update your author page with new pages and data, and provides support for additional pages, such as coauthored pages and foreign pages. Another tool similar to this one already exists on the wiki, and you can click here if you're interested in using it.

But Why?

I know that there's a tool like this already on the wiki. I still think that's really cool, of course! But there were some things that I'd like to see in that kind of tool that I've included in here. For starters, this tool includes variables such as upvote/downvote ratios, tags, and even translations! Additionally, there are a lot more customization options, such as toggling the floating effect or choosing the background.

Basically, there are plenty of differences between this tool and the other tool. There's definitely pros and cons to both; introducing another tool merely gives more options to select from.

Collapsibles

I'm putting this at the top so that you can see it before you try and implement it.

This tool will not work with standard collapsibles.

If you'd like to place this tool underneath a collapsible, you'll have to use the tool below:

[[include :scp-wiki:component:coltop show=SHOW TEXT |hide=HIDE TEXT]]
<content>
[[include :scp-wiki:component:colend]]

The reason this doesn't work is because the "Tags" and "Translations" sections of this are underneath collapsibles1, and because of complicated coding reasons, I can't use the collapsible thing I just showed you within the tool itself. Sorry ):

The Main Stuff

There are three components to this tool: the automatic page lister, the coauthored pieces section, and the foreign articles section. The first one is automatic, and includes most of the pages you'll make on the site.

Here's the base code you'll need to include, and I'll explain what each variable does below:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-list= --]
|language=
|order=
|perpage=
|background-image=
|shadow=
]]

|language= Put the two-letter identifier for the language branch your author page is on. On the English wiki, you'll put "en", on the Chinese wiki, you'll put "cn", etc. Note that anything requiring one of these two-letter identifiers is case-sensitive, and must be entered in lowercase.

|order= The order you want your articles to be in. Use one of the following variables for whichever results you'd like:

  • name: Order alphabetically by page URL.
  • title: Order alphabetically by page title.
  • rating: Order by rating.
  • created_at: Order by time created.

You can put any of these in reverse order simply by adding "desc" afterwards (e.g. "rating desc").

|perpage= The number of articles of each category you want per page. Default is 20, maximum is 250.

|background-image= If you'd like to have a background image or logo when you hover over entries, paste a link to the image you'd like. If you'd like to use a simple Foundation logo, you can use the one here. If you leave it blank, no image will show up.

|shadow= By default, whenever you hover your mouse over an entry, the entry will "pop out" slightly. If you don't want it to do this, put "no" or "false" here.

I've shown an example of how this might look below, using the most recently created articles on the site. These are ordered by time created, with this background image.

There are multiple values and sections here, and I'll go through each one of them really quickly.

(Random): Selects a random article of that category.

Rating and Comments: The rating and the number of comments, respectively.

+/-: This is the ratio of upvotes to downvotes. For instance, a value of "+8/-2" would mean that the article has 8 upvotes and 2 downvotes.

Last Comment: The name of the user who gave the last comment.

Tags: Can open a list of all visible tags on the article, with links to each tag page.

Translations: Can open a list of all translations of the article.

Coauthored Articles

One thing that the tool above doesn't include is coauthored pages. Coauthored pages using this module are uploaded manually, although they're each easy and simple to upload. The reason they're not included with the standard updater is for two reasons. First, you can't attribute coauthor credit. Second, if you have multiple coauthored pages, there's a chance that some of those pages were uploaded by you and some by your coauthor, and only the ones that were uploaded by you would actually show up on the module. This means that you'd be forced to either split all coauthored pages between the standard module and the coauthored module, or you'd have duplicates of articles on the main module in the coauthored section.

If you have coauthored pages, first, place this module above where you want your coauthored pages:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-coauthor-header= --]]]

Then, you'd need to use one of these for every one of your coauthored pieces:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-coauthored= --]
|name=
|feat=
|language=
]]

This one only has three variables needed, since everything else should already be covered by the standard tool that's already on your page.

|name= This is the portion of the URL link that specifies your page on the site. It is not the actual title of the article. For instance, instead of putting "Periapsis," for this page, you would put "scp-4391".

|feat= List all of the coauthors for the page here, except yourself.

|language= Same as the one above, it's the two-letter lowercase ID for the article's language.

Here's an example of one of my own coauthored pieces, with CityToast:

Foreign Articles

While I'm sure this only covers a small portion of your, some folks write not only for this branch of the wiki, but also for a different language branch! Naturally, you should be free to take credit for those as well.

Foreign articles are a bit trickier to implement. One of the biggest issues is that any article of yours that you've written on a different translation site will be hosted on a different site from the site your author page is on. This means that we can't use ListPages to return things like ratings, comments, or tags. The only things showing up here, sadly, will be the article link, a link to a translation, and the list of translations. Ironically, it has the most variables out of anything, since it involves some cross-site magic.

Include this module above where you want your foreign articles:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-foreign-header= --]]]

Then, include this piece of code for every one of your foreign articles:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-foreign= --]
|name=
|title=
|branch=
|translation=
|language=
|author-language=
]]

|name= The name of the article. Again, not the title, but the name from the URL link.

|title= This is where the actual title goes.

|branch= The name of the translation branch as it appears in the URL. For instance, if your article is from the -JP branch, you'd put "scp-jp".

|translation= A full link to the translation in the language of your site. For example, if you're on the -EN wiki and have written a -CN article which was translated onto the -EN wiki, you'd include a link to the English translation on the -EN wiki. If you don't have a translation available, put "no".

|language= The name of the language the original article is in. For example, if you're including an article from the -FR branch, put "French".

|author-language= The language branch abbreviation that your author page is hosted on.

The reason for all these variables is to ensure that the one things that does work, the translation module, will fully function properly. Since ListPages can't access other sites, a lot more stuff has to be put in manually.

Here's an example of how it would look using SCP-488-JP, if the original author had made an author page on the -EN wiki.

Manual Component

The auto-updater isn't a perfect tool, sadly. If you've deleted your account previously, or if you've written articles for someone else, this tool likely won't function properly. You might also not like it for other reasons! Maybe you don't like how the categories are divided up, or there are some pages you'd like to leave off, or whatever.

If you'd like to include all the information that comes with this module, but you don't want to use the auto-updater, you're covered!

For every category of articles you'd like to show, place this code block above where the articles will go:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-manual-header= --]
|category=
|tags=
]]

|category= This is the header that will go above the list of articles. On the auto-updating list, there are four categories: SCPs, Tales, GoI Formats, and Others. Place the category of all the articles that will go below this. For instance, if you're including all your articles featuring the GOC in this section, you might put "GOC Articles," or if you're including all the theme pages you've made, you might put "Theme Pages". If you're not dividing your articles up at all, you could just put "Articles".

|tags= This is used for the "Random" button beneath the header. Basically, it includes all the tags that are shared by articles in this category and are written by you, which this button will then randomly select from when you click it. List out any tags you want it to select from in a space-separated list of tags, each of the prefaced by a "+". If you want to be sure that certain articles are excluded, include those tags prefaced by a "-". For instance, if you wanted to include any pages related to Doctor Wondertainment, but which aren't SCP articles, you would put "+dr-wondertainment -scp". If you don't want a random button at all, you can simply leave this article blank. If you want it to randomly select from all your articles, put "-author".

Next are the manual entries. For every one of your articles, include this block:

[[include :scp-wiki:component:mega-cool-author-page-tool |inc-manual-list= --]
|name=
|background-image=
|language=
|shadow=
]]

Pretty much all of these variables are covered above, with the normal module! The only difference is that you now have to include the name of the article itself. If you want to include coauthored or foreign pages, you can use the tools above, with or without the big "Co-Authored" and "Foreign" headers if you'd prefer.

If you are have any issues or concerns with this tool, send a Wikidot PM to Calibri BoldCalibri Bold, or leave a comment on this page! Good luck, and happy skipping!

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License