Customization Policy

From Support Wiki
(Redirected from Customization policy)
Jump to navigation Jump to search

The following is the full Customization Policy regarding the customization of wikis on the wiki.gg platform using files, css, js, or other other methods of changing the appearance or display of the wiki and its contents. It will also contain some guidelines to help you customize your wiki for optimal performance.

DOs

  • Upload a wiki logo to File:Site-logo.png. This specific file location is required so that https://wiki.gg/wikis/ can display your logo. Optimizing this file using a tool such as https://tinypng.com/ is highly recommended as the logo file is normally loaded on every page, so smaller file sizes allow for faster loading times and are courteous to mobile users and other users who have a metered data connection.
  • Upload a site favicon to File:Site-favicon.ico. This is used to display an icon in users' browser tabs, bookmarks, etc.
  • Use the optimal file type for background images. JPG is almost always better than PNG as in most cases the background image usually has large dimensions and does not include transparency. An optimized JPG will almost always be much smaller in file size than an optimized PNG. Use a tool like https://tinyjpg.com/ to optimize your background image.
  • Do make your color choices for text properly contrast the background color they are over for legibility. Do keep in mind contrast may be different for users with color-blindness, so make sure your wiki is accessible for those users as well.

DON'Ts

  • Don't change the appearance of the wiki.gg Header or Footer in any way without first getting approval from wiki.gg staff.
    • If another wiki has made a change to one of these with approval, you may copy this change without permission; however, you may not make any alterations. If you want to make alterations, you must get approval from staff.
  • Don't change the display or appearance of advertisements in any way.
  • Don't hide/edit the content or appearance of content licensing in the wiki footer, file licensing templates, or other legal notices, without staff permission. EXCEPTION: Moving the content license image in the wiki footer to be adjacent to the MediaWiki logo is pre-approved.
  • Don't add custom mouse cursors to your default CSS. IF you really want a custom cursor, you can add one as a non-default gadget.
  • Don't choose red for your link color. Red is the color MediaWiki assigns to pages that don't exist, and this will be confusing for many users.

Other

  • You must include a link to Recent changes. Do this using the text recentchanges-url|recentchanges. These strings will automatically be translated by the software, and they'll provide the hotkey Alt/Opt+Shift+R to navigate to Recent changes from any other page on the wiki.
    • If you want to change the display of this field, you may edit the page MediaWiki:recentchanges.

If something is not covered in this policy, or you have questions concerning it or other customization questions, please reach out to wiki.gg Staff.