bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[José Miguel García Urrutia]

[-- Attachment #1.1: Type: text/plain, Size: 179 bytes --]

Hello, this is a patch that fixes the orgcard.tex file PDF rendering to
allow it to be used as a triptych in US letter page format.

Thank you.
José Miguel García Urrutia.

[-- Attachment #1.2: Type: text/html, Size: 245 bytes --]

[-- Attachment #2: 0001-orgcard.tex-modified-to-allow-a-correct-rendering-in.patch --]
[-- Type: application/octet-stream, Size: 2449 bytes --]

From 80872d6be88b7c6da4eb27a512067e6fb02ef671 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Miguel=20Garc=C3=ADa=20Urrutia?=
 <josemgu91@gmail.com>
Date: Tue, 11 Jul 2023 23:15:57 -0500
Subject: [PATCH] orgcard.tex modified to allow a correct rendering in PDF
 format and US letter page size (it now can be printed as a triptych)

---
 etc/refcards/orgcard.tex | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)
 mode change 100644 => 100755 etc/refcards/orgcard.tex

diff --git a/etc/refcards/orgcard.tex b/etc/refcards/orgcard.tex
old mode 100644
new mode 100755
index 07463ee6a33..7b0a7370cae
--- a/etc/refcards/orgcard.tex
+++ b/etc/refcards/orgcard.tex
@@ -11,10 +11,14 @@
 % Specify how many you want here.
 \columnsperpage=3
 
+% Set letterpaper to 0 for A4 paper, 1 for letter (US) paper.  Useful
+% only when columnsperpage is 2 or 3.
+\letterpaper=1
+
 % PDF output layout.  0 for A4, 1 for letter (US), a `l' is added for
 % a landscape layout.
 \input pdflayout.sty
-\pdflayout=(0l)
+\pdflayout=(1l)
 
 % Nothing else needs to be changed below this line.
 % Copyright (C) 1987, 1993, 1996--1997, 2001--2023 Free Software
@@ -113,17 +117,14 @@
   \footline{\hss\folio}
   \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
 \else				%2 or 3 columns uses prereduced size
+  \hsize 3.2in
   \if 1\the\letterpaper
-     \hsize 3.2in
      \vsize 7.95in
-     \hoffset -.75in
-     \voffset -.745in
   \else
-     \hsize 3.2in
      \vsize 7.65in
-     \hoffset -.25in
-     \voffset -.745in
   \fi
+  \hoffset -.75in
+  \voffset -.745in
   \font\titlefont=cmbx10 \scaledmag2
   \font\headingfont=cmbx10 \scaledmag1
   \font\smallfont=cmr6
@@ -280,7 +281,7 @@
 %**end of header
 \f
 
-\title{Org-Mode Reference Card (1/2)}
+\title{Org-Mode Reference Card}
 
 \centerline{(for version \orgversionnumber)}
 
@@ -329,7 +330,7 @@ \section{Capture - Refile - Archiving}
 \key{archive subtree using the default command}{C-c C-x C-a}
 \key{move subtree to archive file}{C-c C-x C-s}
 \key{toggle ARCHIVE tag / to ARCHIVE sibling}{C-c C-x a/A}
-\key{force cycling of an ARCHIVEd tree}{C-c C-TAB}
+\key{force cycling of an ARCHIVEd tree}{C-TAB}
 
 \section{Filtering and Sparse Trees}
 
@@ -482,7 +483,7 @@ \section{Completion and Template Insertion}
 
 
 \newcolumn
-\title{Org-Mode Reference Card (2/2)}
+\title{Org-Mode Reference Card}
 
 \centerline{(for version \orgversionnumber)}
 
-- 
2.41.0

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Ihor Radchenko]

José Miguel García Urrutia <josemgu91@gmail.com> writes:

> Hello, this is a patch that fixes the orgcard.tex file PDF rendering to
> allow it to be used as a triptych in US letter page format.
>
>  % Specify how many you want here.
>  \columnsperpage=3
>  
> +% Set letterpaper to 0 for A4 paper, 1 for letter (US) paper.  Useful
> +% only when columnsperpage is 2 or 3.
> +\letterpaper=1
> +
>  % PDF output layout.  0 for A4, 1 for letter (US), a `l' is added for
>  % a landscape layout.
>  \input pdflayout.sty
> -\pdflayout=(0l)
> +\pdflayout=(1l)

I will leave this to Emacs devs to decide about the layout.
The reference cards in Emacs follow certain format.
I am not sure if this patch is breaking it or not.

> -\key{force cycling of an ARCHIVEd tree}{C-c C-TAB}
> +\key{force cycling of an ARCHIVEd tree}{C-TAB}

This is wrong. Org's default binding is C-c C-TAB.
  
> -\title{Org-Mode Reference Card (2/2)}
> +\title{Org-Mode Reference Card}

Why?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[José Miguel García Urrutia]

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

I’ve removed the “(1/2)” and “(2/2)” numbers from the titles as they
overflow the columns, making them to be wider than expected thus breaking
the triptych format.
The US letter paper size is the same as the Emacs reference card.
The published PDF org-mode reference card is the rendered version of this
tex file. It’s in A4 format and the columns doesn’t have the same size,
making impossible to do a triptych with same sized columns. This is why I
modified it.

On Thu, 13 Jul 2023 at 05:51 Ihor Radchenko <yantar92@posteo.net> wrote:

> José Miguel García Urrutia <josemgu91@gmail.com> writes:
>
> > Hello, this is a patch that fixes the orgcard.tex file PDF rendering to
> > allow it to be used as a triptych in US letter page format.
> >
> >  % Specify how many you want here.
> >  \columnsperpage=3
> >
> > +% Set letterpaper to 0 for A4 paper, 1 for letter (US) paper.  Useful
> > +% only when columnsperpage is 2 or 3.
> > +\letterpaper=1
> > +
> >  % PDF output layout.  0 for A4, 1 for letter (US), a `l' is added for
> >  % a landscape layout.
> >  \input pdflayout.sty
> > -\pdflayout=(0l)
> > +\pdflayout=(1l)
>
> I will leave this to Emacs devs to decide about the layout.
> The reference cards in Emacs follow certain format.
> I am not sure if this patch is breaking it or not.
>
> > -\key{force cycling of an ARCHIVEd tree}{C-c C-TAB}
> > +\key{force cycling of an ARCHIVEd tree}{C-TAB}
>
> This is wrong. Org's default binding is C-c C-TAB.
>
> > -\title{Org-Mode Reference Card (2/2)}
> > +\title{Org-Mode Reference Card}
>
> Why?
>
> --
> Ihor Radchenko // yantar92,
> Org mode contributor,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>
>

[-- Attachment #2: Type: text/html, Size: 2618 bytes --]

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Ihor Radchenko]

Ihor Radchenko <yantar92@posteo.net> writes:

> José Miguel García Urrutia <josemgu91@gmail.com> writes:
>
>> Hello, this is a patch that fixes the orgcard.tex file PDF rendering to
>> allow it to be used as a triptych in US letter page format.
>>
>>  % Specify how many you want here.
>>  \columnsperpage=3
>>  
>> +% Set letterpaper to 0 for A4 paper, 1 for letter (US) paper.  Useful
>> +% only when columnsperpage is 2 or 3.
>> +\letterpaper=1
>> +
>>  % PDF output layout.  0 for A4, 1 for letter (US), a `l' is added for
>>  % a landscape layout.
>>  \input pdflayout.sty
>> -\pdflayout=(0l)
>> +\pdflayout=(1l)
>
> I will leave this to Emacs devs to decide about the layout.
> The reference cards in Emacs follow certain format.
> I am not sure if this patch is breaking it or not.

Ping!

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Ihor Radchenko]

Ihor Radchenko <yantar92@posteo.net> writes:

>> I will leave this to Emacs devs to decide about the layout.
>> The reference cards in Emacs follow certain format.
>> I am not sure if this patch is breaking it or not.
>
> Ping!

I cannot see any obvious problem with the layout and no objection have
been raised by the Emacs devs, so I am inclined to merge the patch
except the incorrect key binding change.

I will wait another week and go ahead with the merge.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Bastien Guerry]

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

