Bug 863 - Names of topics when printing (1GF9Y3Q)
Summary: Names of topics when printing (1GF9Y3Q)
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 2.0   Edit
Hardware: All Windows 2000
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: John Wiegand CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-10-10 21:49 EDT by Dorian Birsan CLA
Modified: 2007-05-28 11:38 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Dorian Birsan CLA 2001-10-10 21:49:09 EDT
The name displayed in the Eclipse Help perspective for a given topic
isn't shown anywhere on the printed page.

1) Print a topic
2) The name displayed when browsing the tree doesn't show up anywhere on the page.

NOTES:

	MM (6/13/2001 3:40:04 PM)
		A good example of this is Platform Plug-In Developers Guide -> Workbench ->
		Property View. The title of the HTML page is "Desktop - Property Sheet Example"
		(which appears at the top of the printed page), and has a large title in the body
		of the HTML reading "Example - Property Sheet". Nowhere on the paper does it
		say "Property View".

	KK (2001-06-14 10:01:27)
		It is up to the ID authors to label the topic appropriately in the tree.
		The label might match the document title, which should be contained
		within a body document (help does not expose the title),
		or might be completely different, and make sense only in the tree
		contexts
		Ex. 3 consequtive topics labeled: "Exporting Project", "on Windows",
		and "on Linux".  It does not make sense to use these labels when
		topic does not appear in the context.  We use them hovewer,
		in the table of contents, when printing topic sub tree.
		The printing solution is not perfect, but we are not going to redesign
		it for this version.

	MF (6/14/01 11:13:18 AM)
		Just to make things clear here. The table of contents printed is the tree that you see
		in the left navigation view. Since the help system code does not rely on nor display the title
		of a page, the title of the page often should be the actual title in the tree.
		If we revisit printing, then this might change.
Comment 1 DJ Houghton CLA 2001-10-24 06:27:20 EDT
PRODUCT VERSION:
0.122

Comment 2 Dorian Birsan CLA 2002-04-22 14:26:50 EDT
This is a documentation issue. All topics should have their <title> shown 
(maybe as an <h1>) on the page.
Comment 3 Mike Wilson CLA 2007-05-28 11:38:22 EDT
I believe this is bug is stale. There does not seem to be any pervasive problem w.r.t. page titles not matching, and the particular example mentioned by MM has been improved (the link from the parent is now "Platform Plug-in Developer Guide > Examples Guide > Workbench > Property Sheet" and the page title is "Example - Property Sheet" which seems fine to me).

Please open specific bugs for any new problems that arise.