~protesilaos/denote

This thread contains a patchset. You're looking at the original emails, but you may wish to use the patch review UI. Review patch
5 3

[PATCH] Exclude Info indices from the HTML version of the ToC

Details
Message ID
<m1k0568it7.fsf@esmac.lan>
DKIM signature
missing
Download raw message
Patch: +1 -0
Currently the HTML version of the manual at
https://protesilaos.com/emacs/denote lists in its table of contents
links to the Indices header and its subheaders, but these are not
present in the HTML version of the manual.

Set the UNNUMBERED property of the Indices header to "notoc" to
exclude the entire subtree from the ToC during export to HTML.
---
 README.org | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.org b/README.org
index 4ef6e75..322b7b6 100644
--- a/README.org
+++ b/README.org
@@ -3685,6 +3685,7 @@ to permit their use in free software.
* Indices
:PROPERTIES:
:CUSTOM_ID: h:dd530040-de9d-4f2b-8dfd-d8b8f14c058e
:UNNUMBERED: notoc
:END:

** Function index
-- 
2.37.3
Details
Message ID
<874jwal5dh.fsf@protesilaos.com>
In-Reply-To
<m1k0568it7.fsf@esmac.lan> (view parent)
DKIM signature
missing
Download raw message
> From: Eshel Yaron <me@eshelyaron.com>
> Date: Tue, 11 Oct 2022 18:46:12 +0300
>
> Currently the HTML version of the manual at
> https://protesilaos.com/emacs/denote lists in its table of contents
> links to the Indices header and its subheaders, but these are not
> present in the HTML version of the manual.
>
> Set the UNNUMBERED property of the Indices header to "notoc" to
> exclude the entire subtree from the ToC during export to HTML.
> ---
>  README.org | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/README.org b/README.org
> index 4ef6e75..322b7b6 100644
> --- a/README.org
> +++ b/README.org
> @@ -3685,6 +3685,7 @@ to permit their use in free software.
>  * Indices
>  :PROPERTIES:
>  :CUSTOM_ID: h:dd530040-de9d-4f2b-8dfd-d8b8f14c058e
> +:UNNUMBERED: notoc
>  :END:
>  
>  ** Function index

Thank you, Eshel!

Installed and pushed.  I also made the update to the website.  Waiting
for the changes to propagate.

All the best,
Prot

-- 
Protesilaos Stavrou
https://protesilaos.com
Details
Message ID
<m1fsfu8gjd.fsf@esmac.lan>
In-Reply-To
<874jwal5dh.fsf@protesilaos.com> (view parent)
DKIM signature
missing
Download raw message
Protesilaos Stavrou <info@protesilaos.com> writes:

> Installed and pushed.  I also made the update to the website.  Waiting
> for the changes to propagate.

Great! Seems to have worked fine, now the last entry in the table of
contents I see on the website is "19. GNU Free Documentation License".


Best,
Eshel
Details
Message ID
<87edvdixxf.fsf@protesilaos.com>
In-Reply-To
<m1fsfu8gjd.fsf@esmac.lan> (view parent)
DKIM signature
missing
Download raw message
> From: Eshel Yaron <me@eshelyaron.com>
> Date: Tue, 11 Oct 2022 19:35:18 +0300
>
> Protesilaos Stavrou <info@protesilaos.com> writes:
>
>> Installed and pushed.  I also made the update to the website.  Waiting
>> for the changes to propagate.
>
> Great! Seems to have worked fine, now the last entry in the table of
> contents I see on the website is "19. GNU Free Documentation License".

Good day Eshel!

I had to revert this change because it affected the Info manual:

    commit 74231ccbe9cb98bb7158c5ee4cdf647b125dc422
    Author: Protesilaos Stavrou <info@protesilaos.com>
    Date:   Wed Oct 12 05:18:36 2022 +0300

        Revert "Exclude Info indices from the HTML version of the ToC"

        This reverts commit cfd2d429546e9ae2d112eeb988b47bf30444e794.

        I thought it only affected the HTML output, but it also applies to the
        Info manual.  Given that the indices are for the latter, this change
        has to be reverted.  Maybe there is way to limit this effect to the
        HTML output only.

     README.org | 1 -
     1 file changed, 1 deletion(-)

If there is a way to have better control over what is exported and
where, I am happy to apply it.

All the best,
Prot

-- 
Protesilaos Stavrou
https://protesilaos.com
Details
Message ID
<m135btoaql.fsf@esmac.lan>
In-Reply-To
<87edvdixxf.fsf@protesilaos.com> (view parent)
DKIM signature
missing
Download raw message
Protesilaos Stavrou <info@protesilaos.com> writes:

> Good day Eshel!

Hi Prot :)

> I had to revert this change because it affected the Info manual:
>
>     commit 74231ccbe9cb98bb7158c5ee4cdf647b125dc422
>     Author: Protesilaos Stavrou <info@protesilaos.com>
>     Date:   Wed Oct 12 05:18:36 2022 +0300
>
>         Revert "Exclude Info indices from the HTML version of the ToC"
>
>         This reverts commit cfd2d429546e9ae2d112eeb988b47bf30444e794.
>
>         I thought it only affected the HTML output, but it also applies to the
>         Info manual.  Given that the indices are for the latter, this change
>         has to be reverted.  Maybe there is way to limit this effect to the
>         HTML output only.
>
>      README.org | 1 -
>      1 file changed, 1 deletion(-)

My apologies for the adverse affect, I thought (mistakenly it seems)
that during export to Info, the ToC is generated at a later stage that
Org does not control, and accordingly that the Info manual will remain
intact.

> If there is a way to have better control over what is exported and
> where, I am happy to apply it.

I'll let you know if/when I find a better solution.


Cheers,
Eshel
Details
Message ID
<87ilkpd1pn.fsf@protesilaos.com>
In-Reply-To
<m135btoaql.fsf@esmac.lan> (view parent)
DKIM signature
missing
Download raw message
> From: Eshel Yaron <eshelshay.yaron@gmail.com>
> Date: Wed, 12 Oct 2022 08:46:10 +0300
>
> Protesilaos Stavrou <info@protesilaos.com> writes:
>
>> Good day Eshel!
>
> Hi Prot :)

Hello Eshel!

>> I had to revert this change because it affected the Info manual:
>>
>>     commit 74231ccbe9cb98bb7158c5ee4cdf647b125dc422
>>     Author: Protesilaos Stavrou <info@protesilaos.com>
>>     Date:   Wed Oct 12 05:18:36 2022 +0300
>>
>>         Revert "Exclude Info indices from the HTML version of the ToC"
>>
>>         This reverts commit cfd2d429546e9ae2d112eeb988b47bf30444e794.
>>
>>         I thought it only affected the HTML output, but it also applies to the
>>         Info manual.  Given that the indices are for the latter, this change
>>         has to be reverted.  Maybe there is way to limit this effect to the
>>         HTML output only.
>>
>>      README.org | 1 -
>>      1 file changed, 1 deletion(-)
>
> My apologies for the adverse affect, I thought (mistakenly it seems)
> that during export to Info, the ToC is generated at a later stage that
> Org does not control, and accordingly that the Info manual will remain
> intact.

No worries!  I thought the same.  It's okay.

>> If there is a way to have better control over what is exported and
>> where, I am happy to apply it.
>
> I'll let you know if/when I find a better solution.

Thank you!

All the best,
Prot

-- 
Protesilaos Stavrou
https://protesilaos.com
Reply to thread Export thread (mbox)