[PATCH] Apply emacs manual css to org pages

[PATCH] Apply emacs manual css to org pages

[TEC]

[-- Attachment #1: Type: text/plain, Size: 356 bytes --]

Hi all,

This is a quick patch to use the Emacs manual CSS with our generated Org
manual.

You can see what the single-page version of this looks like here:
https://tecosaur.com/resources/org/doc/manual.html and the multi-page
here: https://tecosaur.com/resources/org/doc/manual/

This should be an easy upgrade to our online documentation :)

--
Timothy


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-mk-default.mk-use-same-html-doc-style-as-emacs.patch --]
[-- Type: text/x-patch, Size: 826 bytes --]

From fc57ea88432ea119d063906cc29cc51ee591031d Mon Sep 17 00:00:00 2001
From: TEC <tec@tecosaur.com>
Date: Wed, 23 Dec 2020 10:30:09 +0800
Subject: [PATCH] mk/default.mk: use same html doc style as emacs

* mk/default.mk: Add CSS stylesheet ref to HTML generated by TEXI2HTML,
specifically the stylesheet used with the online Emacs manual.
---
 mk/default.mk | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mk/default.mk b/mk/default.mk
index fbfdaf5..e92d58c 100644
--- a/mk/default.mk
+++ b/mk/default.mk
@@ -139,7 +139,7 @@ MKDIR	= install -m 755 -d
 MAKEINFO = makeinfo
 
 # How to create the HTML file
-TEXI2HTML = makeinfo --html --number-sections
+TEXI2HTML = makeinfo --html --number-sections --css-ref "https://www.gnu.org/software/emacs/manual.css"
 
 # How to find files
 FIND	= find
-- 
2.29.2

Re: [PATCH] Apply emacs manual css to org pages

[Greg Minshall]

Timothy,

> This is a quick patch to use the Emacs manual CSS with our generated Org
> manual.

that's certainly visually pleasing.  nice!

Greg

Re: [PATCH] Apply emacs manual css to org pages

[Timothy]

For some reason updates.orgmode.org registered this as a new patch??
Marking as closed via X-Woof-Patch header.

Greg Minshall <minshall@umich.edu> writes:

> Timothy,
>
>> This is a quick patch to use the Emacs manual CSS with our generated Org
>> manual.
>
> that's certainly visually pleasing.  nice!
>
> Greg

Re: [PATCH] Apply emacs manual css to org pages

[Amin Bandali]

[-- Attachment #1: Type: text/plain, Size: 610 bytes --]

Hi Timothy, all,

TEC writes:

> Hi all,
>
> This is a quick patch to use the Emacs manual CSS with our generated Org
> manual.
>
> You can see what the single-page version of this looks like here:
> https://tecosaur.com/resources/org/doc/manual.html and the multi-page
> here: https://tecosaur.com/resources/org/doc/manual/
>
> This should be an easy upgrade to our online documentation :)

Definite +1 from me.  It helps with readability and consistency of the
Org manual with the Emacs manual(s) and the manuals of several other GNU
packages that use this or a variation of this stylesheet.

> --
> Timothy

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 857 bytes --]

Re: [PATCH] Apply emacs manual css to org pages

[Samuel Wales]

i like the black bg, the no issues with paragraph width.


On 12/22/20, TEC <tecosaur@gmail.com> wrote:
> Hi all,
>
> This is a quick patch to use the Emacs manual CSS with our generated Org
> manual.
>
> You can see what the single-page version of this looks like here:
> https://tecosaur.com/resources/org/doc/manual.html and the multi-page
> here: https://tecosaur.com/resources/org/doc/manual/
>
> This should be an easy upgrade to our online documentation :)
>
> --
> Timothy
>
>


-- 
The Kafka Pandemic

Please learn what misopathy is.
https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html

Re: [PATCH] Apply emacs manual css to org pages

[Samuel Wales]

if i were to make any /tiny nit-level/ suggestions from my pov it
would be somewhat wider margins, not pure white but slightly [so still
/very/ high contrast] warmer for fg, and some less-blue for links [but
i realize blue is common].

i would also do [ha ha, as if i knew what to do or even whether it is
possible] wrapping for left columns that go under text rather than
bullet for e.g this line: "• Extracting Agenda Information	
	Post-processing agenda information."  set fonts large.

these are without regard for emacs manual as i have not seen that
online recently.  great job.  thank you.


On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
> i like the black bg, the no issues with paragraph width.
>
>
> On 12/22/20, TEC <tecosaur@gmail.com> wrote:
>> Hi all,
>>
>> This is a quick patch to use the Emacs manual CSS with our generated Org
>> manual.
>>
>> You can see what the single-page version of this looks like here:
>> https://tecosaur.com/resources/org/doc/manual.html and the multi-page
>> here: https://tecosaur.com/resources/org/doc/manual/
>>
>> This should be an easy upgrade to our online documentation :)
>>
>> --
>> Timothy
>>
>>
>
>
> --
> The Kafka Pandemic
>
> Please learn what misopathy is.
> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>


