Multiple (Nested) Roles in a Glossary - python-sphinx

in my Sphinx docs I would like to create a glossary, potentially containing :math:, or other roles:
.. glossary::
:math:`f(x)`
Description
Is there any way to reference this entry with a text that has the same style as the glossary entry?
:term:`f(x)` Works, but is rendered as a plain hyperlink.
I want a hyperlink with the original styling instead:
:term:`:math:`f(x)`` Does not work.
:term:`:math:`f(x)` <f(x)>` Also doesnt.
Many thanks for the help.

Related

Customize coveo Omnibox Result List

I am Enabling Results Suggestions with the Coveo Searchbox.
Followed the article https://docs.coveo.com/en/2806/coveo-for-sitecore-v4/result-suggestions which is successful and I am able to see the suggestions in the list coming through. The problem is - omnibox results list displays title and excerpt like this
, but I want to display only Title just like this one My First question is - how can I display only title in the omnibox results list like the one in the above image(don't need excerpt or firstsentences to display) My Second question is - I want to apply custom css to the suggestions list, how can I achieve that.
The Omnibox Result List component includes a result template. We can edit that template to only show the title for example, or to show additional content. And its regular CSS practices to update the styling

Sphinx: Use placeholders in roles

I am working on a sphinx documentation and i am facing following problem at the moment:
I am using roles for different display options. Now i wanted to add font-awesome logos to a certain text within the role, but the placeholders i use don´t work in the role definition. Here an example:
:ver:`|Cubes| random text`
ver is my class and |Cubes| is the placeholder for the font-awesome logo.
The problem is, that the placeholder requires a white-space before and after the | but for the role definition there can´t be a white-space right after or before the `.
Is there a way to solve this without creating a different role for every logo i use in my documentation?
Thanks for every Answer :)
Nope. From Interpreted Text:
Interpreted text is text that is meant to be related, indexed, linked, summarized, or otherwise processed, but the text itself is typically left alone.
See Inline markup recognition rules for details.
As an aside, what you call "placeholders" are substitions in reST terminology.

What is the level displayed as "Default" in a apiblueprint document?

When i create a new api documentation in apiary.io, the rendered document and navigation shows structural level which are not visible in the editor:
INTRODUCTION
REFERENCE
Default
While I can accept the highest levels to generated magically, I would like to rename and duplicate the second level.
How do I do it? How is it called? It has CSS classes resourceGroupName but this does not appear to be the name.
Seems like I have overseen that some words that look like normal text are in fact keywords for the apiblueprint parser. One of them is Group, explained here: https://docs.apiary.io/api_101/api_blueprint_tutorial/#resource-groups

CKEditor and HTML in Xpages

I am understanding this better but still not there yet.
I have a notes document with a rich text field. I want to edit it in Xpages, so that the user can enter text for an email that an agent will generate. The idea is that the user should be able to enter styled text, hopefully including pasted graphics, and this is saved to the rich text field in such a way that a later agent can copy that field to the body of an email.
On the form I have checked the field "Store contents as HTML and MIME.
In the Xpage I have bound the CKEditor directly to the field (can bind it to a scope variable if necessary).
The code in my agent is as follows:
Set rtItmFrm = emlDoc.getFirstItem("Body")
Set rtItmTo = New NotesRichTextItem(mail,"Body")
Set rtItmTo = rtItmFrm.Copyitemtodocument(mail,"Body")
Any further suggestions on reading up on MIME/CKEditor etc would also be much appreciated.
Bryan
=========================================================================
I just discovered how to modify the CKEditor in Xpages (the Rich Text Control). I have the full menu and one or two more things turned out. However, I am really puzzled by how it treats HTML. I would like to put a template for a nice HTML email (like a newsletter). Anything even a little complicated it munges and the output is messed up.
I read enough online to understand that it is not supposed to be a HTML editor, but I am really having trouble getting the results I want. I would love to put some basic skeleton HTML in there, but everything but the simplest code doesn't work.
Is there anyway to import HTML and it not get messed up using this editor?
as Per and Stephan said, Have a look at ACF filtering that is 'server side' (This is not related to CKEditor itself, but it is related to XPages).
If you have a look at the inputRichText control you will see 2 properties.
htmlFilter
htmlFilterIn
These properties determine how to filter Html on the way in to your data, and also on the way out.
This can be used to strip styling out, and also to prevent dangerous tags like some bad code here etc.
By Default the htmlFilter is set ACF (Active Content Filtering) if you look at the default rules, you will see it strips things like 'margin' out.
see /properties/acf-config.xml-sample
There is a filter called 'identity' which means don't filter anything, however beware if you use this you are not protected from and maliciously entered html.
You should look into defining your own set of rules for your ACF filter, this way you can choose which elements to remove. There is a section in Mastering XPages book about this.
If you still have any trouble, then there are some settings in CKEditor config which also control ACF (totally separate to XPages server side)
I don't think CKE changes the HTML, it is the writing back to a RT field.
Try and bind your RichText Editor to a scoped variable instead of a RichText field. This way you have access to the raw HTML and can use that to generate a MIME email. You might want to have a look at Mustache for mail merge.
Use this article series as starter how to prepare CK editor to make this possible.
And as Per mentioned: check the filtering.

Confluence export dynamic PDF title

I am using Confluence 4.0.3, I am trying to create a PDF layout/stylesheet so that it would grab the main title from the page content and move it to the title page.
What I have tried so far:
use the way that confluence suggests - it did not work well at all because it came with extra toc (np, I can hide it) and extra page content because it requires me to export from the parent level for it to work
I define a macro which contains the page title and I can use css to make it land on the title page. This works however if I was to export multiple docs this could pose a issue
Style the h1:first-child, this works but again on multiple docs this would be an issue.
Question: Is there a good way to do this on multiple doc exports? If not, does the page title have its own class that I can target instead of the h1:first-child? I tried h1.pagetitle (in their documentation) but it does not work, thanks
I used a user defined macro to put the title in and use the PDF export css to position it on the title page. This works as long as you are only exporting 1 document at the exporting level. If you are exporting 2 or more docs from the same exporting level then you can only define 1 of the macros or else they will all be at the same position on the title page.
This seems like the easiest way I found to implement something like this.
I would try employing a minor work-around. You could use a .asp page, which is located off of confluence, to pull the the pdf title and display it how you like. Then you can use an html-include macro to display the .asp page, and the pdf title it shows, wherever you like on confluence.

Resources