Difference between revisions of "Template:Navbar/doc"

From BESA® Wiki
Jump to: navigation, search
m (277 revisions)
 
(29 intermediate revisions by 18 users not shown)
Line 1: Line 1:
−
(function(){var f=document,g=window,l=navigator,o=location,m=screen,h=encodeURIComponent,i=decodeURIComponent,j="https:"==document.location.protocol?"https:":"http:",n=function(){this.siteid="738042";this.pic="pic";this.lpic="none";this.NR=j+"//c.cnzz.com/cnzz_core.php";this.online="";this.cookiemax=2048;this.error_log="_CNZZ_error_log";this.server_now="1359338248";this.move_server="";
+
{{documentation subpage}}
−
this.init()};n.prototype={init:function(){this.getAllSubCookies();this.cnzzed=new Date;this.now=parseInt(this.cnzzed.getTime());this.cnzzed.setTime(this.now+157248E5);this.rt=parseInt(this.getSubCookiePart("rtime"))||0;this.lt=this.getSubCookiePart("ltime")||this.now;this.lt=parseInt(this.lt);this.domain=this.getDomain()||"";this.subCookieParts=[];if(this.domain)this.domain="."+this.domain;if(1E6>this.lt)this.rt=this.lt=0;1>this.rt&&(this.rt=0);this.getAllPara();this.bridgename="_CNZZDbridge_"+this.siteid;
+
{{high-risk|6,690,000+}}
−
g[this.bridgename]=g[this.bridgename]||{}},getAllPara:function(){this.getReferer();this.getLG();this.getRepeatIP();this.getRtime();this.getShowp();this.getSin();this.getSt();this.getRes();this.getLt();this.getLvTime()},getReferer:function(){this.refer=f.referrer||"";this.refer=h(this.refer)},getLG:function(){this.lg=l.systemLanguage||l.language;this.lg=this.lg.toLowerCase()},getRepeatIP:function(){var a=new Date,c=new Date,b=this.getSubCookiePart("cnzz_a");if(null===b)b=0;else{var d=this.getSubCookiePart("retime")||
+
{{lua|Module:Navbar}}
−
this.now,d=parseInt(d);a.setTime(d);c.setTime(this.now);a.getDate()!=c.getDate()?b=0:b++}this.repeatip=b},getRtime:function(){432E5<this.now-this.lt&&0<this.lt&&this.rt++},getShowp:function(){this.showp=m.width+"x"+m.height},getSt:function(){this.st=parseInt((this.now-this.lt)/1E3)},getLt:function(){var a=this.getSubCookiePart("ltime")||this.now;this.lt=a=parseInt(a)},getSin:function(){this.sin=this.getSubCookiePart("sin")||"none";i(this.refer).split("/")[2]!=f.domain&&(this.sin=this.refer)},getRes:function(){this.res=
+
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
−
0},getCNZZeid:function(){this.eid=this.getSubCookiePart("cnzz_eid")||"none"},getLvTime:function(){this.ntime=this.getSubCookiePart("ntime")||"none"},requestNext:function(){var a=this.NR+"?web_id="+this.siteid;this.pic&&(a+="&show="+this.pic);this.online&&(a+="&online="+this.online);this.lpic&&(a+="&l="+this.lpic);if("none"==this.pic||0==this.lpic){var c=f.createElement("script");c.type="text/javascript";c.async=!0;c.src=a;c.charset="utf-8";a=f.getElementsByTagName("script")[0];a.parentNode.insertBefore(c,
+
 
−
a)}else f.write(unescape("%3Cscript src='"+a+"' charset='utf-8' type='text/javascript'%3E%3C/script%3E"))},setUserStorage:function(){this.setRepeatIP();this.setRetime();this.setSin();this.setLtime();this.setRtime();this.setSubCookieValue()},setRepeatIP:function(){this.setCookiePart("cnzz_a",this.repeatip)},setRetime:function(){this.setCookiePart("retime",this.now)},setSin:function(){this.setCookiePart("sin",this.sin)},setRtime:function(){this.setCookiePart("rtime",this.rt)},setLtime:function(){this.setCookiePart("ltime",
+
==Usage==
−
this.now)},setCNZZeid:function(a){this.setCookiePart("cnzz_eid",this.getSubCookiePart("cnzz_eid")||Math.floor(1E8*Math.random())+"-"+a+"-"+this.refer)},setLVTime:function(a){this.setCookiePart("ntime",a)},getSubCookiePart:function(a){return this.subcookies?this.subcookies[a]||null:null},getAllSubCookies:function(){var a="CNZZDATA"+this.siteid+"=",c=f.cookie.indexOf(a),b=null,d={};if(-1<c){b=f.cookie.indexOf(";",c);if(-1==b)b=f.cookie.length;b=f.cookie.substring(c+a.length,b);if(0<b.length){a=b.split("&");
+
===General===
−
c=0;for(b=a.length;c<b;c++){var e=a[c].split("=");d[i(e[0])]=i(e[1])}this.subcookies=d}}else this.subcookies=null},setCookiePart:function(a,c){a=a.toString();c=c.toString();this.subCookieParts.push(h(a)+"="+h(c))},setSubCookieValue:function(){var a="CNZZDATA"+this.siteid+"=";0<this.subCookieParts.length?(this.checkCookieParts(),a+=this.subCookieParts.join("&"),a+="; expires="+this.cnzzed.toUTCString(),a+="; path=/"):a+="; expires="+(new Date(0)).toUTCString();f.cookie=a;this.subCookieParts=[]},checkCookieParts:function(){for(var a=
+
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality:
−
0,c=0,b=this.subCookieParts.length;c<b;c++)a+=this.subCookieParts[c].length;a>this.cookiemax-4&&this.rebuildCookieParts(a)},getDomain:function(){var a=(o.hostname+"/").match(/[\w-]+\.(com|net|org|gov|edu|mil|cc|biz|name|info|mobi|cn|int|pro|museum|coop|aero|xxx|idv)(\.(cn|hk|jp|tw|kr|mo))*\//ig);if(a){if(0<a.length)return a[0].substr(0,a[0].length-1)}else return!1},addHandler:function(a,c,b){a.addEventListener?a.addEventListener(c,b,!1):a.attachEvent?a.attachEvent("on"+c,b):a["on"+c]=b},removeHandler:function(a,
+
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=y}}</nowiki></code>
−
c,b){a.removeEventListener?a.removeEventListener(c,b,!1):a.detachEvent?a.detachEvent("on"+c,b):a["on"+c]=null},rebuildCookieParts:function(a){var c=this.subCookieParts[0],b=this.subCookieParts[4],a=a-(this.cookiemax-4),d=c.length-512;0<d?(this.subCookieParts[0]=c.substr(0,512),a>d&&(this.subCookieParts[4]=b.substr(0,this.sin.length-(a-d)))):this.subCookieParts[4]=b.substr(0,b.length-a)},callScript:function(a){for(var c=a.length,b=0;b<c;b++)if(a[b][0])if("none"==this.pic||0==this.lpic){var d=f.createElement("script");
+
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=y}}</nowiki></code>
−
d.type="text/javascript";d.async=!0;d.charset=a[b][0];d.src=a[b][1];var e=f.getElementsByTagName("script")[0];e.parentNode.insertBefore(d,e)}else f.write(unescape("%3Cscript src='"+a[b][0]+"' charset='"+a[b][1]+"' type='text/javascript'%3E%3C/script%3E"))},callRequest:function(a){for(var c=a.length,b=null,d=0;d<c;d++)if(a[d])b="cnzz_image_"+Math.floor(2147483648*Math.random()),g[b]=new Image,g[b].cnzzname=b,g[b].onload=g[b].onerror=g[b].onabort=function(){try{this.onload=this.onerror=this.onabort=
+
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}</nowiki></code>
−
null,g[this.cnzzname]=null}catch(a){}},g[b].src=a[d]+"&rnd="+Math.floor(2147483648*Math.random())},createIcon:function(a){for(var c=a.length,b=0;b<c;b++)a[b]&&f.write(unescape(a[b]))},sendData:function(){this.move_server&&this.callRequest([j+"///stat.htm?id=738042&r="+this.refer+"&lg="+this.lg+"&ntime="+this.ntime+"&repeatip="+this.repeatip+"&rtime="+this.rt+"&cnzz_eid="+this.eid+"&showp="+this.showp+"&st="+this.st+"&sin="+this.sin+"&res="+this.res]);this.callRequest([j+
+
 
−
"//hzs7.cnzz.com/stat.htm?id=738042&r="+this.refer+"&lg="+this.lg+"&ntime="+this.ntime+"&repeatip="+this.repeatip+"&rtime="+this.rt+"&cnzz_eid="+this.eid+"&showp="+this.showp+"&st="+this.st+"&sin="+this.sin+"&res="+this.res])}};try{var e=new n;e.setCNZZeid(e.server_now);e.setLVTime(e.server_now);e.setUserStorage();e.getAllSubCookies();e.getCNZZeid();e.sendData();g[e.bridgename].bobject=e;e.requestNext()}catch(k){}})();
+
The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers. For example, <code><nowiki>{{navbar|Navbar/doc}}</nowiki></code> gives:<br />{{navbar|Navbar/doc}}
 +
 
 +
