wblock
Documentation Engineer
- Joined
- Nov 14, 2014
- Messages
- 1,506
Now that the code tag has been added, I have a suggestion for a couple more that have been useful on the FreeBSD Forums.
The first is cmd. Text formatted with this tag is shown with a dark background. It is meant for showing commands without having to explain where they begin or end, or having to say "but not the quotes". Example:
The other one is file. This one is useful for showing filenames. It uses a green foreground. This too, helps in not having to say "but not the quotes". Example:
These are easy to add. The only problem we have had in the FreeBSD Forums is that people want to use cmd for everything, and code is still needed to preserve indenting and formatting. cmd is really just for single lines, inline with sentences.
Even if new users don't use these tags, they make it easier for experienced users to be unambiguous about what they are saying.
What do you think?
The first is cmd. Text formatted with this tag is shown with a dark background. It is meant for showing commands without having to explain where they begin or end, or having to say "but not the quotes". Example:
The other one is file. This one is useful for showing filenames. It uses a green foreground. This too, helps in not having to say "but not the quotes". Example:
These are easy to add. The only problem we have had in the FreeBSD Forums is that people want to use cmd for everything, and code is still needed to preserve indenting and formatting. cmd is really just for single lines, inline with sentences.
Even if new users don't use these tags, they make it easier for experienced users to be unambiguous about what they are saying.
What do you think?