all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Some links in online manual do not work
Date: Wed, 12 Oct 2022 12:14:23 +0700	[thread overview]
Message-ID: <ti5ifn$7g1$1@ciao.gmane.io> (raw)
In-Reply-To: <87a661he9o.fsf@gnu.org>

On 12/10/2022 11:11, Bastien Guerry wrote:
> Max Nikulin writes:
> 
>> If redirection directives were included as separate files then it
>> would be possible to just check them by a command like
>>
>>      awk '{ if ($NF >= 3) print $3; }' /tmp/manual.txt  |
>>          xargs --replace -- \
>>          curl --head --write-out '%{http_code} %{url_effective}\n' \
>>              --silent --show-error --output /dev/null \
>>              'https://orgmode.org/manual/{}'
> 
> https://git.sr.ht/~bzg/worg/tree/master/item/nginx.conf contains the
> list of redirections -- the checks could be done from here, right?

It is not hard to copy text from nginx.conf to separate text files. 
Implementing nginx parser to filter only manual or just guide rules is 
more tricky. My opinion, the following structure is even more convenient 
to maintain:

nginx.conf:
# ...
     rewrite ^/list(.*) https://list.orgmode.org$1 permanent;

     location /manual {
         include manual-rewrite.inc;
     }
     location /guide {
         include guide-rewrite.inc;
     }
}
# ...

manual-rewrite.inc:

rewrite /Add_002don-packages\.html Add_002don-Packages.html permanent;
rewrite /Adding-export-back_002dends\.html 
Adding-Export-Back_002dends.html permanent;
rewrite /Adding-hyperlink-Types\.html Adding-Hyperlink-Types.html permanent;
# ...

I suggested it assuming tracking of changes in the manual. If you are 
against it then this list is almost static and regular check is less 
important. However it might catch removing of a section that is a 
redirection target.

>> Original proposal to add redirections contained an s-expression with
>> mappings. I would consider tracking it in the main Org repository. I
>> believe, list of info nodes in the released manual should be added to
>> it as known names.
> 
> I'm not sure I understand.  Nothing should be added to the main Org
> repository to fix a problem with the orgmode.org website, even if it
> is a problem with the HTML manual as produced from org-mode.git.

I do not insist. The idea was to put a file that is tightly bound to 
contents and edit history of manual close to the source of the docs 
since a script that can detect necessary changes requires list of HTML 
files generated from org-manual.org.

> But more complex rewrite rules (from old manual nodes to new ones) is
> IMHO calling for trouble. What if we split the "Properties and Column"
> manual page into "Properties" and "Columns"?  Where to redirect?

 From my point of view, any variant is better than 404. Alternatively 
redirection target may be an anchor to any of the new items in the table 
of contents.

Thank you for restoring rewrite rules. After earlier Tim's messages I 
was quite pessimistic believing that such attempt of improvement was buried.




  reply	other threads:[~2022-10-12  5:16 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-02 20:00 Some links in online manual do not work Tim Landscheidt
2022-10-02 21:04 ` Tim Cross
2022-10-03  3:52   ` Ihor Radchenko
2022-10-05 17:48   ` Tim Landscheidt
2022-10-06  4:17     ` Ihor Radchenko
2022-10-06 12:14       ` Tim Landscheidt
2022-10-07 15:33       ` Bastien Guerry
2022-10-07 19:50         ` Tim Landscheidt
2022-10-08  6:28           ` Ihor Radchenko
2022-10-08 12:37           ` Max Nikulin
2022-10-11  5:37             ` Bastien
2022-10-11  6:57               ` Max Nikulin
2022-10-11  7:57                 ` Bastien
2022-10-11  8:33                   ` Max Nikulin
2022-10-11  9:09                     ` Bastien
2022-10-11 16:51                       ` Max Nikulin
2022-10-11 17:06                         ` Bastien Guerry
2022-10-12  3:06                           ` Max Nikulin
2022-10-12  4:11                             ` Bastien Guerry
2022-10-12  5:14                               ` Max Nikulin [this message]
2022-10-16 12:11                           ` Tim Landscheidt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='ti5ifn$7g1$1@ciao.gmane.io' \
    --to=manikulin@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.