View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0005314 | MMW v4 | Help / Docs / Localization | public | 2009-02-17 22:46 | 2011-05-11 05:08 |
| Reporter | rusty | Assigned To | |||
| Priority | immediate | Severity | feature | Reproducibility | always |
| Status | closed | Resolution | fixed | ||
| Product Version | 3.2.2 | ||||
| Target Version | 4.0 | Fixed in Version | 4.0 | ||
| Summary | 0005314: WebHelp: Switch to web-based help | ||||
| Description | There have been numerous complaints about the fragmentation of documentation into: -Online help -Wiki -Forum -Support Knowledgebase Ideally, MM could switch to a web-based help format (e.g. some sort of wiki) that would allow much of the above to be better integrated, while meeting the following needs: -Support for multiple writers/editors -optional content approval process for non-editor submissions -support for multiple languages / translation -support for discussions | ||||
| Additional Information | http://www.mediawiki.org/wiki/User:Applicationswhisperer#How_to_Build_an_Online_Help_System_using_MediaWiki_on_a_Hosted_Site http://idratherbewriting.com/2010/06/09/using-mediawiki-templates-to-organize-content-organizing-content-13/ http://cmsreport.com/content/2010/03/tutorial-organizing-wiki-content-using-mediawiki http://www.ehartwell.com/InfoDabble/BreadCrumbs2 | ||||
| Tags | No tags attached. | ||||
| Fixed in build | 1370 | ||||
| related to | 0005313 | closed | peke | MMW v4 | Make languages downloadable via the installer |
| related to | 0007655 | closed | rusty | MMW v4 | Missing F1 help pages |
| parent of | 0008418 | closed | petr | MMW v4 | MM3 CHM Help file still included with MM4 installer |
| related to | 0007438 | closed | peke | MMW v4 | Automated download of localization files |
| related to | 0007738 | closed | peke | MMW v4 | Webhelp: French/German help content |
| related to | 0007739 | assigned | peke | MMW v4 | WebHelp: Make template Page that can be used for Translations |
| related to | 0007743 | closed | jiri | MMW v4 | Pressing F1 in German version opens English Help |
| related to | 0007746 | closed | rusty | MMW v4 | Update Web node content for MM4 |
| related to | 0009100 | new | MMW Wishlist | Add option to open Help in new tab in MediaMonkey instead of default browser |
|
|
Would it mean to always show on-line help from MM? What about off-line users? Or would we make some off-line version upon every MM release? |
|
|
This would mean switching entirely to online help (no more help other than context help integrated with MM). I don't think that this is a bad thing, however, we'd need some sort of wiki that's easy to use, has good formatting controls, includes translation tools, and has the appropriate access controls (e.g. limited editors on main help, ability for registered users to add comments). |
|
|
Rather than trying to create a completely new solution, I think that reusing the current Wiki in a smart way might be the best option. We would need to think about a way to handle several versions of the help (due to several versions of MM out in the field). As for localizations, I think that the current wiki would handle this well, for example using namespaces or some similar way. |
|
|
Assigning to Jiri to prepare the technical part of implementation, so that content could be updated later. |
|
|
Fully implemented in MM in build 1365. - Pressing F1 redirects user to a web page: http://www.mediamonkey.com/wiki/WebHelp:{pageID}/{versionMajor}.{versionMinor}/{language} , for example http://www.mediamonkey.com/wiki/index.php/WebHelp:Exploring_Tracks/4.0/de - Note that '/en' isn't used for English help pages, since it's the default wiki language - I also completely got rid of Windows HTML help in MM, so also the tooltips created by clicking the '?' icon e.g. in Options dialog is now created using our internal tootip 'bubble'. |
|
|
From Jiri: There are few things we need to finish in order to have this fully working: 1. Move the content to the Wiki. In order to move html to the wiki I found the following most useful: 1a. Replace by ' ' in the source html. 1b. Use http://labs.seapine.com/htmltowiki.cgi to convert the html to wiki markup. 1c. Copy the result to the correct wiki page (the same name as they currently have in the html help), then update links, upload pictures and add header and footer as: {{WebHelpHeader|Navigating Your Collection}} {{WebHelpFooter}} 2. Russell to update content for MM4. 3. Wiki template should be updated so that: 3a. It's better integrated to our web. 3b. Some parts of wiki are removed for non-logged in users (e.g. Toolbox, History, etc.) Peke, can you please take care of item 1 and then re-assign to me? |
|
|
I have hard time to use http://labs.seapine.com/htmltowiki.cgi I'll see if there is better translator of MSHTML to Wiki syntax |
|
|
I think it is very bad idea to completely discard the help file. You should keep at least the last file which you had before (Help Content), and add one new item in Help menu which could link to the Web page, e.g. with the "Oh-Line Help" caption or something similar. |
|
|
Peke, I don't think it makes sense to spend time on looking for anything else, after all the converter works pretty well and some manual tweaks of the results will be needed in any case. Zvezdan, I think that users (particularly non English) will benefit from constantly community updated help. We could consider adding an off-line copy of the wiki pages to the installer based on the feedback though. |
|
|
There are many users which don't have always-on Internet connection. There are users which have MM installed on some HTPC or similar dedicated computer which is not connected to the Internet. There are users (including myself) which hate slow opening of some Web browser and connecting to some site, which is definitely much slower then opening of the help file within the Windows Help application. You should keep at least the help file with the Reference section. I am particularly interested in the table with supported tags for different audio formats, and the table of the available mask's tags like <Artist>, <Folder> and others. |
|
|
My Firefox AddBlock Plus has blocked usage of Converter but this one looks even better http://toolserver.org/~magnus/html2wiki.php or http://www.uni-bonn.de/~manfear/html2wiki-tables.php especially on Tables. I've started working on HTML2Wiki with several pages and have done tests using http://www.mediamonkey.com/wiki/index.php/Sandbox not sure that I'm satisfied with results completely but like you pointed it should work except for those that do not have Internet connection. I would rather do approach like PHP has done http://php.net/download-docs.php or MySQL http://dev.mysql.com/doc/ or even how we have done for Languages to download on Install (Download/Install on first use) which most apps use without problem. Additional Info: http://goessner.net/articles/wiky/ http://support.microsoft.com/kb/917607 http://deadlytechnology.com/web-development/chm-files-not-working/ http://weblog.helpware.net/?p=36 http://www.mywindowsclub.com/resources/4302-How-open-chm-file-Windows.aspx |
|
|
I agree with Zvezdan's comment that _some_ content (esp. the info re. masks) should be included with the product, but am not sure how to manage that... perhaps for 4.1... Any ideas? |
|
|
Reminder sent to: jiri Any thoughts about this? |
|
|
All should be corrected and updated now http://www.mediamonkey.com/wiki/index.php/WebHelp You can update it for MM4 Additionally I have made Wiki Page http://www.mediamonkey.com/wiki/index.php/Mp3-ogg-wma-audio-faq to Replace old http://www.mediamonkey.com/mp3-ogg-wma-audio-faq.htm in http://www.mediamonkey.com/wiki/index.php/Help:Contents If you encounter any Red links send me reminder |
|
|
re-assigned to Pavle to add French/German help content. |
|
|
Also, I just tried out the online help and it doesn't seem to be working in most cases. e.g. F1 on Party Mode --> http://www.mediamonkey.com/wiki/index.php/WebHelp:Protecting_Your_Library_with_Party_Mode/4.0 But the actual page is at: http://www.mediamonkey.com/wiki/index.php/Protecting_Your_Library_with_Party_Mode F1 on Now Playing --> http://www.mediamonkey.com/wiki/index.php/WebHelp:Now_Playing/4.0 But the actual page is at: http://www.mediamonkey.com/wiki/index.php/Now_Playing F1 on Volume leveling --> http://www.mediamonkey.com/wiki/index.php/WebHelp:Volume_Leveling/4.0 But the actual page is at: http://www.mediamonkey.com/wiki/index.php/Volume_Leveling etc... Can you please fix and verify all the links for the english help |
|
|
Bad F1 pages recreated and updated DE and FR help pages tracked under 0007738 I created as noted http://www.mediamonkey.com/wiki/index.php/WebHelp so that it can be used as template for other languages and now tracked in 0007739 |
|
|
Reopening: On any given page, if there are links to other pages, the links don't include the version information e.g. http://www.mediamonkey.com/wiki/index.php/WebHelp:Exploring_Tracks/4.0 links to http://www.mediamonkey.com/wiki/index.php/Library instead of linking to http://www.mediamonkey.com/wiki/index.php/Library/4.0. Additionally, won't the 'Template' page cause problems? e.g. spiders will archive it and users will accidentally read it instead of the actual help file; users may accidentally edit it instead of the English file; users will translate it instead of the English source file. |
|
|
Peke, I'm not sure why the 'Template' pages are there? The specification was only about pages that have Version and Language (except for English) specification in their title. |
|
|
Rusty, They can be easily removed But I would rather find the way so that when Russin user press F1 which redirects page to http://www.mediamonkey.com/wiki/index.php/WebHelp:Exploring_Tracks/4.0/ru template would be loaded instead of Empty page which will then allow translator to start translating. Re links: I'm trying to figure out if {{WebHelplinks| Internal Wiki Page link}} can be used to fill correct link page instead of currently manually editing each link which needs to correctted as Rusty pointed. Jiri, Without template pages I would need to do F1 in MM prior to editing article it just speed process of translation currently and can be removed afterwards or made into Real context page. eg. http://www.mediamonkey.com/sw/webhelp/frame/mediamonkey_content_dyn.html from http://www.mediamonkey.com/sw/webhelp/frame/index.html when all pages are done. |
|
|
Peke, just to clarify, I don't have anything about Content pages (like http://www.mediamonkey.com/wiki/index.php/WebHelp:Content/4.0), but I don't understand why does e.g. http://www.mediamonkey.com/wiki/index.php/Library exist - only http://www.mediamonkey.com/wiki/index.php/WebHelp:Library/4.0 should exist. |
|
|
Jiri, http://www.mediamonkey.com/wiki/index.php/WebHelp:Content/4.0 is called when in MM you click help -> Help Content even it is not formatted correctly Currently it is used for easier access to Translated pages. http://www.mediamonkey.com/wiki/index.php/Library and other pages exist and were created until we add editing restriction as backup pages for actual help and that is why they are added in http://www.mediamonkey.com/wiki/index.php/WebHelp:Content/4.0 and backupped in http://www.mediamonkey.com/wiki/index.php/WebHelp |
|
|
Peke, fyi, the issue that I noted at comment 24885 is still not resolved. |
|
|
1. WebHelp Content Page (English) is correctly Formatted now - http://www.mediamonkey.com/wiki/index.php/WebHelp:Content/4.0 - Within MM using Help -> Help Content 2. Only issue from Rusty comment 24885 needs to be fixed |
|
|
2. I created simple Template http://www.mediamonkey.com/wiki/index.php/Template:WebHelp:Links {{WebHelp:Links| pageID}} that will correctly fill Version+Language code eg. "WebHelp:{pageID}/{versionMajor}.{versionMinor}/{language}" See. http://www.mediamonkey.com/wiki/index.php/WebHelp:Exporting_Tracks/4.0 for link examples NOTE: Currently It checks for MM 4.0 only |
|
|
All fixed 1370 NOTE: Rusty, Jiri Leave as Resolved or open new bug Where we will Document on how new language translations would start and where we will explain Wiki Templates that we created along with their usage. |
|
|
Tested build 1370 with the help as of today, and it's looking pretty good, though the following issues remain: 1) All the links at the following locations are dead: http://www.mediamonkey.com/wiki/index.php/WebHelp:Introduction/4.0 2) http://www.mediamonkey.com/wiki/index.php/WebHelp:Configuring_Directory_and_File_Formats/4.0 is missing content--instead it seems to link to a template file 3) The TOC should reference all pages--e.g. currently the following page doesn't appear is the TOC. Are there any other such pages? http://www.mediamonkey.com/wiki/index.php/WebHelp:Setting_UPnP/DLNA_Media_Servers/4.0 http://www.mediamonkey.com/wiki/index.php/WebHelp:Playback_Rules/4.0 |
|
|
1 and 2 fixed 3) should be moved to new bug as those pages are related to MM 4.0 Help Not MM 3.2.5 current help is online |
|
|
Verified. |
