On Wed, Sep 19, 2012 at 12:14 PM, Boggess, Rod <rbogg...@tenovacore.com> wrote: > A few questions about the documentation:
Sorry for the late replies > > 1) Nautilus scripts no longer work in Ubuntu 12.04 – even the PPA for > TortoiseHg-Nautilus generates errors. Are there plans to fix this? I ask > because I’m going to be documenting the context menu popups and I want to > know if I should mention that these only work in Explorer on Windows (and > not in Nautilus on Linux). No one is maintaining the nautilus extension, I am tempted to remove it until a maintainer appears, just to stop it from being packaged any more. > 2) The only context help link available is on the Workbench which > correctly points to 5.4. Can someone add a context menu link to section 4.0 > for the Explorer Context (popup) Menu? I believe it would be enough to add > one context menu help link, rather than a separate link on each context menu > popup dialog, but if someone wanted to go crazy, I could ensure that a link > existed for each of those, too. I think 5.2 would be a better link. I have a local patch which adds this. > 3) I keep reading hints that Sphinx and Docutils can “extract > documentation out of my python code.” Is this extraction the origin of the > source text files? In short, should I be looking inside of the python code > modules to update the doc comments inside of the code, instead of updating > the text files (which will be summarily overwritten the next time someone > extracts the comments from the python code)? No, we don't maintain any documentation within the Python code. This would only be useful if TortoiseHg were being provided as a Python library. > 4) I saw a TODO list in the docs folder, and although I don’t really > understand the tasks, should I be focusing my energies on addressing those > as priority issues before moving on to the expansion of MQ, context menu, > and workbench documentation? Work on whatever you like. > 5) Lastly, does anyone here have a recommendation for where I can get > the following question answered: > > `Table of Contents`_ takes me to the ToC anchor in the current page. > :doc:`faq` takes me to the FAQ document in the set. But how do I combine > these two so I can go to a bookmark within another document in the set? I > want to generate the equivalent HTML 5 of a fragid within a relative URL > location. In other words, if I were in faq.html, and I wanted to create a > clickable anchor that took me to <h2 id=’ToC’>Table of Contents</h2> in the > index.html page, I would use, > > <a href=”index.html#ToC”>See Table of Contents</a> for more information. > > How do I do the equivalent in restructured text? (I need to know how to mark > the fragid as well as how to reference the bookmark with #ToC.) > > I’ll continue to look > http://packages.python.org/an_example_pypi_project/sphinx.html#table-of-contents, > http://docutils.sourceforge.net/rst.html, > http://docutils.sourceforge.net/docs/user/rst/quickref.html, and > http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt, but it would > help a lot if I knew what to search for within these documents (or in > Google). I’m just too stupid to know what these bookmarks are called in > restructured text parlance. I don't know if I ever found a reliable way to do this. -- Steve Borho ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ _______________________________________________ Tortoisehg-develop mailing list Tortoisehg-develop@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/tortoisehg-develop
