Difference between revisions of "PC-BSD Wiki talk:Style Guidelines"

From PC-BSD Wiki
Jump to: navigation, search
(Created page with "This page may eventually get so large that it might need to be refined. It should eventually be used to create some examples, like the stub page, to partially replace some of...")
 
(needed markup for lists: new section)
Line 2: Line 2:
  
 
Perhaps a specialized template that could be called, which automatically highlights within its content, the portions referenced as examples. In this way, the example page could be extremely inclusive with built-in context to help clarify. This is starting to sound like a very cool idea. :)
 
Perhaps a specialized template that could be called, which automatically highlights within its content, the portions referenced as examples. In this way, the example page could be extremely inclusive with built-in context to help clarify. This is starting to sound like a very cool idea. :)
 +
 +
== needed markup for lists ==
 +
 +
Once ("official") again:
 +
 +
[http://wiki.pcbsd.org/index.php?title=PC-BSD_Wiki:Style_Guidelines#Lists&oldid=13709 Style Guidelines (of our PC-BSD Wiki) are telling for lists], that we need a ''[[wikipedia:Hard return|hard enter]]'' to ensure that the PDF and EPUB versions format correctly.
 +
 +
Does this count only for "unordered" lists? A [http://wiki.pcbsd.org/index.php?title=PC-BSD_Wiki%3AStyle_Guidelines&action=historysubmit&diff=13704&oldid=13703 change for a numbered list] does not include ''[[wikipedia:Hard return|hard enters]]''.
 +
 +
Does anyone can check the result of the PDF and EPUB versions for it? Probably it does not format correctly, because they are also items (like for normal bullet), or not?
 +
 +
Maybe a [[wikipedia:Help:Wiki markup#Line breaks|<code><nowiki><br></nowiki></code>]] at the end of every (without the last) item would help (enough). (BTW: [http://wiki.pcbsd.org/index.php?title=PC-BSD_Wiki%3AStyle_Guidelines&action=historysubmit&diff=13739&oldid=13736 I did such a change preliminary.])
 +
 +
Here my example (as an offer) for the section [[PC-BSD Wiki:Style Guidelines#Bullets | Bullets]]:
 +
 +
<pre>
 +
To ensure that the PDF and EPUB versions format correctly, use a additional [[wikipedia:Help:Wiki markup#Line breaks|<code><nowiki><br></nowiki></code>]] between the items in a list.
 +
 +
== Bullets ==
 +
 +
There are two types of bullets in use:
 +
# A bulleted list which begins uppercase. Whether or not it ends in punctuation depends upon the size of the list. For example:<br>
 +
#* the [[What's New in 9.1]] list uses sentences to describe the features so ends in a period. Use this type of list when the list includes a description large enough to warrant at least one sentence.<br>
 +
#* the [[Minimum Hardware Requirements]] list uses few words per item. Since the individual items do not warrant a sentence, this type of list does not end in a period.<br>
 +
# A  bulleted list which begins with bolded text (typically the name of a menu item). The bolded section is capitalized to match the name of the menu item and followed by a colon (:). The sentence following the colon begins lowercase and should be worded so that the bolded item is the beginning of the sentence. An example is:<br>
 +
#: '''Size on Disk:''' indicates the amount of space being used by the jail.<br>
 +
#:: In this example, the menu item appears as "Size on Disk" (mix of upper/lowercase), "indicates" is lowercase and is worded so that it reads as one sentence (including the name of the menu item). Because it is a sentence, it ends with a period.
 +
</pre>
 +
 +
"in terms of collegiality"
 +
 +
-- [[User:Vater|Rg]] 11:55, 12 July 2012 (PDT)

Revision as of 11:55, 12 July 2012

This page may eventually get so large that it might need to be refined. It should eventually be used to create some examples, like the stub page, to partially replace some of the content here.

Perhaps a specialized template that could be called, which automatically highlights within its content, the portions referenced as examples. In this way, the example page could be extremely inclusive with built-in context to help clarify. This is starting to sound like a very cool idea. :)

needed markup for lists

Once ("official") again:

Style Guidelines (of our PC-BSD Wiki) are telling for lists, that we need a hard enter to ensure that the PDF and EPUB versions format correctly.

Does this count only for "unordered" lists? A change for a numbered list does not include hard enters.

Does anyone can check the result of the PDF and EPUB versions for it? Probably it does not format correctly, because they are also items (like for normal bullet), or not?

Maybe a <br> at the end of every (without the last) item would help (enough). (BTW: I did such a change preliminary.)

Here my example (as an offer) for the section Bullets:

To ensure that the PDF and EPUB versions format correctly, use a additional [[wikipedia:Help:Wiki markup#Line breaks|<code><br></code>]] between the items in a list.

== Bullets ==

There are two types of bullets in use:
# A bulleted list which begins uppercase. Whether or not it ends in punctuation depends upon the size of the list. For example:<br>
#* the [[What's New in 9.1]] list uses sentences to describe the features so ends in a period. Use this type of list when the list includes a description large enough to warrant at least one sentence.<br>
#* the [[Minimum Hardware Requirements]] list uses few words per item. Since the individual items do not warrant a sentence, this type of list does not end in a period.<br>
# A  bulleted list which begins with bolded text (typically the name of a menu item). The bolded section is capitalized to match the name of the menu item and followed by a colon (:). The sentence following the colon begins lowercase and should be worded so that the bolded item is the beginning of the sentence. An example is:<br>
#: '''Size on Disk:''' indicates the amount of space being used by the jail.<br>
#:: In this example, the menu item appears as "Size on Disk" (mix of upper/lowercase), "indicates" is lowercase and is worded so that it reads as one sentence (including the name of the menu item). Because it is a sentence, it ends with a period.

"in terms of collegiality"

-- Rg 11:55, 12 July 2012 (PDT)