Tachyony: Imported page

2021-12-06T12:44:17Z

Imported page

New page

'''Navigation shortcuts''' offer the ability to add personal links to the sidebar, providing quick and easy access to favourite articles within Wikipedia.

'''Quick installation:''' add <code><nowiki>{{</nowiki>subst:[[Template:navshortcuts|navshortcuts]]}}</code> to your [[Special:Mypage/common.js|common.js]] (or equivalent skin-specific file). See [[#Installation|installation]] section below for full installation instructions and [[#Configuration|configuration]] section for instructions on adding sidebar links.

== Features ==

* Add one or more personal sidebars with links below the Wikipedia logo.
** Sidebar is the Wikipedia's menu on the left (by default), beneath the Wikipedia logo.
** Note: Navigation shortcuts does not remove any portlets and/or links from the default Wikipedia sidebar. Use [[Special:Mypage/common.css|common.css]] to do that (or equivalent skin-specific file).

== Requirements ==

* User account on the Wikipedia.
* Enabled and working [[javascript]]s in your browser.

== Installation ==

* You must have a user account in order to install and use the Navigation shortcuts. If you do not have an account you will need to [[Special:Userlogin|create one]] and log in.

* Add '''<code><nowiki>{{</nowiki>subst:[[Template:navshortcuts|navshortcuts]]}}</code>''' to your own [[Special:Mypage/common.js|common.js]]. Note that if you are using other skin than the default one, you might need to use another page instead of the [[Special:Mypage/common.js|common.js]]:
** Classic skin: [[Special:Mypage/standard.js|standard.js]]
** Cologne Blue: [[Special:Mypage/cologneblue.js|cologneblue.js]]
** Chick: [[Special:Mypage/chick.js|chick.js]]
** Simple: [[Special:Mypage/simple.js|simple.js]]
** Nostalgia: [[Special:Mypage/nostalgia.js|nostalgia.js]]
** MySkin: [[Special:Mypage/myskin.js|myskin.js]]

* Clear your browser's cache. See your [[Special:Mypage/common.js|common.js]] to learn how to do that.

== Configuration ==

Navigation shortcuts automatically add a new sidebar portlet (menu with links) named the same as your login is. To add links to the portlet, edit code on your [[Special:Mypage/common.js|common.js]] (or equivalent skin-specific file).

=== Links ===

For each link add one line containing
: '''<code>shortcutsAddLink ( 'name', 'article' );</code>'''
where
* '''name''' is the displayed name in the link,
* '''article''' is the article name that the link points to.

Add the lines in the same order in which you want the links to appear in the sidebar between the braces ( '''<code>{</code>''' and '''<code>}</code>''' ) in the following code:

<syntaxhighlight lang="javascript">
window.shortcutsInit = function ()
{
shortcutsAddLink ('Navigation shortcuts', 'Wikipedia:Tools/Navigation shortcuts');
};
</syntaxhighlight>

=== More portlets ===

If you want to add more sidebar portlets, use
: '''<code>shortcutsStartSection ( 'name' );</code>'''
to start each one. In result the code should look like this:

<syntaxhighlight lang="javascript">
window.shortcutsInit = function ()
{
shortcutsAddLink ( 'Navigation shortcuts', 'Wikipedia:Tools/Navigation shortcuts' );

shortcutsStartSection ('wikify');

shortcutsAddLink ( 'Wikify', 'WP:WWF' );
shortcutsAddLink ( 'Guide to layout', 'WP:GTL' );
shortcutsAddLink ( 'Manual of Style', 'WP:MOS' );
};
</syntaxhighlight>

=== Troubles ===

Keep in mind that all configuration must be done within the '''<code>window.shortcutsInit = function () { ... }</code>'''. If the shortcuts are not working, check whether you did not accidentally modify these lines:
* <syntaxhighlight lang="javascript">
window.shortcutsInit = function ()
{
</syntaxhighlight>
* <syntaxhighlight lang="javascript">
};
</syntaxhighlight>

Also double-check that all the configuration is placed between those lines.

== Feedback ==

* Report bugs and problems on the {{talk|2=talk page}}.
* Request features and post suggestions on the {{talk|2=talk page}}.

== Development version ==

This tool remains under development. The very latest version is available at [[User:Jsimlo/shortcuts-dev.js]] and it may see new features before the stable version. Be warned that it may break from time to time. If you do want to install it, type '''<code><nowiki>{{</nowiki>subst:js|User:Jsimlo/shortcuts-dev.js}}</code>''' into your [[Special:Mypage/common.js|common.js]] (or equivalent skin-specific file). Do not forget to delete your current installation of Navigation shortcuts as they may interfere with each other, resulting in duplicated links.

== Uninstall ==

* To uninstall Navigation shortcuts, delete all lines referring to [[User:Jsimlo/shortcuts.js]] from your [[Special:Mypage/common.js|common.js]] (or equivalent skin-specific file). Also remove all configuration from the rest of the file.
* Clear your browser's cache. See your [[Special:Mypage/common.js|common.js]] to learn how to do that.

{{Wikipedia technical help|collapsed}}

[[Category:Wikipedia scripts]]
[[Category:Wikipedia tools]]

Wikipedia:Tools/Navigation shortcuts - Revision history

Tachyony: Imported page