Bug 185041

Summary: HTML rendering: replaceable elements are not distinguished
Product: Documentation Reporter: Warren Block <wblock>
Component: Books & ArticlesAssignee: Gabor Kovesdan <gabor>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Warren Block freebsd_committer freebsd_triage 2013-12-20 18:00:00 UTC 
Replaceable elements were formerly shown in italic to indicate to the user that they should be replaced.  The current HTML does not do this.  Example:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/book.html#preface-conventions

In the line that says "man -k keyword", keyword should be in italic.  The HTML source does not make "keyword" a separate class:

<code class="command">man -k
		  keyword</code>

How-To-Repeat: View http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/book.html#preface-conventions
Comment 1 Warren Block 2013-12-21 01:13:20 UTC 
Further info: this problem seems to be limited to <replaceable> tags 
inside <command> tags.
Comment 2 dfilter service freebsd_committer freebsd_triage 2014-01-22 10:07:25 UTC 
Author: gabor
Date: Wed Jan 22 10:07:19 2014
New Revision: 43623
URL: http://svnweb.freebsd.org/changeset/doc/43623

Log:
  - Mark a command part as replaceable
  
  PR:		docs/185041
  Submitted by:	wblock

Modified:
  head/en_US.ISO8859-1/books/fdp-primer/book.xml

Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/book.xml	Tue Jan 21 23:41:48 2014	(r43622)
+++ head/en_US.ISO8859-1/books/fdp-primer/book.xml	Wed Jan 22 10:07:19 2014	(r43623)
@@ -181,7 +181,7 @@ The time is 09:18</screen></entry>
 
 	      <entry>To search for a keyword in the manual pages, type
 		<command>man -k
-		  keyword</command></entry>
+		  <replaceable>keyword</replaceable></command></entry>
 	    </row>
 
 	    <row>
_______________________________________________
svn-doc-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"
Comment 3 Gabor Kovesdan freebsd_committer freebsd_triage 2014-01-22 10:28:17 UTC 
State Changed
From-To: open->closed

I have fixed this case, thanks! Unfortunately, some other replaceable elements 
may have been lost in the DB5 conversion.
Comment 4 Gabor Kovesdan freebsd_committer freebsd_triage 2014-01-22 10:28:17 UTC 
Responsible Changed
From-To: freebsd-doc->gabor

I have fixed this case, thanks! Unfortunately, some other replaceable elements 
may have been lost in the DB5 conversion.