You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@infra.apache.org by "Sebb (JIRA)" <ji...@apache.org> on 2015/05/26 01:37:17 UTC
[jira] [Updated] (INFRA-9707) Enable Markdown permalink processing
[ https://issues.apache.org/jira/browse/INFRA-9707?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Sebb updated INFRA-9707:
------------------------
Description:
The Python Markdown TOC extension [1] has a 'permalink' config option.
When this is enabled, it adds 'hover' para links to headers in the same way as the Subversion site [2].
The option is designed for Sphinx style sheets and assumes that the 'headerlink' CSS class is used to hide the para mark unless the user hovers over the heading. If the class is not defined, the para mark is permanently visible, which can look a bit messy. An extra extension [3] can be used to add the required CSS style to the generated output.
The feature needs to be enabled in the markdown daemon, so will apply to all mdtext pages using the daemon. The para marks are hidden by default, and then enabled on hover for headers <h1>,<h2> etc. so it would be possible to suppress the display by omitting the hover override. This could potentially be controlled by using a marker text string in the mdtext source which is detected by the extension that adds the CSS.
[1] https://pythonhosted.org/Markdown/extensions/toc.html#usage
[2] http://subversion.apache.org/#vision (hover over the heading)
[3] https://svn.apache.org/repos/infra/websites/cms/build/mdx_addheaderlinkcss.py
Summary: Enable Markdown permalink processing (was: Emab)
> Enable Markdown permalink processing
> ------------------------------------
>
> Key: INFRA-9707
> URL: https://issues.apache.org/jira/browse/INFRA-9707
> Project: Infrastructure
> Issue Type: Sub-task
> Components: CMS, Website
> Reporter: Sebb
>
> The Python Markdown TOC extension [1] has a 'permalink' config option.
> When this is enabled, it adds 'hover' para links to headers in the same way as the Subversion site [2].
> The option is designed for Sphinx style sheets and assumes that the 'headerlink' CSS class is used to hide the para mark unless the user hovers over the heading. If the class is not defined, the para mark is permanently visible, which can look a bit messy. An extra extension [3] can be used to add the required CSS style to the generated output.
> The feature needs to be enabled in the markdown daemon, so will apply to all mdtext pages using the daemon. The para marks are hidden by default, and then enabled on hover for headers <h1>,<h2> etc. so it would be possible to suppress the display by omitting the hover override. This could potentially be controlled by using a marker text string in the mdtext source which is detected by the extension that adds the CSS.
> [1] https://pythonhosted.org/Markdown/extensions/toc.html#usage
> [2] http://subversion.apache.org/#vision (hover over the heading)
> [3] https://svn.apache.org/repos/infra/websites/cms/build/mdx_addheaderlinkcss.py
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)