Ihor Radchenko <yantar92@posteo.net> writes:

> I cannot see any obvious problem with the layout and no objection have
> been raised by the Emacs devs, so I am inclined to merge the patch
> except the incorrect key binding change.

The vast majority of Emacs refcards is using A4 layout, which I
think is fine for the Org refcard.

Attached are the current version and the one with the new layout. 
I do like the current version better, even for the (1/2) and (2/2)
parts, that I find missing.

José Miguel, what are you exactly trying to fix?  Is it about 
adding flexibility to the layout so that, if needed, one can use
the US letter format?

-- 
 Bastien

[-- Attachment #2: orgcard_new.pdf --]
[-- Type: application/pdf, Size: 118714 bytes --]

[-- Attachment #3: orgcard.pdf --]
[-- Type: application/pdf, Size: 119160 bytes --]

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[José Miguel García Urrutia]

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

Hello Bastien, the current Org refcard cannot be used as a triptych (I’ve
tried with both Letter and A4 paper) in contrast to the Emacs refcard
(which can be used as a triptych when printed with Letter paper).

When checking its Tex source code, I’ve found that there are some
parameters missing and also one of the columns overflows because the title
is too long.

With the patched version I was able to print it in Letter paper and use it
as a triptych, like I did with the Emacs refcard.

Best regards,
José García.

On Sun, 19 Nov 2023 at 15:10 Bastien Guerry <bzg@gnu.org> wrote:

> Ihor Radchenko <yantar92@posteo.net> writes:
>
> > I cannot see any obvious problem with the layout and no objection have
> > been raised by the Emacs devs, so I am inclined to merge the patch
> > except the incorrect key binding change.
>
> The vast majority of Emacs refcards is using A4 layout, which I
> think is fine for the Org refcard.
>
> Attached are the current version and the one with the new layout.
> I do like the current version better, even for the (1/2) and (2/2)
> parts, that I find missing.
>
> José Miguel, what are you exactly trying to fix?  Is it about
> adding flexibility to the layout so that, if needed, one can use
> the US letter format?
>
> --
>  Bastien
>

[-- Attachment #2: Type: text/html, Size: 3044 bytes --]

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Ihor Radchenko]

José Miguel García Urrutia <josemgu91@gmail.com> writes:

> Hello Bastien, the current Org refcard cannot be used as a triptych (I’ve
> tried with both Letter and A4 paper) in contrast to the Emacs refcard
> (which can be used as a triptych when printed with Letter paper).
> ..
> With the patched version I was able to print it in Letter paper and use it
> as a triptych, like I did with the Emacs refcard.

Before I proceed, may I know if you have FSF copyright assignment?

Also, may you update the patch against the Org mode repository
(https://git.savannah.gnu.org/cgit/emacs/org-mode.git/), removing the
incorrect key binding change, and adding the commit message as described
in https://orgmode.org/worg/org-contribute.html#commit-messages ?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[José Miguel García Urrutia]

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

Sure I can update the patch. I don't have the ''FSF copyright assignment'',
what's the process for that?

On Mon, Dec 4, 2023 at 7:48 AM Ihor Radchenko <yantar92@posteo.net> wrote:

> José Miguel García Urrutia <josemgu91@gmail.com> writes:
>
> > Hello Bastien, the current Org refcard cannot be used as a triptych (I’ve
> > tried with both Letter and A4 paper) in contrast to the Emacs refcard
> > (which can be used as a triptych when printed with Letter paper).
> > ..
> > With the patched version I was able to print it in Letter paper and use
> it
> > as a triptych, like I did with the Emacs refcard.
>
> Before I proceed, may I know if you have FSF copyright assignment?
>
> Also, may you update the patch against the Org mode repository
> (https://git.savannah.gnu.org/cgit/emacs/org-mode.git/), removing the
> incorrect key binding change, and adding the commit message as described
> in https://orgmode.org/worg/org-contribute.html#commit-messages ?
>
> --
> Ihor Radchenko // yantar92,
> Org mode contributor,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>
>

[-- Attachment #2: Type: text/html, Size: 2110 bytes --]

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[José Miguel García Urrutia]

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

Also, what's the difference between the org-cards in the Emacs (
https://git.savannah.gnu.org/cgit/emacs.git/tree/etc/refcards/orgcard.tex)
and Org Mode (
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/doc/orgcard.tex)
repositories? Seems that the Emacs one is more up to date and that the Org
Mode one is missing some variables (e.g. orgversionnumber).

Do you want me to update both?

On Mon, Dec 4, 2023 at 12:58 PM José Miguel García Urrutia <
josemgu91@gmail.com> wrote:

> Sure I can update the patch. I don't have the ''FSF copyright
> assignment'', what's the process for that?
>
> On Mon, Dec 4, 2023 at 7:48 AM Ihor Radchenko <yantar92@posteo.net> wrote:
>
>> José Miguel García Urrutia <josemgu91@gmail.com> writes:
>>
>> > Hello Bastien, the current Org refcard cannot be used as a triptych
>> (I’ve
>> > tried with both Letter and A4 paper) in contrast to the Emacs refcard
>> > (which can be used as a triptych when printed with Letter paper).
>> > ..
>> > With the patched version I was able to print it in Letter paper and use
>> it
>> > as a triptych, like I did with the Emacs refcard.
>>
>> Before I proceed, may I know if you have FSF copyright assignment?
>>
>> Also, may you update the patch against the Org mode repository
>> (https://git.savannah.gnu.org/cgit/emacs/org-mode.git/), removing the
>> incorrect key binding change, and adding the commit message as described
>> in https://orgmode.org/worg/org-contribute.html#commit-messages ?
>>
>> --
>> Ihor Radchenko // yantar92,
>> Org mode contributor,
>> Learn more about Org mode at <https://orgmode.org/>.
>> Support Org development at <https://liberapay.com/org-mode>,
>> or support my work at <https://liberapay.com/yantar92>
>>
>

[-- Attachment #2: Type: text/html, Size: 3113 bytes --]

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Kyle Meyer]

José Miguel García Urrutia writes:

> Also, what's the difference between the org-cards in the Emacs (
> https://git.savannah.gnu.org/cgit/emacs.git/tree/etc/refcards/orgcard.tex)
> and Org Mode (
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/doc/orgcard.tex)
> repositories? Seems that the Emacs one is more up to date and that the Org
> Mode one is missing some variables (e.g. orgversionnumber).

Here is the difference between the two cards, as of the last sync:

  # in Org repo
  $ git diff release_9.6.11..origin/emacs-sync -- doc/orgcard.tex
  diff --git a/doc/orgcard.tex b/doc/orgcard.tex
  index 13e8b8d7a..4b73a544e 100644
  --- a/doc/orgcard.tex
  +++ b/doc/orgcard.tex
  @@ -1,5 +1,7 @@
   % Reference Card for Org Mode
  -\input org-version.tex
  +\def\orgversionnumber{9.6.11}
  +\def\versionyear{2023}          % latest update
  +\input emacsver.tex
   
   %**start of header
   \newcount\columnsperpage
  @@ -77,6 +79,9 @@
   \centerline{Released under the terms of the GNU General Public License}
   \centerline{version 3 or later.}
   
  +\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
  +\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
  +
   \endgroup}
   
   % make \bye not \outer so that the \def\bye in the \else clause below

So there are some adjustments for the Emacs tree (e.g., don't depend on
Org's generated org-version.tex and include Emacs's generated
etc/refcards/emacsver.tex).

> Do you want me to update both?

You can just update the card on Org's side; the changes will be
propagated.

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Ihor Radchenko]

José Miguel García Urrutia <josemgu91@gmail.com> writes:

> Sure I can update the patch. I don't have the ''FSF copyright assignment'',
> what's the process for that?

See https://orgmode.org/worg/org-contribute.html#copyright
Note that you do not strictly need it to get this particular patch
merged. However, if you plan to contribute further, we will require the
paperwork once your total contribution surpasses 15LOCs of code.

For now, since you don't have the copyright assignment, you can simply
add "TINYCHANGE" at the end of the commit message, as described in
https://orgmode.org/worg/org-contribute.html#first-patch (item 8).

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Ihor Radchenko]

Kyle Meyer <kyle@kyleam.com> writes:

> Here is the difference between the two cards, as of the last sync:
>
>   -\input org-version.tex
>   +\def\orgversionnumber{9.6.11}
>   +\def\versionyear{2023}          % latest update
>   +\input emacsver.tex
> ...
>   +\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
>   +\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
>   +

Aside: It appears to be only partially documented in
https://orgmode.org/worg/org-maintenance.html#emacs-sync. In particular,
the last two lines.

May we just add

>   +\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
>   +\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}

to Org repo?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Kyle Meyer]

Ihor Radchenko writes:

> Kyle Meyer <kyle@kyleam.com> writes:
>
>> Here is the difference between the two cards, as of the last sync:
>>
>>   -\input org-version.tex
>>   +\def\orgversionnumber{9.6.11}
>>   +\def\versionyear{2023}          % latest update
>>   +\input emacsver.tex
>> ...
>>   +\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
>>   +\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
>>   +
>
> Aside: It appears to be only partially documented in
> https://orgmode.org/worg/org-maintenance.html#emacs-sync. In particular,
> the last two lines.

I'm happy to clarify or add to those docs.  I didn't write them, but I
did go through them somewhat recently to better align them with the
actual porting/syncing process.

With respect to the emacs-sync branch, that page currently says

  Typically, Org can be synchronized by copying over files from the
  emacs-sync branch of the Org repository to the master branch of Emacs
  repository. The emacs-sync branch has a few extra changes compared
  with the bugfix branch

Would you like me to add more details about why the branch exists?  How
it's managed?  Something else?

> May we just add
>
>>   +\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
>>   +\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
>
> to Org repo?

These lines (or rather what became these lines) were added in Emacs's
4af5981dc75 (Add a comment in generated refcards about the source,
2016-11-17).  I decided to port that commit to emacs-sync rather than a
primary Org branch because I felt it only applied to the Org card
distributed as part of the Emacs tree.  From my notes [*]:

  I'm skipping this because it isn't true when the card is from the Org
  mode repo.

However, if you prefer to include those lines in Org's copy, that's fine
by me.


[*] https://git.kyleam.com/orgmode-backport-notes/tree/orgmode-backports.org?id=35eaf5a21dc776c9f7a880d0a4bf9ffc48213985#n3464

Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Ihor Radchenko]

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

