Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 422081

Summary:	User_Guide/Getting_started/Getting-started.html has many broken links
Product:	[ECD] Orion	Reporter:	Adrian Aichner <adrian.aichner>
Component:	Doc	Assignee:	John Arthorne <john.arthorne>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	ken_walker
Version:	5.0
Target Milestone:	5.0 M1
Hardware:	PC
OS:	Windows XP
Whiteboard:

Description Adrian Aichner

2013-11-19 12:19:50 EST

org.eclipse.orion.client/doc/org.eclipse.orion.doc.user/WikiDoc/Orion/Documentation/User_Guide/Getting_started/Getting-started.html

has source fragments like this:
			<li>In any Orion page, clicking on the 
				<a href="Navigation">Menu</a>
				<a href="Main">Pages</a>
				<a href="Search">Search</a> link will bring up the search page with the global scope. The search page will search all the files without a scope.
			</li>

It seems the general pattern wrong, where
				<a href="Navigation">Menu</a>
should instead be something like
				<a href="ACTUAL_LINK">Navigation Menu</a>

Are there any developer tools in use to update these documentation sections?

Comment 1 Adrian Aichner

2013-11-19 12:24:44 EST

Will edits of
http://wiki.eclipse.org/Orion/Documentation/User_Guide/Getting_started#Searching_for_file_content
automatically make it into above file?

Is there a document about those mechanisms, if any?

Comment 2 Ken Walker

2013-11-19 12:48:37 EST

Yes, documentation to the main Wiki pages will make it into the built in documentation.  

There's some info here:  http://wiki.eclipse.org/Orion/Documentation

Comment 3 John Arthorne

2013-11-19 16:16:41 EST

This looks like a doc generation bug to me. It is probably getting fooled by the illegal > characters in the wiki source.

Comment 4 John Arthorne

2013-11-19 16:17:17 EST

I will take an initial look to see where the problem lies.

Comment 5 Adrian Aichner

2013-11-19 16:42:32 EST

Thanks for the link, Ken.

(In reply to John Arthorne from comment #4)
> I will take an initial look to see where the problem lies.

John, I found the Mylyn FAQ to contain a good blend of
→
>
->
itself.

See
http://wiki.eclipse.org/Mylyn/FAQ#Which_Focused_UI_features_can_I_turn_off.3F

Comment 6 John Arthorne

2013-11-21 17:07:28 EST

I regenerated the doc and the errors went away without even having to change the wiki source. Maybe it was a bug in wikitext converter that has been fixed. I updated the wiki to change > to &gt; anyway just to be on the safe side.