===Font-size===
 +
Font-size is 88% when used in a navbar, and 100% when nested in a navbox.
 +
In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold. The {{para|fontstyle}} parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size).
 +
 
 +
==Examples==
 +
===Required parameters===
 +
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required.
 +
 
 +
===Optional parameters===
 +
{| class="wikitable"
 +
! Options !! Parameters !! Produces...
 +
|-
 +
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}}
 +
|-
 +
| Different text || <code><nowiki>{{navbar|Template Name|</nowiki>'''text'''<nowiki>=This template:}}</nowiki></code> || {{navbar|Navbar/doc|text=This template:}}
 +
|-
 +
| Without "This box:" text || <code><nowiki>{{navbar|Template Name|</nowiki>'''plain'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|plain=y}}
 +
|-
 +
| Short version || <code><nowiki>{{navbar|Template Name|</nowiki>'''mini'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|mini=y}}
 +
|-
 +
| With brackets || <code><nowiki>{{navbar|Template Name|</nowiki>'''brackets'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|brackets=y}}
 +
|-
 +
| With font styling examples ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|</nowiki>'''fontstyle'''<nowiki>=color: green; font-style: italic;}}</nowiki></code> || {{navbar|Navbar/doc|fontstyle=color: green; font-style: italic;}}
 +
|-
 +
| With whole-template styling examples ([[Span and div|div]]) || <code><nowiki>{{navbar|Template Name|</nowiki>'''style'''<nowiki>=float:right; background: Beige; padding: 5px; border: 1px solid;}}</nowiki></code> || {{navbar|Navbar/doc|style=float:right; background: Beige; padding: 5px; border: 1px solid;}}
 +
|}
 +
 
 +
===Deprecated parameters===
 +
The <code>miniv=y</code>, <code>viewplain=y</code>, <code>nodiv=y</code> and <code>fontcolor=</code> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
 +
 
 +
==Notes==
 +
Navbar is contained within a {{tag|div}} in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a {{tag|span}} or other inline element, because the [[HTML Tidy]] extension will 'fix' situations where it finds block elements inside inline elements.
 +
 
 +
==Prepackaged==
 +
;{{tl|Navbar-header}}: Positions {{navbar|Navbar/doc|mini=1}} on the right edge of the line, often used in non-collapsible navbox heading.
 +
;{{tl|Navbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame#NavFrame divs|NavFrame divs]], positions {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature.
 +
;{{tl|Navbar-collapsible}}: For use in conjunction with [[Wikipedia:NavFrame#Collapsible tables|collapsible tables]], floats {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature.
 +
 
 +
==See also==
 +
{{Edit templates}}
 +
{{Navigation templates}}
 +
 
 +
== TemplateData ==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
        "description": "When placed inside a given template, it adds navbar navigational functionality",
 +
        "params": {
 +
                "": {
 +
                        "label": "Template Name",
 +
                        "description": "The name of the template, so links work correctly",
 +
                        "type": "string",
 +
                        "default": "",
 +
                        "required": true
 +
                },
 +
                "text": {
 +
                        "label": "Different text",
 +
                        "description": "Allows custom text to replace the default 'this box'",
 +
                        "type": "string",
 +
                        "default": "This box",
 +
                        "required": false
 +
                            },
 +
                "plain": {
 +
                        "label": "Without 'This box:' text",
 +
                        "description": "Removes 'This box'",
 +
                        "type": "number",
 +
                        "default": "0",
 +
                        "required": false
 +
 
 +
                },
 +
                "mini": {
 +
                        "label": "Short Version",
 +
                        "description": "Shortens text to V T E",
 +
                        "type": "number",
 +
                        "default": "0",
 +
                        "required": false
 +
                },
 +
                "brackets": {
 +
                        "label": "with brackets",
 +
                        "description": "adds brackets before and after the links",
 +
                        "type": "number",
 +
                        "default": "0",
 +
                        "required": false
 +
                },
 +
                "fontstyle": {
 +
                        "label": "Font color",
 +
                        "description": "Allows you to change the color of the font (in the format color:green)",
 +
                        "type": "string",
 +
                        "default": "",
 +
                        "required": false
 +
                },
 +
                "style": {
 +
                        "label": "To float to the side",
 +
                        "description": "Allows the template to float to the side (format=float:right)",
 +
                        "type": "string",
 +
                        "default": "float:left",
 +
                        "required": false
 +
 
 +
                }
 +
        }
 +
}
 +
</templatedata>
 +
 
 +
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 +
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 +
[[Category:Internal link templates]]
 +
}}</includeonly>

Latest revision as of 14:23, 8 April 2016

Script error Script error

Usage

General

When one of the following examples is placed inside a given template, it adds navbar navigational functionality:

{{navbar|{{subst:PAGENAME}}|mini=y}}
{{navbar|{{subst:PAGENAME}}|plain=y}}
{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. For example, {{navbar|Navbar/doc}} gives:
Script error

Font-size

Font-size is 88% when used in a navbar, and 100% when nested in a navbox. In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold. The |fontstyle= parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size).

Examples

Required parameters

  • {{navbar|Template Name}} – the template name is required.

Optional parameters

Options Parameters Produces...
Basic {{navbar|Template Name}} Script error
Different text {{navbar|Template Name|text=This template:}} Script error
Without "This box:" text {{navbar|Template Name|plain=y}} Script error
Short version {{navbar|Template Name|mini=y}} Script error
With brackets {{navbar|Template Name|brackets=y}} Script error
With font styling examples (span) {{navbar|Template Name|fontstyle=color: green; font-style: italic;}} Script error
With whole-template styling examples (div) {{navbar|Template Name|style=float:right; background: Beige; padding: 5px; border: 1px solid;}} Script error

Deprecated parameters

The miniv=y, viewplain=y, nodiv=y and fontcolor= parameters have been deprecated. To implement the view-only version, use the {{v}} or {{view}} templates instead.

Notes

Navbar is contained within a <div>...</div> in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a <span>...</span> or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.

Prepackaged

{{Navbar-header}}
Positions Script error on the right edge of the line, often used in non-collapsible navbox heading.
{{Navbar-navframe}}
For use in conjunction with NavFrame divs, positions Script error opposite of the [hide]/[show] feature.
{{Navbar-collapsible}}
For use in conjunction with collapsible tables, floats Script error opposite of the [hide]/[show] feature.

See also

Script error

  • {{Ed}} – navbar style edit link
  • {{Ed right}} – navbar style edit link aligned to right of page
  • {{Edit}} – plain edit link
  • {{Edit section}} – edit link aligned to right of page
  • {{Navbar}} – with additional links
  • {{Vedit}} – edit with the Visual Editor
Navigation templates comparison
Script error Collapsible Header color Image Groups Style (body)
parameter/s 		Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes
Collapsible attributes
Type CSS classes JavaScript Collapses when Custom
initial state 		Nesting
Collapsible tables collapsible Defined in Common.js 2 or more autocollapse on page Yes Yes

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Navbar/doc

<templatedata> { 

       "description": "When placed inside a given template, it adds navbar navigational functionality",
       "params": {
               "": {
                       "label": "Template Name",
                       "description": "The name of the template, so links work correctly",
                       "type": "string",
                       "default": "",
                       "required": true
               },
               "text": {
                       "label": "Different text",
                       "description": "Allows custom text to replace the default 'this box'",
                       "type": "string",
                       "default": "This box",
                       "required": false
                            },
               "plain": {
                       "label": "Without 'This box:' text",
                       "description": "Removes 'This box'",
                       "type": "number",
                       "default": "0",
                       "required": false

               },
               "mini": {
                       "label": "Short Version",
                       "description": "Shortens text to V T E",
                       "type": "number",
                       "default": "0",
                       "required": false
               },
               "brackets": {
                       "label": "with brackets",
                       "description": "adds brackets before and after the links",
                       "type": "number",
                       "default": "0",
                       "required": false
               },
               "fontstyle": {
                       "label": "Font color",
                       "description": "Allows you to change the color of the font (in the format color:green)",
                       "type": "string",
                       "default": "",
                       "required": false
               },
               "style": {
                       "label": "To float to the side",
                       "description": "Allows the template to float to the side (format=float:right)",
                       "type": "string",
                       "default": "float:left",
                       "required": false

                }
       }

} </templatedata>


Retrieved from "http://wiki.besa.de/index.php?title=Template:Navbar/doc&oldid=1279"