Kyle Meyer <kyle@kyleam.com> writes:

>> Aside: It appears to be only partially documented in
>> https://orgmode.org/worg/org-maintenance.html#emacs-sync. In particular,
>> the last two lines.
>
> I'm happy to clarify or add to those docs.  I didn't write them, but I
> did go through them somewhat recently to better align them with the
> actual porting/syncing process.
>
> With respect to the emacs-sync branch, that page currently says
>
>   Typically, Org can be synchronized by copying over files from the
>   emacs-sync branch of the Org repository to the master branch of Emacs
>   repository. The emacs-sync branch has a few extra changes compared
>   with the bugfix branch
>
> Would you like me to add more details about why the branch exists?  How
> it's managed?  Something else?

I think that a reference to
https://git.kyleam.com/orgmode-backport-notes/tree/orgmode-backports.org#n2
might be helpful. Maybe we should even have that file in the main repo
as a part of emacs-sync branch?

>> May we just add
>>
>>>   +\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
>>>   +\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
>>
>> to Org repo?
>
> These lines (or rather what became these lines) were added in Emacs's
> 4af5981dc75 (Add a comment in generated refcards about the source,
> 2016-11-17).  I decided to port that commit to emacs-sync rather than a
> primary Org branch because I felt it only applied to the Org card
> distributed as part of the Emacs tree.  From my notes [*]:
>
>   I'm skipping this because it isn't true when the card is from the Org
>   mode repo.
>
> However, if you prefer to include those lines in Org's copy, that's fine
> by me.

