PC-BSD Wiki:Style Guidelines - Revision history

Tigersharke: /* Tables */

2013-05-09T11:12:36Z

‎Tables

Tigersharke: /* Tables */

2013-05-09T11:11:31Z

‎Tables

Tigersharke: /* Scalable Dimensions */

2013-04-23T03:35:22Z

‎Scalable Dimensions

Tigersharke: /* Page structure */

2013-04-23T03:27:55Z

‎Page structure

Tigersharke: /* Page structure */

2013-04-22T10:22:24Z

‎Page structure

Tigersharke: /* Hypertext Links */

2013-04-22T07:07:26Z

‎Hypertext Links

Tigersharke: /* Tables */

2013-04-22T07:03:28Z

‎Tables

Tigersharke: /* Tables */

2013-04-22T07:02:22Z

‎Tables

Tigersharke: /* Tables */

2013-04-22T07:01:08Z

‎Tables

Tigersharke: /* Tables */

2013-04-22T06:58:36Z

‎Tables

@@ Line 159: / Line 159: @@
 |'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki></nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>{{pipe}}-'''<br>'''<nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''1''{{pipe}}''The content'''''<nowiki>}}</nowiki>'''<br>'''{{pipe}}-<br><nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''2''{{pipe}}''The content'''''<nowiki>}}</nowiki><br>{{pipe}}<nowiki>}</nowiki>'''
 |'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''!'''''column title''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
-|'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}''width='''''32%'''{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
+|'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}''width='''32%'''{{pipe}}'''column title'''''<nowiki>}}</nowiki><br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
 |}
 : Also place a total of exactly one '''<nowiki><noinclude>{{GroupListHeading|tables}}</noinclude></nowiki>''' at the bottom of the page, below any existing <nowiki><noinclude>{{refheading}}</noinclude></nowiki> and above the category links section. Please note a small adjustment to this rule in the ''noinclude block'' section below.

@@ Line 158: / Line 158: @@
 |-
 |'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki></nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>{{pipe}}-'''<br>'''<nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''1''{{pipe}}''The content'''''<nowiki>}}</nowiki>'''<br>'''{{pipe}}-<br><nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''2''{{pipe}}''The content'''''<nowiki>}}</nowiki><br>{{pipe}}<nowiki>}</nowiki>'''
