Help:Style Guidelines - Revision history

Sidetone: /* Text highlighting guidelines */

2015-11-01T22:12:26Z

Text highlighting guidelines

Sidetone: /* Text highlighting guidelines */

2015-11-01T22:02:49Z

Text highlighting guidelines

Sidetone: /* Text highlighting guidelines */

2015-11-01T22:02:15Z

Text highlighting guidelines

Sidetone: /* Text highlighting guidelines */

2015-11-01T21:58:24Z

Text highlighting guidelines

Sidetone: /* Text guidelines */ add template information

2015-11-01T21:57:08Z

Text guidelines: add template information

Sidetone at 21:50, 1 November 2015

2015-11-01T21:50:53Z

Sidetone: /* Indicating directories, files and port-trees */

2015-10-30T07:46:24Z

Indicating directories, files and port-trees

Sidetone: /* Indicating directories, files and port-trees */

2015-10-30T01:02:22Z

Indicating directories, files and port-trees

Sidetone: inline console text

2015-10-30T00:36:44Z

inline console text

Jimbo: Reverted edits by 49.212.3.179 (Talk) to last revision by Jimbo

2011-08-01T22:21:32Z

Reverted edits by 49.212.3.179 (Talk) to last revision by Jimbo

@@ Line 25: / Line 25: @@
 Here are templates for adding clarity to text. Templates need <nowiki><nowiki></nowiki> tags to properly display special characters.
-* For commandline text within paragraphs use ''<nowiki>{{cmd|kldstat -v}}</nowiki>'' to produce {{cmd|kldstat -v}}.
+* For commandline text within paragraphs use {{yhl|''<nowiki>{{cmd|kldstat -v}}</nowiki>''}} to produce {{cmd|kldstat -v}}.
-* For code console output or file contents use ''<nowiki>{{code|:Command not found.}} for </nowiki>{{code|:Command not found.}}
+* For code console output or file contents use {{yhl|<nowiki>{{code|:Command not found.}}</nowiki>}} for {{code|:Command not found.}}.
-* Displaying files and directories use the same code, but end directory descriptions in "/". ''<nowiki>{{file|/usr/local/etc/}}</nowiki>'' produces {{file|/usr/local/etc/}} for directories. ''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}} for files.
+* Displaying files and directories use the same code, but end directory descriptions in "/". {{yhl|''<nowiki>{{file|/usr/local/etc/}}</nowiki>''}} produces {{file|/usr/local/etc/}} for directories. {{yhl|''<nowiki>{{file|/etc/rc.conf}}</nowiki>''}} produces {{file|/etc/rc.conf}} for files.
-* ''<nowiki>{{port|ftp/curl|BSD}}</nowiki>'' produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org, if it exists.
+* {{yhl|''<nowiki>{{port|ftp/curl|BSD}}</nowiki>''}} produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org, if it exists.
-* ''<nowiki>{{man|kldstat|8}}</nowiki>'' produces {{man|kldstat|8}}. ''<nowiki>{{man|kldstat}}</nowiki>'' produces {{man|kldstat}}
+* {{yhl|''<nowiki>{{man|kldstat|8}}</nowiki>''}} produces {{man|kldstat|8}}. {{yhl|''<nowiki>{{man|kldstat}}</nowiki>''}} produces {{man|kldstat}}.
-* For yellow highlighting of types of text not mentioned here, use ''<nowiki>{{yhl|look at this!}}</nowiki>'' for {{yhl|''look at this!''}}.
+* For yellow highlighting of types of text not mentioned here, use {{yhl|''<nowiki>{{yhl|look at this!}}</nowiki>''}} for {{yhl|''look at this!''}}.

@@ Line 31: / Line 31: @@
 * Displaying files and directories use the same code, but end directory descriptions in "/". ''<nowiki>{{file|/usr/local/etc/}}</nowiki>'' produces {{file|/usr/local/etc/}} for directories. ''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}} for files.
-* ''<nowiki>{{port|ftp/curl|BSD}}</nowiki>'' produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org if it exists.
+* ''<nowiki>{{port|ftp/curl|BSD}}</nowiki>'' produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org, if it exists.
 * ''<nowiki>{{man|kldstat|8}}</nowiki>'' produces {{man|kldstat|8}}. ''<nowiki>{{man|kldstat}}</nowiki>'' produces {{man|kldstat}}
 * For yellow highlighting of types of text not mentioned here, use ''<nowiki>{{yhl|look at this!}}</nowiki>'' for {{yhl|''look at this!''}}.

@@ Line 24: / Line 24: @@
   <nowiki>#This text is commented out</nowiki>
-* For commandline text within paragraphs use ''<nowiki>{{cmd|kldstat -v}}</nowiki>'' to produce {{cmd|kldstat -v}}. The cmd template needs <nowiki><nowiki></nowiki> tags to properly display special characters.
+Here are templates for adding clarity to text. Templates need <nowiki><nowiki></nowiki> tags to properly display special characters.
 * For code console output or file contents use ''<nowiki>{{code|:Command not found.}} for </nowiki>{{code|:Command not found.}}

@@ Line 21: / Line 21: @@
 The leading space can also be used for code from console output, and file contents.
   <nowiki>#!/bin/sh</nowiki>
-  <nowiki>exec xorg</nowiki>
+  exec xorg</nowiki>
-  <nowiki>#This line is commented out</nowiki>
+  <nowiki>#This text is commented out</nowiki>
 * For commandline text within paragraphs use ''<nowiki>{{cmd|kldstat -v}}</nowiki>'' to produce {{cmd|kldstat -v}}. The cmd template needs <nowiki><nowiki></nowiki> tags to properly display special characters.
 * For code console output or file contents use ''<nowiki>{{code|:Command not found.}} for </nowiki>{{code|:Command not found.}}
