Maybe it is just me, but I often have a hard time to understand and navigate
Sphinx based documentation, because the Table Of Contents only shows the
structure of the current page (in the standard themes at least).
There is also a previous and next, but what I really would like to see is
a TOC in the sidebar that shows all parts, with the current part expanded.
For example the main page (i.e. index.rst) would be 'Overview' and opened by
default. Introduction and Quickstart are Sections of index.rst:
Overview
Introduction
Quickstart
Credits
Tutorial
Contribute
Index
API
Search
'Tutorial' would be offered as next.
When the 'Contribute' item is selected, the TOC is updated like so:
Overview
Tutorial
Contribute
Install for development
Style Guide
Index
API
Search
Search, Index, API should link to the generated pages, that are typically
inserted like this in the Sphinx tutorials:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Is there a simple way to achieve this on Read the Docs,
or can anyone point to existing templates?
Related
I am using the Sphinx document generator to create documentation for one of my apps. When I search for some text that is in the documentation, it appears in the search results page, but the sub-section (----) in which it appears is not displayed in the search results. In examples online, the sub-section does display, e.g.,:
For me, only the main section displays:
I think that Sphinx does not index sub-sections. The example I showed, that has sub-sections in the search results, uses ReadTheDocs.
I have a lot of ASCII docs at different locations and I want to create an index page which should render these documents. But the condition here is that I want to list all the document link on the index page and if the user clicks on any link then only the document should be displayed. I don't want to display the documents below the table of content. I just want to display the table of content on the index page.
Is there any way to do this?
If I understand you correctly, you wish to generate a multi-document website, but you want an index page that displays just the TOC, with the other documents served elsewhere. I believe the best way to get this effect would be to generate chunked XHTML output using the DocBook toolchain. I believe this should be possible with Asciidoctor tools, but I have only implemented this particular post-rendering toolchain with the original (Python-based) AsciiDoc rendering tool, as documented here. This setup is configurable to generate a TOC index page that links to chunked output (you can configure the level of chunking).
As you have already figured out, AsciiDoc's automated TOC generation only works on the present document, which requires including the subordinate document to get their headings for the TOC. I can think of ways to sort of game this, such as to include just the heading of the included document (include::path/to/document.adoc[lines=1]) and then hiding even those headings with CSS or something. The problem is, the links in the TOC will be pointing internally, so you'd need to handle that somehow.
Another way is to use any of the static-site generators that support or can be readily extended to support AsciiDoc. What you're talking about is not an out-of-the-box feature that I'm aware of, but they all at least make it possible to generate an organized TOC-type navigation.
Our company has an internal wiki powered by MediaWiki. We are planning to create a wiki page to post some operational data in the form of graphs. Im wondering is it possible to create the following in the wiki page?
Create combo boxes like frequency of data (last month/last quarter)
Create button to generate graph
If possible a calendar to select data range
A dynamically generated graph based on the above filters
Does wiki pages allow creation of these objects and generation of graphs based on the filters dynamically? Any references to do this is highly appreciated.
You can do this with a custom-built extension. See Extension: Wiretap as an example (the source code is on GitHub). Basically you query the database using PHP and add it into the HTML source. Then you can use JavaScript to plot with d3.
(Nearly) Interactive graphs are possible with MediaWiki, but only, if you install the Graph extension, which is a bit more difficult to work with. However, there are some good tutorials and demos on the linked extension page and subpages. I'm not quite sure, if all of your use cases can be implemented with the graphs extension, as I'm not that familiar with this extension.
I've read a bit about rich snippets and I'm interested in the reviews part.
Is there a way to add the TripAdvisor aggregate reviews dynamically as a rich snippet without "hard-coding" the number of stars and a review?
From what I've read rich snippets are not dynamic, so I can't add a link or a tag for example, that would automatically just load my star ratings and the text of the latest review (just like a widget would do).
Is there?
The site is created in Joomla and I've installed J4Schema to add rich snippets.
Figured it out eventually.
Rich snippets are currently a "manual thing". Meaning that you will insert them by hand in your code, and you can reference TripAdvisor externally, but this will not create a link to the TripAdvisor account.
Google, at some point (in my case, after 6-8 months) will process these rich snippets, and will show them for the search result in question.
Also, a periodic update of these snippets is to be maintained to insure relevance.
I'm still pretty new to Joomla and I'm familar with adding custom HTML modules in various positions. I'm also familar with setting up the blog layout for the front page with leading articles, intro articles, etc. However I have a case where I would like to have a image slideshow with a static lead article under that, with 3 intro articles (one in each column), with all new articles listed below this hortizontally instead of being added to the top of the list. Is this possible and if so how can it be done?
see The R.I.P. Files
Thank you
Jim
For the slide show +static article I would either put it in a module in a position or put it inside a lead article. In terms of keeping your one article at the top one trick is to give it an order of -1. Another would be to manually maintain the order you want and use order by order.