Revision (current)
Last Updated by adelikat 20 days ago
%%TOC%%
Note: All modules and parameters names are case insensitive. Some modules require platform IDs which can be found [Systems|here].
Note: Only a few of these are actually usable in practical markup. Most of these modules are designed solely for the purpose of some
particular page.
!! ActiveTab
[[module:ActiveTab|tab=Forum]]
Used to override the tab of the main menu to be marked as active. The tab parameter is required and is the name of the menu to highlight
!! Awards
[[module:Awards|year=2020]]
Creates a list of all awards issued for the given year
Params:
|year|Required. Indicates the year to display awards for (in xxxx format. Ex: 2004).
!! BannedAvatarSites
[[module:BannedAvatarSites]]
Creates a list of sites that we do not allow avatars to be hosted on.
!! BrokenLinks
[[module:brokenlinks]
Lists broken links.
!! CrossGameObsoletions
Used by [TODO/CrossGameObsoletions] to display games that have had publications obsoleted by a publication classified as a different game. Used for cleaning up game categorizations
!! DisplayGameName
Displays the name of specified game or games (according to display name stored in games database table)
Params:
|gid=gameid|Comma-separated list of game IDs.|Mandatory except on special pages
The following pages are special (optional gid):
* Submission pages. Game defaults to whatever game is set for the submission.
* Movie pages. Game defaults to whatever game is set for the publication.
* Linked gameresources pages (and subpages thereof): Game(s) having that as resources page.
* Any subpages included by pages above.
Examples:
* [[module:displaygamename|gid=634] shows [module:displaygamename|gid=634].
* [[module:displaygamename|gid=634,709] shows [module:displaygamename|gid=634,709].
!! DisplayMiniMovie
[[module:displayminimovie|pubClass=Stars|flags=NewComerRec]]
Displays a single movie, that is picked at random from publications that meet the criteria. The display of this movie is designed to look like a 'Featured Movie' with a quick link to watch the movie. Currently only used on the home page.
Params:
|pubClass|The publications class to limit the candidate movies to|
|flags|A comma separated list of publications flags to limit the candidate movies to|
!! DisplayMovie
Example:
[[module:DisplayMovie|id=600]
Creates a movie listing, just like the Movies-*.html pages do. The parameters are the same as accepted by Movies-[[params]] pages:
;id:Limits selection to individual movies matching the given ID (comma separate to select many)
;obs:If specified, allows displaying obsolete movies (only when id is not specified)
;obsonly:If specified, limits display to obsolete movies (only when id or obs is not specified)
;systemCode:Limits selection to movies of games on the specified game console (give system ID, not system name, NES, SNES, etc)
;tag:Limits selection to movies where the given tag (by code) is specified
;pubClass:Comma-separated list of publication classes to filter for by class name.
;flag:Comma-separated list of flags to filter for by flag code.
;game:Comma-separated list of game IDs to filter for.
;group:Comma-separated list of game group IDs to filter for.
;author:A comma separated list of author ids to filter by
;noshowtiers:Comma-separated list of tier names not to show icons for
;noshowflags:Comma-separated list of flag names not to show icons for.
;year:Comma-separated list of years (2004, 2005, etc) to filter by publication date
;sort:U for oldest to newest, V for newest to oldest, Y for rating (highest to lowest)
;limit: An integer that specifies the maximum number of publications to display
!! EditorActivity
[[module:EditorActivity]
Used at [MostActiveEditors]. Displays statistics on editors' edits to movies and wiki pages.
!!FirstEditionTAS
[[module:FirstEditionTAS]
Display list of first publications for games.
Parameters:
|after=<timestamp>|Display only games with first publication at or after given unix timestamp.|
|before=<timestamp>|Display only games with first publication before given unix timestamp.|
|splitbyplatform|In addition of considering the game name, also consider the system.|
|vault|By default only movies outside the vault are displayed. Include this to display the vault tier as well.|
!! Frames
[[module:Frames]
Generates a human readable time from an amount of frames.
Params:
|amount=number|Amount of frames|Required
|fps=number|Override the default frames per second|Optional
The fps param should NOT be used on Publications or Submissions. The module will automatically use the assigned fps for these pages. On non-pub/sub pages, a default of 60 will be used if not specified. The param should only be used outside of pub/subs when a fps other than 60 is desired.
!! FrontPageSubmissionList
[[module:frontpagesubmissionlist|maxdays=n|limit=n]
Creates a submission listing for the front page.
!! GameName
[[module:GameName]]
Used by SystemGameResourcesHeader in order to generate the game name of a game resource page. This module should not be used anywhere else.
!! GameSubPages
Used by [GameResources] only. Displays all Game Resources pages
!! MediaPosts
Used by the [MediaPosts] page. Documents all the recent messages sent to external sources such as IRC and Discord.
!! MovieChangeLog
[[module:MovieChangeLog]
Lists history of movie updates and obsoletions.
Params:
|pubClass|The publications class to limit the candidate movies to (optional)|
!! MovieMaintLog
[[module:MovieMaintLog]]
Used at [Movie Maintenance Log]. Should not be placed somewhere else.
!! MoviesByAuthor
[[module:MoviesByAuthor]]
Displays list of movies grouped by author
Parameters:
|after=<timestamp>|Display only movies published at or after given unix timestamp.|
|before=<timestamp>|Display only movies published before given unix timestamp.|
|newbies=show|Mark newbies (first publication in given time interval).|
|newbies=only|Only show newbies (first publication in given time interval).|
!! MoviesGameList
[[module:MoviesGameList]]
Display list of games with dedicated pages. If invoked without parameters, outputs list for all systems.
Params:
| system=<id> | Only list games for given system |
| gamegroup=<id> | Only list games that belong to a given game group |
!! MoviesList
[[module:MoviesList]
Body of [MoviesList] pages. If invoked without parameters, outputs list for all systems.
Params:
| platform=<id> | Only list movies for given platform (instead of all platforms) |
!! MovieStatistics
[[module:MovieStatistics]
Lists statistics of movies.%%%
If invoked without parameters, lists generic statistics.
Params:
| comp=[[-]]fieldname | specifies field to compare using
| need=fieldname | specifies which field must have nonzero value
| fields=fieldname=fielddesc{,...} | lists fields to list
| top=n | specifies the number of results to output (default 10)
| minAge=n | specifies the minimum age of the movie in days to be listed
List of available fields is subject to change.
Currently it is:%%%
id, length, filererecords, playerid, recommended, alength, asize, aname,
desclen, num_lines, udesclen, formattedLength, formattedALength, compressionRatio, alengthPerLength, alengthMinusLength, formattedALengthMinusLength, btDownloaded, btDownloadedMegs, daysPublished, downloadsPerDay.
!! Nicovideo
NOTE: This module is not currently implemented but is planned
[[module:Nicovideo]
Generates an embedded [http://www.nicovideo.jp/|Nico Nico Douga (nicovideo)] movie viewer.
Params:
|v=code|Code is the component after the final / of the URL.|Required
|w=width|Override the default width of 728.|Optional
|h=height|Override the default height of 410.|Optional
|align=direction|Align to the left or right by sending the direction to left or right.|Optional
|hidelink|Specify this parameter to hide the link to Nico Nico Douga's site on the bottom.|Optional
!! NoEmulator
Used by [TODO/NoEmulator|NoEmulator] to place the list of publications and submissions that do not have the Emulator property populated. Should not be placed anywhere else.
!! NoGame
Used by [TODO/NoGame|NoGame] to place the listing of publications and submissions having no assigned game assigned. Should not be placed anywhere else.
!! NoGameGenres
Used by [TODO/NoGameGenres|NoGameGenres] to place a list of games that do not have at least one genre assigned to them
!! NoRomHash
Used by [TODO/NoRomHash|NoRomHash] to place the list of publications and submissions that have no rom hash assigned. Should not be placed anywhere else.
!! PlatformTaserLists
[[module:PlatformTaserLists|after=Y2019|before=Y2020|platforms=11|showClassIcons=true]]
Generates a list of publications, by author, that were published within the time range, and for the given platform. Intended to be used to generate lists of authors that are eligible for [Forum/Subforum/21|awards].
Params:
|before|Required. Exclusive. The year at which to end filtering|
|after|Required. Inclusive. The year at which to start filtering|
|platforms|Optional. The system ids to filter by|
|showClassIcons|Boolean. Optional. Whether or not to show the publication class icons.
!! PlatformFramerates
[[module:PlatformFramerates]]
Used by [PlatformFramerates] to display a list of framerates used by the site for each supported system when calculating movie times.
Displays
!! PlayerPointsTable
[[module:PlayerPointsTable]]
Creates a listing of all authors sorted by their [PlayerPointsAndRanks|player points].
Params:
|count|Optional. Indicates how many author entries to list. If omitted, will default to 50|
!! PublicationHistory
[[PublicationHistory]]
Creates a publication history for the given publication id
Params:
|publicationId|Required. The id of the publication to show history for|
!! PublicationsByTag
[[module:PublicationsByTag]]
Creates a listing of all publication tags that link to a list of current publications that use that tag.
!! Screenshots
[[module:Screenshots]]
Used by [Screenshot List]. Creates a list of all publication screenshots and associated screenshot descriptions
!! SetTableAttributes
[[module:SetTableAttributes|pattern=regexp|style=cssstyle]]
After a call to this module, subsequent table cells matching the given regexp will be given the specified CSS style. It has effect during the particular page's rendering, and does not affect other pages.
!! SupportedMovieTypes
[[module:SupportedMovieTypes]]
Used by [System/SupportedMovieTypes] to display a list of movie formats that can be [Subs-List|submitted] or uploaded to [UserFiles]. Should only be used by the system and not on any standard wiki page.
!! TabularMovieList
[[module:TabularMovieList|limit=10]]
Displays a list of publications, sorted newest to oldest in tabular form. Used on the front page.
Params:
|limit|Optional. Indicates the maximum number of movies to display. If not provided, the default of 10 is used|
!! TimeSinceDate
[[module:TimeSinceDate|y=2000|m=4|d=20|out=years]]
Displays the number of days or years since a given month, day, year. The display is culture specific.
Params:
|d|Required. The day of the date to count from|
|m|Required. The month of the date to count from|
|y|Required. The year of the date to count from|
|out|Required. Must be 'days' or 'years', and determines whether to calculate number of days or years|
!! TopicFeed
[[module:TopicFeed|t=TopicID|l=Limit|heading=text]
This module can be used to display the posts of a particular forum topic in reverse order. The paramter t= should be set to the topic ID for the thread. The optional l= parameter can be used to change the default limit of how many posts to display. The optional heading= parameter can be used to add a heading title. The optional hidecontent parameter will make content hidden until clicked on.
This is used at the [News] page.
!! UncatalogedTopics
[[module:UncatalogedTopics]
Lists forum topics in the game forum category that are not linked to a game. Used on [TODO/UncatalogedTopics]
!! UnmirroredMovies
[[module:UnmirroredMovies]
Lists movies without mirrors, streaming links, or some combination thereof. By default it lists all unmirrored movies. Used on [TODO/UnstreamedMovies].
Params:
|streamed|Lists unmirrored movies with streaming links.|
|unstreamed|Lists unmirrored movies without streaming links.|
|allunstreamed|Lists all movies without streaming links (or where the only streaming link is from Viddler).|
|current|Lists un-obsoleted movies only|
|obs|List obsoleted movies only|
!! User
[[user:adelikat]]
Creates a link to the user's profile. Should be used anytime a user is placing their name on a wiki page documenting an action. By using this, we get an easy profile link to the user.
!! UserMaintLog
Used by [UserMaintenanceLog] to show logs of user edits. Should not be used anywhere else.
!! UserMovies
[[module:usermovies|user=IDs|game=IDs|limit=maxentries]
List latest user movies
Params:
|user=IDs|List only files from those users if specified (comma separated)|
|game=IDs|List only files for those games (comma separated)|
|limit=maxentries|Override the default limit of 25 files|
|links=1|Display links for more and personal uploads|
!! welcome
Used to generate a banner message to new comers. Only displays when the user is not logged in. Should not be used anywhere else.
!! WikiOrphans
[[module:WikiOrphans]
Lists [wiki orphans].
Params:
| pagetypes=list | selects page types to list (commaseparated list of P,M,S)
| maxrefs=n | maximum references to consider the page for listing
Used at [WikiOrphans].
!! WikitextChangelog
[[module:WikiTextChangeLog|includeMinors=Y]]
Used by [RecentChanges] and [FullRecentChanges] to display a list of wiki edits. Should not be used on other pages.
Params:
|includeMinors|Boolean, indicates whether or not to include minor edits|
!! WikiUsers
[[module:WikiUsers|role=Site Admin]]
Displays a list of all users that current have this role
Params:
|role|Required. The name of the role. Note: Be sure to include spaces if the role name has them (Site Admin, not SiteAdmin)
!! Youtube
[[module:Youtube]
Generates an embedded [http://www.youtube.com/|YouTube] movie viewer.
Params:
|v=code|Code is the value of the v= parameter in the YouTube URL.|Required
|w=width|Override the default width of 425.|Optional
|h=height|Override the default height of 370.|Optional
|align=direction|Align to the left or right by sending the direction to left or right.|Optional
|start=seconds|Amount of seconds into the video to start playing it from.|Optional
|loop=seconds|Amount of seconds into the video at which point it should loop back to the starting point.|Optional
|hidelink|Specify this parameter to hide the link to YouTube's site on the bottom.|Optional
|flashblock|Specify this parameter to not load any flash directly, and require JavaScript button processing to load & play.|Optional