Difference between revisions of "Help talk:Editing"

From ThinkWiki
Jump to: navigation, search
(Better place for this...)
 
(Wiki-formatting blocks of text from files)
Line 4: Line 4:
  
 
--[[User:gsmenden|gsmenden]]  24 May 2006 01:16 (EST)
 
--[[User:gsmenden|gsmenden]]  24 May 2006 01:16 (EST)
 +
 +
== Wiki-formatting blocks of text from files ==
 +
 +
Is there a convention or established best way to format a larger block of text that's used for displaying the contents of a file - for example, when documenting a configuration file or instructing the reader to enter a block of text into an editor?
 +
 +
An example of what I'm talking about:
 +
 +
<blockquote><code><pre><nowiki>Section "Screen"
 +
Identifier "Default Screen"
 +
Device "Intel Corporation Mobile Integrated Graphics Controller"
 +
Monitor "Generic Monitor"
 +
DefaultDepth 24
 +
SubSection "Display"
 +
Depth 24
 +
Modes "1024x768"
 +
EndSubSection
 +
EndSection</nowiki></pre></code></blockquote>
 +
 +
-- [[User:Midorigin|Midorigin]] 23:36, 1 December 2006 (CET)

Revision as of 23:36, 1 December 2006

In general, what is the prevailing philosophy on removing out of date information? Regarding the fglrx page, a lot of the stuff is regarding historical patches for old driver versions, and really ceases to be useful now. Nevertheless, there is possibly a rare situation where a person constrained to an older kernel / driver for hardware issues would need to reference this stuff. I guess the person could always dig through the diffs to find out what has happened in the past.

I think a moderate pruning approach is best, where really arcane / historical issues are simply deleted, and anything a user might realistically run into can be briefly summarized...

--gsmenden 24 May 2006 01:16 (EST)

Wiki-formatting blocks of text from files

Is there a convention or established best way to format a larger block of text that's used for displaying the contents of a file - for example, when documenting a configuration file or instructing the reader to enter a block of text into an editor?

An example of what I'm talking about:

Section "Screen"
	Identifier	"Default Screen"
	Device		"Intel Corporation Mobile Integrated Graphics Controller"
	Monitor		"Generic Monitor"
	DefaultDepth	24
	SubSection "Display"
		Depth		24
		Modes		"1024x768"
	EndSubSection
EndSection

-- Midorigin 23:36, 1 December 2006 (CET)