-|'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''!'''''column title''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
+|'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''!'''''column title''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
-|'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}''width='''32%''{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
+|'''<nowiki>{{</nowiki>tbl-init{{pipe}}caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}''width='''''32%'''{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
 |}
 : Also place a total of exactly one '''<nowiki><noinclude>{{GroupListHeading|tables}}</noinclude></nowiki>''' at the bottom of the page, below any existing <nowiki><noinclude>{{refheading}}</noinclude></nowiki> and above the category links section. Please note a small adjustment to this rule in the ''noinclude block'' section below.

@@ Line 289: / Line 289: @@
 * An initial image of other 4:3 ratio can be scaled down to 800x600 without serious distortion, but care must be taken that text remains legible.
-{{tbl-init|width=50%|caption=of Acceptable 4:3 screens}}
+{|class="spiffy_table"
-{{tbl-title|width=50%|Resolution}}
+|+'''Table of Acceptable 4:3 screens'''
-{{tbl-title|Multiplier}}
+!width=50%|Resolution
 |-
-{{tbl-cell|row=1|'''800x600'''}}
+|'''800x600'''
-{{tbl-cell|row=1|'''1.00'''}}
+|'''1.00'''
 |-
-{{tbl-cell|row=2|1024x768}}
+|1024x768
-{{tbl-cell|row=2|1.28}}
+|1.28
 |-
-{{tbl-cell|row=3|1152x864}}
+|1152x864
-{{tbl-cell|row=3|1.44}}
+|1.44
 |-
-{{tbl-cell|row=4|1200x900}}
+|1200x900
-{{tbl-cell|row=4|1.50}}
+|1.50
 |-
-{{tbl-cell|row=5|1280x960}}
+|1280x960
-{{tbl-cell|row=5|1.60}}
+|1.60
 |-
-{{tbl-cell|row=6|1400x1050}}
+|1400x1050
-{{tbl-cell|row=6|1.75}}
+|1.75
 |-
-{{tbl-cell|row=7|1440x1080}}
+|1440x1080
-{{tbl-cell|row=7|1.80}}
+|1.80
 |-
-{{tbl-cell|row=8|1600x1200}}
+|1600x1200
-{{tbl-cell|row=8|2.00}}
+|2.00
 |-
-{{tbl-cell|row=9|1920x1440}}
+|1920x1440
-{{tbl-cell|row=9|2.40}}
+|2.40
 |}

@@ Line 349: / Line 349: @@
 ; Header
-: Each handbook page contains a [[template:NavHeader|3-icon navigation panel]] across the top, while other pages linked from the main page contain [[template:NavHome|a simplified version]].
+: Each handbook page contains a [[template:NavHeader|3-icon navigation panel]] across the top,
 ; Stubs
@@ Line 359: / Line 364: @@
 ; The <nowiki><noinclude></nowiki> block
-: Each page should contain a group of category links at the bottom, along with a Refheading and GroupListHeading as applicable (may be enclosed with comment markers if not yet needed). No further text or spaces following, though in some instances a comment is present with nothing following it. The categories included here should become more general as the list continues downward, and example series in order would be: GNOME2, Desktops, Handbook. Although 'GNOME2' would be auto-included by NavHeader. The languages tag is added to display links to translations of the current page and will do nothing until the page is tagged for translation, therefore it can be added beforehand.
+: Each page should contain a group of category links at the bottom, along with a Refheading and GroupListHeading as applicable (may be enclosed with comment markers if not yet needed). No further text or spaces following, though in some instances a comment is present with nothing following it. The categories included here should become more general as the list continues downward, an example series in order would be: GNOME2, Desktops, Handbook. Although 'GNOME2' would be auto-included by NavHeader. The translate tag allows the page to be marked for translation, while the languages tag determines where links to translations of the current page will be displayed.
 {{txtbox|box=
 '''<nowiki><noinclude></nowiki>'''
@@ Line 366: / Line 371: @@
 '''<nowiki>[[</nowiki>category:'''''category 1'''''<nowiki>]]</nowiki>'''
 '''<nowiki>[[</nowiki>category:'''''category 2'''''<nowiki>]]</nowiki>'''
 '''<nowiki><languages/></nowiki>'''
 '''<nowiki></noinclude></nowiki>'''}}

@@ Line 359: / Line 359: @@
 ; The <nowiki><noinclude></nowiki> block
-: Each page should contain a group of category links at the bottom, along with a Refheading and GroupListHeading as applicable (may be enclosed with comment markers if not yet needed). No further text or spaces following, though in some instances a comment is present with nothing following it. The categories included here should become more general as the list continues downward, and example series in order would be: GNOME2, Desktops, Handbook. Although 'GNOME2' would be auto-included by NavHeader.
+: Each page should contain a group of category links at the bottom, along with a Refheading and GroupListHeading as applicable (may be enclosed with comment markers if not yet needed). No further text or spaces following, though in some instances a comment is present with nothing following it. The categories included here should become more general as the list continues downward, and example series in order would be: GNOME2, Desktops, Handbook. Although 'GNOME2' would be auto-included by NavHeader. The languages tag is added to display links to translations of the current page and will do nothing until the page is tagged for translation, therefore it can be added beforehand.
 {{txtbox|box=
 '''<nowiki><noinclude></nowiki>'''
@@ Line 366: / Line 366: @@
 '''<nowiki>[[</nowiki>category:'''''category 1'''''<nowiki>]]</nowiki>'''
 '''<nowiki>[[</nowiki>category:'''''category 2'''''<nowiki>]]</nowiki>'''
 '''<nowiki></noinclude></nowiki>'''}}

@@ Line 82: / Line 82: @@
 Within the text, it is helpful to add a link to topics, pages, and sites to further explain and allow for additional research.
 ; Name
-: Use a descriptive word or phrase. It can be the general location (page/site) of the link, as long as the link itself is to the specific section (when ever possible). Try not to be too general/generic. Highlight and italic used for clarity in the examples.
+: Use a descriptive word or phrase. It can be the general location (page/site) of the link, as long as the link itself is to the specific section (when ever possible). Try not to be too general/generic. Highlight and italic are used for clarity in the examples below.
 :: '''Replace this:''' You can find more information about hardware compatibility {{highlight|{{citelink|url=http://forums.freebsd.org/forumdisplay.php?f=32|txt=''here.''}}}}
 :: '''With this:''' You can find more information about hardware compatibility {{highlight|on the}} {{highlight|{{citelink|url=http://forums.freebsd.org/forumdisplay.php?f=32|''FreeBSD hardware forum''}}}}.

@@ Line 155: / Line 155: @@
 |This is rather verbose and was more of a brute force method to get the job done. Every line needed a row number which is helpful for readability but also correlated to coloration: odd=white, even=grey. '''-obsolete-''' Tables should be converted from this to the other method(s).
 |Clearly this method involves the least typing to produce a good result.
-|Since the CSS styles are in place, a mixed method is possible. Including '''tbl-title''' allows for defining width.
+|This mixed method is also possible. Including '''tbl-title''' allows for defining width.
 |-
 |'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki></nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>{{pipe}}-'''<br>'''<nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''1''{{pipe}}''The content'''''<nowiki>}}</nowiki>'''<br>'''{{pipe}}-<br><nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''2''{{pipe}}''The content'''''<nowiki>}}</nowiki><br>{{pipe}}<nowiki>}</nowiki>'''