-- 
The Kafka Pandemic

Please learn what misopathy is.
https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html

Re: [PATCH] Apply emacs manual css to org pages

[Samuel Wales]

i wonder if css makes it possible to have wider margins /except/ for
tables and stuch.  or perhaps that is consiedered bad style.  but it
would be accessible/functional.  but i am just glad that it is only
tables that need horizontal scrolling.

On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
> if i were to make any /tiny nit-level/ suggestions from my pov it
> would be somewhat wider margins, not pure white but slightly [so still
> /very/ high contrast] warmer for fg, and some less-blue for links [but
> i realize blue is common].
>
> i would also do [ha ha, as if i knew what to do or even whether it is
> possible] wrapping for left columns that go under text rather than
> bullet for e.g this line: "• Extracting Agenda Information	
> 	Post-processing agenda information."  set fonts large.
>
> these are without regard for emacs manual as i have not seen that
> online recently.  great job.  thank you.
>
>
> On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
>> i like the black bg, the no issues with paragraph width.
>>
>>
>> On 12/22/20, TEC <tecosaur@gmail.com> wrote:
>>> Hi all,
>>>
>>> This is a quick patch to use the Emacs manual CSS with our generated Org
>>> manual.
>>>
>>> You can see what the single-page version of this looks like here:
>>> https://tecosaur.com/resources/org/doc/manual.html and the multi-page
>>> here: https://tecosaur.com/resources/org/doc/manual/
>>>
>>> This should be an easy upgrade to our online documentation :)
>>>
>>> --
>>> Timothy
>>>
>>>
>>
>>
>> --
>> The Kafka Pandemic
>>
>> Please learn what misopathy is.
>> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>>
>
>
> --
> The Kafka Pandemic
>
> Please learn what misopathy is.
> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>


-- 
The Kafka Pandemic

Please learn what misopathy is.
https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html

Re: [PATCH] Apply emacs manual css to org pages

[TEC]

Hi Samuel,

We could add some of our own CSS, but that would have us deviate from
the Emacs manual. It's worth asking if we want to do that IMO.

--
Timothy

Samuel Wales <samologist@gmail.com> writes:

> i wonder if css makes it possible to have wider margins /except/ for
> tables and stuch.  or perhaps that is consiedered bad style.  but it
> would be accessible/functional.  but i am just glad that it is only
> tables that need horizontal scrolling.
>
> On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
>> if i were to make any /tiny nit-level/ suggestions from my pov it
>> would be somewhat wider margins, not pure white but slightly [so still
>> /very/ high contrast] warmer for fg, and some less-blue for links [but
>> i realize blue is common].
>>
>> i would also do [ha ha, as if i knew what to do or even whether it is
>> possible] wrapping for left columns that go under text rather than
>> bullet for e.g this line: "• Extracting Agenda Information	
>> 	Post-processing agenda information."  set fonts large.
>>
>> these are without regard for emacs manual as i have not seen that
>> online recently.  great job.  thank you.
>>
>>
>> On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
>>> i like the black bg, the no issues with paragraph width.
>>>
>>>
>>> On 12/22/20, TEC <tecosaur@gmail.com> wrote:
>>>> Hi all,
>>>>
>>>> This is a quick patch to use the Emacs manual CSS with our generated Org
>>>> manual.
>>>>
>>>> You can see what the single-page version of this looks like here:
>>>> https://tecosaur.com/resources/org/doc/manual.html and the multi-page
>>>> here: https://tecosaur.com/resources/org/doc/manual/
>>>>
>>>> This should be an easy upgrade to our online documentation :)
>>>>
>>>> --
>>>> Timothy
>>>>
>>>>
>>>
>>>
>>> --
>>> The Kafka Pandemic
>>>
>>> Please learn what misopathy is.
>>> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>>>
>>
>>
>> --
>> The Kafka Pandemic
>>
>> Please learn what misopathy is.
>> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>>

Re: [PATCH] Apply emacs manual css to org pages

[Samuel Wales]

yes, presumably some of these topics apply to emacs style.

