< User:Bigpuppy

Documentation Template documentation


This template is meant to provide an easy way to get to the top or bottom of a page it is transcluded on. It's designed for long pages, such as talk pages with a lot of messages. It's inspired by this template on Wikipedia, though no code is actually taken from there. Feel free to use it in your userpage or user talk page! I am automatically credited through the <div title></div> and <span title></span> tags.

Parameters

You can customize this template with the parameters background-color, arrow-color, border-radius, top (controlling the vertical position of the sidebar), left (controlling the horizontal position of the sidebar), and collapsible. collapsible is special as it is a true/false parameter. It adds a "Show/hide up/down buttons" link wherever you transcluded the template. When clicked, it shows or hides the up/down buttons. By default, it is true, but you can change it to false if you don't like it.

left is based on a percentage. If the percentage is lower, it goes more to the left.

top is also based on a percentage. If the percentage is lower, it goes higher.

Here are some examples of the template in use:

  • {{User:Bigpuppy/UpDown}} produces the default template on this page, with a background-color of #7953c4, an arrow-color of white, a border-radius of 100px, and a collapsible argument of true. It has a left of 77% and a top of 30%
  • {{User:Bigpuppy/UpDown|background-color=green|arrow-color=purple|border-radius=10px|collapsible=false|left=60%|top=50%}} produces the template shown on this page.
  • {{User:Bigpuppy/UpDown|background-color=#42f5bf|border-radius=70px}} produces the template shown on this page.
  • {{User:Bigpuppy/UpDown|arrow-color=|collapsible=false}} produces the template shown on this page.

Credits

  • As stated in the beginning, this template is inspired by Wikipedia:Template:Skip to top and bottom, though no code is taken from there.
  • Some code is taken from GlassGalaxy, indirectly through my sidebar. More specifically, the code that makes it glued to the screen in a certain place. However, there may be other code that is from GlassGalaxy.
  • Thanks to the MediaWiki/Wikipedia docs!

Other Notes

If you'd like to permanently hide this template on all pages it is on (for yourself only), add the following code to Special:MyPage/common.css:

.updown {
display: none;
}