I can see the point. Although, I feel like accumulating such divergence
may backfire after some time. May we possibly resolve the conflict
properly using something like the attached patch?
Then, we can use the same orgcard source but have orgcardemacsnotice.tex
empty in Org repository.

Are there other similar conflicts in emacs-sync branch?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-etc-refcards-orgcard.tex-Put-Emacs-specific-part-int.patch --]
[-- Type: text/x-patch, Size: 1858 bytes --]

From 23a6b95b4755a7a2251e89db6ed91ac8637a8035 Mon Sep 17 00:00:00 2001
Message-ID: <23a6b95b4755a7a2251e89db6ed91ac8637a8035.1701871917.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Wed, 6 Dec 2023 15:09:59 +0100
Subject: [PATCH] etc/refcards/orgcard.tex: Put Emacs-specific part into a
 separate file

* etc/refcards/orgcardemacsnotice.tex: New file containing
Emacs-specific copyright notice.  This is to be kept in Emacs
repository.
* etc/refcards/orgcard.tex: Include the new file, so that we do not
need to maintain divergence between Org repository version of orgcard
and the Emacs version.  The Org version does not refer to Emacs
distribution and the original source.

Link: https://orgmode.org/list/87ttowt89m.fsf@kyleam.com
---
 etc/refcards/orgcard.tex            | 3 +--
 etc/refcards/orgcardemacsnotice.tex | 2 ++
 2 files changed, 3 insertions(+), 2 deletions(-)
 create mode 100644 etc/refcards/orgcardemacsnotice.tex