-* For files and directories use the same code, but end directory descriptions in "/". ''<nowiki>{{file|/usr/local/etc/}}</nowiki>'' produces {{file|/usr/local/etc/}} for directories. ''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}} for files.
+* Displaying files and directories use the same code, but end directory descriptions in "/". ''<nowiki>{{file|/usr/local/etc/}}</nowiki>'' produces {{file|/usr/local/etc/}} for directories. ''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}} for files.
 * ''<nowiki>{{port|ftp/curl|BSD}}</nowiki>'' produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org if it exists.

@@ Line 11: / Line 11: @@
 This is how the article you're reading right now is formatted.
-==Text guidelines==
+==Text highlighting guidelines==
 When showing an interactive console session, please use a leading space in front of every line (to put the session in a little "box" in the article when it renders) and use the triple-singlequote (<nowiki>'''</nowiki>) wikitag to bold user-entered text.  For example:
@@ Line 19: / Line 19: @@
   ph34r#
-For commandline text within paragraphs use ''<nowiki>{{cmd|kldstat -v}}</nowiki>'' to produce {{cmd|kldstat -v}}. The cmd template needs <nowiki> tags to properly display special characters.
+The leading space can also be used for code from console output, and file contents.
-* ''<nowiki>{{file|/usr/local/etc/}}</nowiki>'' produces {{file|/usr/local/etc/}} for directories.
+* For commandline text within paragraphs use ''<nowiki>{{cmd|kldstat -v}}</nowiki>'' to produce {{cmd|kldstat -v}}. The cmd template needs <nowiki><nowiki></nowiki> tags to properly display special characters.
-For code console output or file contents use ''<nowiki>{{code|:Command not found.}} for </nowiki>{{code|:Command not found.}}
+* For code console output or file contents use ''<nowiki>{{code|:Command not found.}} for </nowiki>{{code|:Command not found.}}
-''<nowiki>{{port|ftp/curl|BSD}}</nowiki>'' produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org if it exists.
+* For files and directories use the same code, but end directory descriptions in "/". ''<nowiki>{{file|/usr/local/etc/}}</nowiki>'' produces {{file|/usr/local/etc/}} for directories. ''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}} for files.
-''<nowiki>{{man|kldstat|8}}</nowiki>'' produces {{man|kldstat|8}}. ''<nowiki>{{man|kldstat}}</nowiki>'' produces {{man|kldstat}}
+* ''<nowiki>{{port|ftp/curl|BSD}}</nowiki>'' produces {{port|ftp/curl|BSD}} for ports in ports-tree, and optionally it's licence. It links to the port's page on freshports.org if it exists.
-For yellow highlighting of types of text not mentioned here, use ''<nowiki>{{yhl|look at this!}}</nowiki>'' for {{yhl|''look at this!''}}.
+* ''<nowiki>{{man|kldstat|8}}</nowiki>'' produces {{man|kldstat|8}}. ''<nowiki>{{man|kldstat}}</nowiki>'' produces {{man|kldstat}}

@@ Line 22: / Line 22: @@
 ==Indicating directories, files and port-trees==
-''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}}.
+''<nowiki>{{file|/etc/rc.conf}}</nowiki>'' produces {{file|/etc/rc.conf}} for files.
+''<nowiki>{{port|ftp/curl}}</nowiki>'' produces {{port|ftp/curl}} for ports in ports-tree.
-''<nowiki>{{prt|ftp/curl}}</nowiki>'' produces {{prt|ftp/curl}}.

← Older revision		Revision as of 01:02, 30 October 2015
Line 20:		Line 20:

	For commandline text within paragraphs use ''<nowiki>{{cmd\|kldstat -v}}</nowiki>'' to produce {{cmd\|kldstat -v}}. The cmd template can't be used with special characters.		For commandline text within paragraphs use ''<nowiki>{{cmd\|kldstat -v}}</nowiki>'' to produce {{cmd\|kldstat -v}}. The cmd template can't be used with special characters.
		+
		+	==Indicating directories, files and port-trees==
		+
		+	''<nowiki>{{file\|/etc/rc.conf}}</nowiki>'' produces {{file\|/etc/rc.conf}}.
		+
		+
		+	''<nowiki>{{prt\|ftp/curl}}</nowiki>'' produces {{prt\|ftp/curl}}.

← Older revision		Revision as of 00:36, 30 October 2015
Line 18:		Line 18:
	this: Command not found.		this: Command not found.
	ph34r#		ph34r#
		+
		+	For commandline text within paragraphs use ''<nowiki>{{cmd\|kldstat -v}}</nowiki>'' to produce {{cmd\|kldstat -v}}. The cmd template can't be used with special characters.

← Older revision		Revision as of 22:21, 1 August 2011
Line 11:		Line 11:
	This is how the article you're reading right now is formatted.		This is how the article you're reading right now is formatted.

−	~~cu94fe <~~a ~~href~~="~~http://xoaifwyqlucb.com/~~">~~xoaifwyqlucb~~</a>	+	==How to show text from a console session==
		+
		+	When showing an interactive console session, please use a leading space in front of every line (to put the session in a little "box" in the article when it renders) and use the triple-singlequote (<nowiki>'''</nowiki>) wikitag to bold user-entered text. For example:
		+
		+	ph34r# '''this is what a console session should look like on the BSDwiki.'''
		+	this: Command not found.
		+	ph34r#