65:
472:
461:
123:
163:
189:
31:
850:
enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the
Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those)
1366:
1351:
1339:
80:
84:
1312:
248:
1378:
1335:
76:
1250:
704:
700:
230:
of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.
846:
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki
1209:
As a suggestion, here are colors for a navbox intended for documentation pages only. They follow the shading of regular blue navbox colors:
686:
1321:
1306:
666:
596:
471:
460:
234:
364:
Note that when loading the documentation from a page other than the local /doc subpage, it becomes tricky to handle the categories.
426:
When using this parameter, the toolbar will not show. Note that the /doc subpage in the link box will still show up if it exists.
1361:
734:
141:
51:
454:
The heading in the documentation box changes depending on namespace. See the below list for the default text in each namespace:
37:
1283:
580:
1271:
696:
584:
92:
748:
Depending on the namespace, the link box may have less features, or may not show up at all. The following table shows this:
255:
711:
835:
often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.
206:
1394:
576:
149:
1374:
1329:
72:
1277:, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
665:
Depending on where to the documentation is placed, it may be tricky to handle the categories and interwikis. See
646:
244:
This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the
854:
This template automatically points its links for the /doc, /sandbox and /testcases to the right namespace.
572:
145:
1315:
explains the use of /sandbox and /testcases subpages and includes more information about template testing.
1293:
1014:
510:
221:
41:
17:
1300:
824:
689:
with the basic documentation syntax. Preload text is also used for the /sandbox and /testcases links.
99:
721:
202:
148:. The tested changes can be added to this page in a single edit. Consider discussing changes on the
839:
When placed on talk pages, this template usually is placed near the top of the page and without
847:
773:
Full behavior, with the addition of a "create documentation" link when the page does not exist
1325:
1022:
652:
174:
247:
links), and the smaller "link box" that shows metadata about the documentation alongside the
238:
227:
727:
to a protected template page, so no need to manually add this template to protected pages.
195:
136:
To avoid major disruption and server load, any changes should be tested in the template's
820:
601:
This code should be added at the bottom of the template code page, with no space before
1388:
605:(which causes extra whitespace to show on pages where the template is transcluded):
540:
258:, where necessary, while allowing anyone to edit the documentation and categories.
130:
667:
Knowledge (XXG):Template documentation § Categories and interwiki links
793:
is specified (which will show "The above documentation is transcluded from
583:, etc. This parameter is useful for testing and is used extensively on the
539:|link box=The above documentation is automatically generated from
319:
To transclude a different page other than the /doc subpage, simply provide
59:
1215:<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->
682:
If the documentation page does not exist, the toolbar is replaced with a
266:
Normally, the template is used without parameters and is placed inside
811:
is specified, the "Add categories to the /doc subpage" will not show.
730:
When this template is on a /sandbox subpage it automatically adds the
1213:| titlestyle = background:#ccffe5 | basestyle = background:#ddffee
233:
For detailed instructions on how and when to use this template, see
376:
The documentation can also be fed directly as text, by using the
597:
Knowledge (XXG):Template documentation § Where to place it
699:. The preload pages for the /sandbox and /testcases links are
498:
Note that if the heading parameter is empty but defined (like
183:
157:
117:
25:
645:
To automatically insert the above text, you can also use the
571:, the template will behave exactly as if it were on the page
441:
takes precedence and always shows in the documentation box.
563:
You can simulate the output for a given page by using the
1355:
108:
45:
823:. But in some cases this template needs to be on the
502:) the heading alongside the toolbar will not show.
487:To customize the heading, simply set the parameter
631:<!-- Add categories to the /doc subpage -->
515:|heading-style=font-size:150%;color:red;
300:<!-- Add categories to the /doc subpage -->
1313:Knowledge (XXG):Template sandbox and test cases
8:
1309:is a how-to guide to template documentation.
610:<!--Last line of your template code-->
567:parameter. For example, if you use the code
385:<!--Last line of your template code-->
328:<!--Last line of your template code-->
279:<!--Last line of your template code-->
254:Use of this template allows templates to be
575:, including showing the documentation from
517:. Not that you should omit quotation marks
1345:Editors can experiment in this template's
1197:
841:<noinclude>...</noinclude>
268:<noinclude>...</noinclude>
1146:Main border; header background
1008:
750:
705:Template:Documentation/preload-testcases
270:at the bottom of the template page (see
819:This template is usually placed in the
493:|heading=Infobox documentation
271:
228:documented information and instructions
1307:Knowledge (XXG):Template documentation
1010:Knowledge (XXG) background colors for
815:Subject namespaces vs. talk namespaces
808:
804:
790:
717:This template also automatically adds
701:Template:Documentation/preload-sandbox
569:|page=Template:Edit protected
568:
564:
548:
538:
534:
533:To customize the link box, simply set
514:
506:
499:
492:
488:
438:
434:
430:
377:
369:
320:
235:Knowledge (XXG):Template documentation
795:{{{1}}}
412:<!-- template documentation -->
7:
707:. The preload page for the /sandbox
687:creates the page with preloaded text
669:for information about adding these.
840:
832:
602:
267:
50:See also the companion subpage for
1220:For subgroups, in child navboxes:
831:In the MediaWiki namespace, since
491:to anything you like, for example
24:
1251:Periodic table templates overview
1067:Current documentation background
547:To hide the link box, simply set
1191:So saturation in A is a bit off
470:
459:
226:template is used to contain the
187:
161:
131:approximately 130,000 pages
121:
63:
29:
1202:Colors for documentation navbox
581:Template:Edit protected/sandbox
697:Template:Documentation/preload
692:The preload page for the /doc
509:parameter can be fed optional
93:Template:Documentation subpage
1:
712:Template:Documentation/mirror
521:and add the ending semicolon
315:Transcluding a different page
577:Template:Edit protected/doc
1411:
1330:Template:Documentation/doc
1319:
594:
97:
90:
1379:Subpages of this template
1167:2nd header, accent colour
1106:
661:Categories and interwikis
272:§ Placement and tags
152:before implementing them.
144:subpages, or in your own
129:This template is used on
1222:
1211:
861:
607:
537:to something else, like
529:Customizing the link box
507:|heading-style=
382:
325:
276:
91:Not to be confused with
1243:background:#e6fff2 ...
735:Template sandbox notice
685:link. It automatically
573:Template:Edit protected
450:Customizing the heading
348:Template:Other page/doc
274:for more information):
1373:Add categories to the
1284:Barnstar documentation
465:Template documentation
68:Template documentation
42:Template:Documentation
18:Template:Documentation
1272:Documentation subpage
1161:150°, 10%, 100%
595:Further information:
585:module testcases page
249:sandbox and testcases
169:This template should
1182:150°, 4%, 100%
1140:150°, 15%, 95%
1119:150°, 15%, 75%
476:Module documentation
458:Template namespace:
429:Also note that when
203:Module:Documentation
194:This template uses
1058:150°, 6%, 99%
1027:
803:Alongside that, if
678:Automatic functions
549:|link box=
535:|link box=
1395:Template sandboxes
1125:Header border only
1009:
809:|content=
591:Placement and tags
500:|heading=
489:|heading=
480:Other namespaces:
469:Module namespace:
439:|content=
435:|content=
378:|content=
370:|content=
1259:
1258:
1195:
1194:
1088:
1086:
1026:
1023:Help:Using colors
833:<noinclude>
821:subject namespace
801:
800:
786:Other namespaces
744:Link box features
673:Technical details
603:<noinclude>
216:
215:
182:
181:
156:
155:
58:
57:
1402:
1370:
1359:
1343:
1298:
1292:
1288:
1282:
1276:
1270:
1254:
1242:
1239:
1236:
1232:
1229:
1226:
1216:
1198:
1090:
1084:
1082:
1028:
1020:
1019:
1013:
1000:
997:
994:
991:
988:
985:
982:
979:
976:
973:
970:
967:
964:
961:
958:
955:
952:
949:
946:
942:
939:
936:
933:
930:
927:
924:
921:
918:
915:
912:
909:
906:
902:
899:
896:
893:
890:
887:
884:
881:
878:
875:
871:
868:
865:
842:
834:
810:
806:
796:
792:
751:
739:
733:
726:
720:
709:
694:
684:
656:
641:
638:
635:
632:
629:
626:
623:
620:
617:
614:
611:
604:
570:
566:
554:
550:
543:
536:
524:
520:
516:
508:
501:
494:
490:
474:
463:
440:
436:
432:
422:
419:
416:
413:
410:
407:
404:
401:
398:
395:
392:
389:
386:
379:
371:
360:
357:
354:
351:
347:
344:
341:
338:
335:
332:
329:
322:
310:
307:
304:
301:
298:
295:
292:
289:
286:
283:
280:
269:
246:
225:
191:
190:
184:
165:
164:
158:
125:
124:
118:
111:
88:
69:
67:
66:
38:template sandbox
33:
32:
26:
1410:
1409:
1405:
1404:
1403:
1401:
1400:
1399:
1385:
1384:
1383:
1382:
1372:
1364:
1349:
1344:
1333:
1318:
1296:
1290:
1289:, a variant of
1286:
1280:
1274:
1268:
1265:
1260:
1248:
1245:
1244:
1240:
1237:
1234:
1230:
1227:
1224:
1218:
1217:
1214:
1203:
1188:Main background
1179:
1158:
1137:
1116:
1099:What we'd call
1083:(41.7%; 106/255
1080:
1077:
1055:
1017:
1011:
1007:
1002:
1001:
998:
995:
992:
989:
986:
983:
980:
977:
974:
971:
968:
965:
962:
959:
956:
953:
950:
947:
944:
940:
937:
934:
931:
928:
925:
922:
919:
916:
913:
910:
907:
904:
900:
897:
894:
891:
888:
885:
882:
879:
876:
873:
869:
866:
863:
860:
848:subpage feature
817:
794:
789:Hidden, unless
746:
737:
731:
724:
718:
708:
693:
683:
680:
675:
663:
650:
643:
642:
639:
636:
633:
630:
627:
624:
621:
618:
615:
612:
609:
599:
593:
565:|page=
561:
552:
531:
522:
518:
452:
447:
445:Advanced syntax
424:
423:
420:
417:
414:
411:
408:
405:
402:
399:
396:
393:
390:
387:
384:
374:
362:
361:
358:
355:
352:
349:
345:
342:
339:
336:
333:
330:
327:
317:
312:
311:
308:
305:
302:
299:
296:
293:
290:
287:
284:
281:
278:
264:
245:
219:
212:
188:
162:
135:
122:
116:
115:
107:
102:
96:
89:
70:
64:
62:
49:
30:
22:
21:
20:
12:
11:
5:
1408:
1406:
1398:
1397:
1387:
1386:
1317:
1316:
1310:
1304:
1278:
1264:
1261:
1257:
1256:
1223:
1212:
1205:
1204:
1201:
1196:
1193:
1192:
1189:
1186:
1183:
1180:
1177:
1175:
1171:
1170:
1168:
1165:
1162:
1159:
1156:
1154:
1150:
1149:
1147:
1144:
1141:
1138:
1135:
1133:
1129:
1128:
1126:
1123:
1120:
1117:
1114:
1112:
1108:
1107:
1104:
1103:
1097:
1094:
1091:
1081:Hue=150°
1078:
1075:
1073:
1069:
1068:
1065:
1062:
1059:
1056:
1053:
1051:
1047:
1046:
1043:
1040:
1037:
1034:
1031:
1006:
1003:
966:heading-style
917:heading-style
862:
859:
856:
837:
836:
825:Talk namespace
816:
813:
799:
798:
787:
783:
782:
781:Full behavior
779:
775:
774:
771:
767:
766:
765:Full behavior
763:
759:
758:
755:
745:
742:
679:
676:
674:
671:
662:
659:
653:subst:doc-code
649:code shortcut
608:
592:
589:
560:
557:
530:
527:
485:
484:
478:
467:
451:
448:
446:
443:
437:is specified,
383:
373:
366:
326:
316:
313:
277:
263:
262:General syntax
260:
214:
213:
211:
210:
199:
192:
180:
179:
166:
154:
153:
126:
114:
113:
103:
98:
61:
60:
56:
55:
34:
23:
15:
14:
13:
10:
9:
6:
4:
3:
2:
1407:
1396:
1393:
1392:
1390:
1380:
1376:
1368:
1363:
1357:
1353:
1348:
1341:
1337:
1331:
1327:
1323:
1322:documentation
1314:
1311:
1308:
1305:
1302:
1299:for use with
1295:
1294:Documentation
1285:
1279:
1273:
1267:
1266:
1262:
1255:
1252:
1221:
1210:
1207:
1206:
1200:
1199:
1190:
1187:
1184:
1181:
1176:
1173:
1172:
1169:
1166:
1163:
1160:
1155:
1152:
1151:
1148:
1145:
1142:
1139:
1134:
1131:
1130:
1127:
1124:
1121:
1118:
1113:
1110:
1109:
1105:
1102:
1098:
1095:
1092:
1079:
1074:
1071:
1070:
1066:
1063:
1060:
1057:
1052:
1049:
1048:
1044:
1042:General usage
1041:
1038:
1035:
1032:
1030:
1029:
1024:
1016:
1015:documentation
1004:
948:Documentation
908:Documentation
889:Documentation
877:Documentation
867:Documentation
857:
855:
852:
849:
844:
830:
829:
828:
826:
822:
814:
812:
788:
785:
784:
780:
777:
776:
772:
769:
768:
764:
761:
760:
756:
753:
752:
749:
743:
741:
736:
728:
723:
715:
713:
706:
702:
698:
690:
688:
677:
672:
670:
668:
660:
658:
654:
648:
625:documentation
606:
598:
590:
588:
586:
582:
579:, linking to
578:
574:
558:
556:
545:
542:
528:
526:
513:values, like
512:
503:
496:
483:
482:Documentation
479:
477:
473:
468:
466:
462:
457:
456:
455:
449:
444:
442:
427:
400:Documentation
381:
367:
365:
343:Documentation
324:
314:
294:Documentation
275:
273:
261:
259:
257:
252:
250:
242:
240:
236:
231:
229:
223:
222:documentation
208:
204:
201:
200:
197:
193:
186:
185:
177:
176:
172:
167:
160:
159:
151:
147:
143:
139:
133:
132:
127:
120:
119:
110:
105:
104:
101:
94:
86:
82:
78:
74:
53:
47:
43:
39:
35:
28:
27:
19:
1346:
1297:}}
1291:{{
1287:}}
1281:{{
1275:}}
1269:{{
1253:}}
1249:{{
1246:
1219:
1208:
1100:
1018:}}
1012:{{
1005:Color scheme
853:
851:namespaces.
845:
838:
818:
805:|1=
802:
791:|1=
747:
738:}}
732:{{
729:
725:}}
719:{{
716:
691:
681:
664:
655:}}
651:{{
647:substitution
644:
600:
562:
546:
541:Template:Foo
532:
504:
497:
486:
481:
475:
464:
453:
431:|1=
428:
425:
375:
363:
321:|1=
318:
265:
253:
243:
232:
224:}}
220:{{
217:
170:
168:
146:user subpage
137:
128:
112:}}
106:{{
36:This is the
1326:transcluded
1238:groupstyle
858:Full syntax
722:pp-template
380:parameter:
323:like this:
237:(shortcut:
175:substituted
83:] [
79:] [
75:] [
1320:The above
1303:templates.
1089:100%, 100%
754:Namespace
740:template.
368:Using the
142:/testcases
52:test cases
1377:subpage.
1362:testcases
1101:the color
1096:Basic hue
984:link box
935:link box
762:Template
757:Behavior
637:noinclude
616:noinclude
418:noinclude
391:noinclude
372:parameter
356:noinclude
334:noinclude
306:noinclude
285:noinclude
256:protected
150:talk page
40:page for
1389:Category
1301:barnstar
1263:See also
1247:Example:
1050:A
975:heading
957:content
926:heading
895:content
710:link is
695:link is
406:content
138:/sandbox
100:Shortcut
1354:|
1347:sandbox
1340:history
1338:|
1185:
1178:#F5FFFA
1164:
1157:#E6FFF2
1143:
1136:#CEF2E0
1122:
1115:#A3BFB1
1093:
1076:#00FF80
1061:
1054:#ECFCF4
770:Module
559:Testing
415:}}</
251:links.
239:WP:TDOC
207:sandbox
81:history
1371:pages.
1233:child
1228:Navbox
1064:Sample
843:tags.
1328:from
1045:Note
1039:Color
993:page
778:User
634:</
353:</
303:</
87:]
85:purge
71:[
16:<
1375:/doc
1367:edit
1360:and
1356:diff
1352:edit
1336:edit
943:or
703:and
640:>
619:>
613:<
505:The
433:and
421:>
394:>
388:<
359:>
337:>
331:<
309:>
288:>
282:<
218:The
77:edit
73:view
46:diff
1324:is
1085:dec
1036:HSV
1033:RGB
903:or
872:or
807:or
797:")
587:.
553:off
551:to
525:.
519:" "
511:CSS
241:).
196:Lua
173:be
171:not
140:or
109:doc
1391::
1332:.
1225:{{
1174:4
1153:3
1132:2
1111:1
1072:B
999:}}
945:{{
941:}}
905:{{
901:}}
886:{{
883:}}
874:{{
870:}}
864:{{
827::
714:.
657:.
628:}}
622:{{
555:.
544:.
495:.
397:{{
350:}}
340:{{
297:}}
291:{{
198::
48:).
1381:.
1369:)
1365:(
1358:)
1350:(
1342:)
1334:(
1241:=
1235:|
1231:|
1087:)
1025:)
1021:(
996:=
990:|
987:=
981:|
978:=
972:|
969:=
963:|
960:=
954:|
951:|
938:=
932:|
929:=
923:|
920:=
914:|
911:|
898:=
892:|
880:|
523:;
409:=
403:|
346:|
209:)
205:(
178:.
134:.
95:.
54:.
44:(
Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.