diff --git a/etc/refcards/orgcard.tex b/etc/refcards/orgcard.tex
index 4b73a544e80..9d875e0f201 100644
--- a/etc/refcards/orgcard.tex
+++ b/etc/refcards/orgcard.tex
@@ -79,8 +79,7 @@
 \centerline{Released under the terms of the GNU General Public License}
 \centerline{version 3 or later.}
 
-\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
-\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
+\input orgcardemacsnotice.tex
 
 \endgroup}
 
diff --git a/etc/refcards/orgcardemacsnotice.tex b/etc/refcards/orgcardemacsnotice.tex
new file mode 100644
index 00000000000..ce7117c2330
--- /dev/null
+++ b/etc/refcards/orgcardemacsnotice.tex
@@ -0,0 +1,2 @@
+\centerline{For more Emacs documentation, and the \TeX{} source for this card, see}
+\centerline{the Emacs distribution, or {\tt https://www.gnu.org/software/emacs}}
-- 
2.42.0


[-- Attachment #3: Type: text/plain, Size: 224 bytes --]


-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Kyle Meyer]

Ihor Radchenko writes:

> I think that a reference to
> https://git.kyleam.com/orgmode-backport-notes/tree/orgmode-backports.org#n2
> might be helpful.

Okay, I'll make a note to add one.

> Maybe we should even have that file in the main repo as a part of
> emacs-sync branch?

I prefer not to.  I intended that branch to track the state of Org files
that are synced, not to store auxiliary logs.

> I can see the point. Although, I feel like accumulating such divergence
> may backfire after some time.

How do you see this particular spot backfiring?  If Emacs changes the
Emacs-specific text (as they did once in 2016), I port that to the
emacs-sync branch.  Or if Org changes neighboring text, I resolve the
conflict on merge into emacs-sync (very likely just taking both sides).
The resolution is recorded for anyone to look back on.

The emacs-sync branch provides a transparent way to keep track of the
limited set of Emacs-specific modifications needed for the sync.  We're
not talking about an ever-growing set of changes.

> May we possibly resolve the conflict properly using something like the
> attached patch?  Then, we can use the same orgcard source but have
> orgcardemacsnotice.tex empty in Org repository.

I don't see what problem it solves.  It's moving the divergence to a
different file (that would still be tracked in emacs-sync), and it adds
one more Org-specific wrinkle to the Emacs tree.  (Also, the orgcard
source would still be different given the upstream hunk in the diff I
posted in my last message.)

> Are there other similar conflicts in emacs-sync branch?

The emacs-sync branch has other Emacs-specific modifications, yes.
Again, keeping track of those is the reason it exists.

  $ git diff --stat bugfix...emacs-sync
   .gitignore                           |  1 -
   doc/{doc-setup.org => org-setup.org} |  2 +-
   doc/{org-manual.org => org.org}      |  4 ++--
   doc/orgcard.tex                      |  7 ++++++-
   etc/schema/schemas.xml               | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   lisp/org-version.el                  | 24 ++++++++++++++++++++++++
   6 files changed, 90 insertions(+), 5 deletions(-)

Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Ihor Radchenko]

Kyle Meyer <kyle@kyleam.com> writes:

>> Maybe we should even have that file in the main repo as a part of
>> emacs-sync branch?
>
> I prefer not to.  I intended that branch to track the state of Org files
> that are synced, not to store auxiliary logs.
> ...
> The emacs-sync branch provides a transparent way to keep track of the
> limited set of Emacs-specific modifications needed for the sync.  We're
> not talking about an ever-growing set of changes.
> ...
> The emacs-sync branch has other Emacs-specific modifications, yes.
> Again, keeping track of those is the reason it exists.
>
>   $ git diff --stat bugfix...emacs-sync
>    .gitignore                           |  1 -
>    doc/{doc-setup.org => org-setup.org} |  2 +-
>    doc/{org-manual.org => org.org}      |  4 ++--
>    doc/orgcard.tex                      |  7 ++++++-
>    etc/schema/schemas.xml               | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>    lisp/org-version.el                  | 24 ++++++++++++++++++++++++
>    6 files changed, 90 insertions(+), 5 deletions(-)

I see now. I guess I did not really have a full understanding of the
purpose of emacs-sync. So, it might be helpful to add a similar
explanation to worg/org-maintenance.org.

>> I can see the point. Although, I feel like accumulating such divergence
>> may backfire after some time.
>
> How do you see this particular spot backfiring?  If Emacs changes the
> Emacs-specific text (as they did once in 2016), I port that to the
> emacs-sync branch.  Or if Org changes neighboring text, I resolve the
> conflict on merge into emacs-sync (very likely just taking both sides).
> The resolution is recorded for anyone to look back on.

I was mainly concerned about complex conflicts that might
(theoretically) occur. But it indeed does not matter if the conflicts
are limited and manageable.

>> May we possibly resolve the conflict properly using something like the
>> attached patch?  Then, we can use the same orgcard source but have
>> orgcardemacsnotice.tex empty in Org repository.
>
> I don't see what problem it solves.  It's moving the divergence to a
> different file (that would still be tracked in emacs-sync), and it adds
> one more Org-specific wrinkle to the Emacs tree.  (Also, the orgcard
> source would still be different given the upstream hunk in the diff I
> posted in my last message.)

My idea was not to sync that another extra file at all and leave it in
Emacs repo only. But the same will not work for xml and other diverging
files. I now don't see any reason to change the existing state of affairs.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: Syncing orgcard.tex with upstream Emacs (was: bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.)

[Kyle Meyer]

Ihor Radchenko writes:

> I see now. I guess I did not really have a full understanding of the
> purpose of emacs-sync. So, it might be helpful to add a similar
> explanation to worg/org-maintenance.org.

Okay, I'll plan to do that.

>> I don't see what problem it solves.  It's moving the divergence to a
>> different file (that would still be tracked in emacs-sync), and it adds
>> one more Org-specific wrinkle to the Emacs tree.  (Also, the orgcard
>> source would still be different given the upstream hunk in the diff I
>> posted in my last message.)
>
> My idea was not to sync that another extra file at all and leave it in
> Emacs repo only.

I see.  Not that it matters given what you say below, but I would
probably lean toward keeping track of such a file in emacs-sync.

> But the same will not work for xml and other diverging
> files. I now don't see any reason to change the existing state of affairs.

All right, thanks for your input.  I'll try to improve
worg/org-maintenance.org as discussed.

bug#64578: orgcard.tex fixes to allow PDF rendering to be used as a triptych.

[Ihor Radchenko]

Ihor Radchenko <yantar92@posteo.net> writes:

> For now, since you don't have the copyright assignment, you can simply
> add "TINYCHANGE" at the end of the commit message, as described in
> https://orgmode.org/worg/org-contribute.html#first-patch (item 8).

Applied, onto main; with amendments.
I removed the key binding change, reworded the commit message, and added
TINYCHANGE cookie.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=490260ceb

You are also now added to the contributor list.
https://git.sr.ht/~bzg/worg/commit/cdf90ad3

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>