Community
Participate
Working Groups
Documentation should be available as Ecilpse help, and context help should also be configured. Please review https://textile-j.dev.java.net/source/browse/*checkout*/textile-j/branches/mylyn.wikitext/java/org.eclipse.mylyn.wikitext.ui/help/Mylyn%20WikiText%20User%20Guide.textile
The WikiText guide shows up in the Eclipse help and is now automatically generated as part of the build. I have created bug 242981 to move it under the Mylyn node.
To generate the user guide run build-helper.xml as an Ant Build from Eclipse. If you launch a runtime workspace the user guide will appear under the Mylyn node in the Eclipse help.
David: Please go ahead and add this as you see fit. We'll just update the docs accordingly with any restructuring (bug 246387). If you're making major changes or additions just holler to get input berfore doing so.
(In reply to comment #3) > David: Please go ahead and add this as you see fit. We'll just update the docs > accordingly with any restructuring (bug 246387). If you're making major changes > or additions just holler to get input berfore doing so. Mik, no problem. If I understand you correctly this means that I'll be committing in the @org.eclipse.mylyn.help.ui@ project. Please confirm that this is what you meant.
There are a couple of issues that need fixing, either in the MediaWiki source or in the WikiText parser: * In the user guide source there is a comment that starts with @<!---@ and ends with @--->@: these should be modified as follows: @<!--@ and @-->@ (one less '-') * Some lines in the user guide start with a single space. According to the MediaWiki documentation this indicates preformatted text. Either the user guide source should be updated, or perhaps we're detecting these cases incorrectly in the WikiText parser. * Links are problematic. In the user guide we link using [[Mylyn FAQ]] and [[Mylyn_FAQ]], but WikiText is resolving this to http://wiki.eclipse.org/Mylyn/Mylyn_FAQ when in fact it should be http://wiki.eclipse.org/Mylyn/FAQ. I'm not sure if this is a bug with WikiText or a problem with the way the links are expressed in the user guide. * There are a few broken images
Please feel free to fix any errors like the malformed HTML comments or the extraneous spaces. Regarding the FAQ [[Mylyn FAQ]], [[Mylyn_FAQ]] and [[Mylyn/FAQ]] should all be valid links. The page was originally located at Mylyn_FAQ but later moved to Mylyn/FAQ and is now a redirect. It seems that MediaWiki replaces spaces by underscores in internal links. We can standardize on a single convention for linking (e.g. [[Mylyn/FAQ]]) if that helps
(In reply to comment #6) > Please feel free to fix any errors like the malformed HTML comments or the > extraneous spaces. Will do > Regarding the FAQ [[Mylyn FAQ]], [[Mylyn_FAQ]] and [[Mylyn/FAQ]] should all be > valid links. The page was originally located at Mylyn_FAQ but later moved to > Mylyn/FAQ and is now a redirect. It seems that MediaWiki replaces spaces by > underscores in internal links. We can standardize on a single convention for > linking (e.g. [[Mylyn/FAQ]]) if that helps that makes sense to me now. The [[Mylyn/FAQ]] link looks like it would be the best option. Or would just [[FAQ]] work? Is there a way to test out these changes without making them instantly 'live' and visible to everyone?
I've made some minor changes to the online User Guide of Mylyn as follows: > * In the user guide source there is a comment that starts with @<!---@ and ends > with @--->@: these should be modified as follows: @<!--@ and @-->@ (one less > '-') fixed > * Some lines in the user guide start with a single space. According to the > MediaWiki documentation this indicates preformatted text. fixed also in several areas <code> tags were present before preformatted text, which resulted in malformed XML as follows bc.. <p> <code> </p> <pre> ... </pre> <p> </code> </p> p. removed these <code> tags. Also updated build-helper.xml to validate generated eclipse help (HTML ) content to verify that it's all well-formed XML, so that we don't see runtime errors when viewing the help (Eclipse parses these files at runtime)
Created attachment 114154 [details] mylyn/context/zip
Excellent! We still have to review the contents before putting it into the distribution (bug 246387).
(In reply to comment #10) > We still have to review the contents before putting it into the distribution (bug 246387). hmm... this seems contrary to Mik's instructions: (In reply to comment #3) > David: Please go ahead and add this as you see fit. do we really have to wait?
(In reply to comment #6) > We can standardize on a single convention for linking (e.g. [[Mylyn/FAQ]]) if that helps I've taken a look and [[Mylyn/FAQ]] looks to be the best option for WikiText. It will make it easy to detect links that are in a specific space in the wiki.
(In reply to comment #6) > We can standardize on a single convention for linking (e.g. [[Mylyn/FAQ]]) if that helps Updated all Mylyn internal wiki links to use the [[Mylyn/Page_Name]] convention. Tested these links, looks good. Generated Eclipse help content now resolves these links correctly.
(In reply to comment #11) > (In reply to comment #10) > > We still have to review the contents before putting it into the distribution > (bug 246387). > > hmm... this seems contrary to Mik's instructions: > > (In reply to comment #3) > > David: Please go ahead and add this as you see fit. > > do we really have to wait? Sorry, I missed that comment. To clarify, I was just referring to the Mylyn user guide. I think we should take at least one pass through the contents to make sure the guide does not contain false information before redistributing it as part of the Mylyn help plug-in. Mik, are you okay with committing the current state of the Mylyn user guide to cvs?
(In reply to comment #14) > I think we should take at least one pass through the contents to make > sure the guide does not contain false information before redistributing it as > part of the Mylyn help plug-in. I see your point, but we should also consider that users still have access to that content. In fact, they're pointed to it from the current Mylyn help plug-in.
nothing left to do here.