On 12/27/20, TEC <tecosaur@gmail.com> wrote:
>
> Hi Samuel,
>
> We could add some of our own CSS, but that would have us deviate from
> the Emacs manual. It's worth asking if we want to do that IMO.
>
> --
> Timothy
>
> Samuel Wales <samologist@gmail.com> writes:
>
>> i wonder if css makes it possible to have wider margins /except/ for
>> tables and stuch.  or perhaps that is consiedered bad style.  but it
>> would be accessible/functional.  but i am just glad that it is only
>> tables that need horizontal scrolling.
>>
>> On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
>>> if i were to make any /tiny nit-level/ suggestions from my pov it
>>> would be somewhat wider margins, not pure white but slightly [so still
>>> /very/ high contrast] warmer for fg, and some less-blue for links [but
>>> i realize blue is common].
>>>
>>> i would also do [ha ha, as if i knew what to do or even whether it is
>>> possible] wrapping for left columns that go under text rather than
>>> bullet for e.g this line: "• Extracting Agenda Information	
>>> 	Post-processing agenda information."  set fonts large.
>>>
>>> these are without regard for emacs manual as i have not seen that
>>> online recently.  great job.  thank you.
>>>
>>>
>>> On 12/27/20, Samuel Wales <samologist@gmail.com> wrote:
>>>> i like the black bg, the no issues with paragraph width.
>>>>
>>>>
>>>> On 12/22/20, TEC <tecosaur@gmail.com> wrote:
>>>>> Hi all,
>>>>>
>>>>> This is a quick patch to use the Emacs manual CSS with our generated
>>>>> Org
>>>>> manual.
>>>>>
>>>>> You can see what the single-page version of this looks like here:
>>>>> https://tecosaur.com/resources/org/doc/manual.html and the multi-page
>>>>> here: https://tecosaur.com/resources/org/doc/manual/
>>>>>
>>>>> This should be an easy upgrade to our online documentation :)
>>>>>
>>>>> --
>>>>> Timothy
>>>>>
>>>>>
>>>>
>>>>
>>>> --
>>>> The Kafka Pandemic
>>>>
>>>> Please learn what misopathy is.
>>>> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>>>>
>>>
>>>
>>> --
>>> The Kafka Pandemic
>>>
>>> Please learn what misopathy is.
>>> https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html
>>>
>
>


-- 
The Kafka Pandemic

Please learn what misopathy is.
https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html

Re: [PATCH] Apply emacs manual css to org pages

[Kyle Meyer]

TEC writes:

> Subject: [PATCH] mk/default.mk: use same html doc style as emacs
>
> * mk/default.mk: Add CSS stylesheet ref to HTML generated by TEXI2HTML,
> specifically the stylesheet used with the online Emacs manual.
> ---
>  mk/default.mk | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/mk/default.mk b/mk/default.mk
> index fbfdaf5..e92d58c 100644
> --- a/mk/default.mk
> +++ b/mk/default.mk
> @@ -139,7 +139,7 @@ MKDIR	= install -m 755 -d
>  MAKEINFO = makeinfo
>  
>  # How to create the HTML file
> -TEXI2HTML = makeinfo --html --number-sections
> +TEXI2HTML = makeinfo --html --number-sections --css-ref "https://www.gnu.org/software/emacs/manual.css"

Hmm, while I barely ever look at the online manual, I thought I recalled
it having custom styling, and indeed it looks like that was the case:

  https://web.archive.org/web/20171222052224/https://orgmode.org/org.html

At least based on the Wayback Machine rendering, it seems like the
custom CSS was lost shortly after the snapshot above.

If you look in the repo for org-manual.css, you can see there is still
handling for it.

So, if we're going to go in the direction of this patch, there should be
some mention of the previous approach, why it was dropped, and the
handling for org-manual.css should probably be removed.  Perhaps Bastien
can help fill in some details here.

Re: [PATCH] Apply emacs manual css to org pages

[Bastien]

Hi,

Kyle Meyer <kyle@kyleam.com> writes:

>>  # How to create the HTML file
>> -TEXI2HTML = makeinfo --html --number-sections
>> +TEXI2HTML = makeinfo --html --number-sections --css-ref "https://www.gnu.org/software/emacs/manual.css"

I made this change and tested it online, the HTML Org manual now looks
like the Emacs manual: https://orgmode.org/manual/

Thanks for the suggestion!

> Hmm, while I barely ever look at the online manual, I thought I recalled
> it having custom styling, and indeed it looks like that was the case:
>
>   https://web.archive.org/web/20171222052224/https://orgmode.org/org.html
>
> At least based on the Wayback Machine rendering, it seems like the
> custom CSS was lost shortly after the snapshot above.
>
> If you look in the repo for org-manual.css, you can see there is still
> handling for it.

Yes, I remember I tried to enhance the css for the manual, and I don't
remember why this change was reverted.

> So, if we're going to go in the direction of this patch, there should be
> some mention of the previous approach, why it was dropped, and the
> handling for org-manual.css should probably be removed.  Perhaps Bastien
> can help fill in some details here.

In any cas, the Emacs manual css is better than my attempt and using
it for Org makes sense IMO.

Best,

-- 
 Bastien

Re: [PATCH] Apply emacs manual css to org pages

[Timothy]

This was not marked as applied on updates.orgmode.org.
Doing so with the X-Woof-Patch header.

Bastien <bzg@gnu.org> writes:

> I made this change and tested it online, the HTML Org manual now looks
> like the Emacs manual: https://orgmode.org/manual/
>
> Thanks for the suggestion!

> In any cas, the Emacs manual css is better than my attempt and using
> it for Org makes sense IMO.
>
> Best,