@@ Line 153: / Line 153: @@
 !Combination (best)
 |-
-|This is rather verbose and is more of a brute force method to get the job done. Every line needs a row number which is helpful for readability but also correlates to coloration: odd=white, even=grey.
+|This is rather verbose and was more of a brute force method to get the job done. Every line needed a row number which is helpful for readability but also correlated to coloration: odd=white, even=grey. '''obsolete'''
-|There will likely be somewhat of a combination of the two, since some capabilities may be a bit cumbersome otherwise, such as specifying column widths. However, clearly this method involves the least typing to produce a good result.
+|Clearly this method involves the least typing to produce a good result.
-|Since the CSS styles are in place, a mixed method is possible. Including tbl-title allows for defining width.
+|Since the CSS styles are in place, a mixed method is possible. Including '''tbl-title''' allows for defining width.
 |-
 |'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki></nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>{{pipe}}-'''<br>'''<nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''1''{{pipe}}''The content'''''<nowiki>}}</nowiki>'''<br>'''{{pipe}}-<br><nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''2''{{pipe}}''The content'''''<nowiki>}}</nowiki><br>{{pipe}}<nowiki>}</nowiki>'''

@@ Line 149: / Line 149: @@
 {{tbl-init|caption= of comparison}}
-{{tbl-title|width=32%|Current method}}
+!width=32%|inline style via template method
-{{tbl-title|width=32%|CSS style method (minimal)}}
+!width=32%|CSS style method (minimal)
-!Blank
+!Combination (best)
-!Future (best)
 |-
-{{tbl-cell|row=1|content=This is rather verbose and is more of a brute force method to get the job done. Every line needs a row number which is helpful for readability but also correlates to coloration: odd=white, even=grey.}}
+|This is rather verbose and is more of a brute force method to get the job done. Every line needs a row number which is helpful for readability but also correlates to coloration: odd=white, even=grey.
-{{tbl-cell|row=1|There will likely be somewhat of a combination of the two, since some capabilities may be a bit cumbersome otherwise, such as specifying column widths. However, clearly this method involves the least typing to produce a good result.}}
+|There will likely be somewhat of a combination of the two, since some capabilities may be a bit cumbersome otherwise, such as specifying column widths. However, clearly this method involves the least typing to produce a good result.
+|Since the CSS styles are in place, a mixed method is possible. Including tbl-title allows for defining width.
-|When the CSS styles are in place, the right two columns will have matching coloration/style due to '''class=spiffy_table''' in tbl-init which is already present. Including tbl-title allows for defining width.
 |-
-{{tbl-cell|row=2|content='''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>{{pipe}}-'''<br>'''<nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''1''{{pipe}}''The content'''''<nowiki>}}</nowiki>'''<br>'''{{pipe}}-<br><nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''2''{{pipe}}''The content'''''<nowiki>}}</nowiki><br>{{pipe}}<nowiki>}</nowiki>'''}}
+|'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki></nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>{{pipe}}-'''<br>'''<nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''1''{{pipe}}''The content'''''<nowiki>}}</nowiki>'''<br>'''{{pipe}}-<br><nowiki>{{</nowiki>tbl-cell{{pipe}}row='''''2''{{pipe}}''The content'''''<nowiki>}}</nowiki><br>{{pipe}}<nowiki>}</nowiki>'''
-{{tbl-cell|row=2|content='''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''!'''''column title''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''}}
+|'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''!'''''column title''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
-−
 |'''<nowiki>{{</nowiki>tbl-init{{pipe}}''align='''center''{{pipe}}'''caption='''''1a. The caption'''''<nowiki>}}</nowiki>'''<br>'''<nowiki>{{</nowiki>tbl-title{{pipe}}''width='''32%''{{pipe}}'''''column title'''''<nowiki>}}</nowiki><br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}-<br>{{pipe}}'''''The content''<br>'''{{pipe}}<nowiki>}</nowiki>'''
 |}
-: Also place a total of exactly one '''<nowiki><noinclude>{{GroupListHeading|tables}}</noinclude></nowiki>''' at the bottom of the page, below any existing <nowiki><noinclude>{{refheading}}</noinclude></nowiki> and above the category links section.
+: Also place a total of exactly one '''<nowiki><noinclude>{{GroupListHeading|tables}}</noinclude></nowiki>''' at the bottom of the page, below any existing <nowiki><noinclude>{{refheading}}</noinclude></nowiki> and above the category links section. Please note a small adjustment to this rule in the ''noinclude block'' section below.
 == Topics structure ==