Bug 134763

Summary: [handbook] [patch] Varying filename example is not included in <replaceable> element
Product: Documentation Reporter: Benedict Reuschling <bcr>
Component: Books & ArticlesAssignee: Benedict Reuschling <bcr>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Benedict Reuschling 2009-05-20 21:00:07 UTC 
The multimedia-section in the FreeBSD handbook about MP3 Audio lists the following example:

<screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0</replaceable> Foobar-GreatestHits.mp3</userinput> ...

Since "Foobar-GreatestHits.mp3" can be replaced by other filenames, it should be included in the preceding <replaceable> element.

Fix: Apply the attached patch that moves the "Foobar-GreatestHits.mp3" within the <replaceable> element.

Patch attached with submission follows:
How-To-Repeat: Look at the handbook section "7.3.1 MP3 Players" of doc/en_US.ISO8859-1/books/handbook/sound-mp3.html and guess what other .mp3 files you could use instead of Foobar-GreatestHits.mp3 :-) 
Therefore, it is a <replaceable> filename and should be typeset accordingly.
Comment 1 Benedict Reuschling freebsd_committer freebsd_triage 2009-06-05 21:12:56 UTC 
Responsible Changed
From-To: freebsd-doc->bcr

I will take this one.
Comment 2 dfilter service freebsd_committer freebsd_triage 2009-06-17 19:02:03 UTC 
bcr         2009-06-17 18:01:54 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/multimedia chapter.sgml 
  Log:
  Fix the section about MP3 audio:
  
  - use <devicename> for /dev/dsp1.0
  - wrap the FooBar-GreatestHits.mp3 example in <replaceable>
  - move the explanation before the sample screen output.
  
  PR:             docs/134763
  Approved by:    jkois (mentor)
  
  Revision  Changes    Path
  1.132     +5 -7      doc/en_US.ISO8859-1/books/handbook/multimedia/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 3 Benedict Reuschling freebsd_committer freebsd_triage 2009-06-17 19:16:11 UTC 
State Changed
From-To: open->closed

Fixed by the commit above. Thanks!