From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: "Felix E. Klee" Newsgroups: gmane.emacs.bugs Subject: bug#32359: [PATCH] Add svg-path Date: Thu, 23 Aug 2018 17:50:08 +0200 Message-ID: References: <83zhy3txbv.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1535039353 30257 195.159.176.226 (23 Aug 2018 15:49:13 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 23 Aug 2018 15:49:13 +0000 (UTC) Cc: 32359@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Aug 23 17:49:09 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fsrrA-0007ka-5Q for geb-bug-gnu-emacs@m.gmane.org; Thu, 23 Aug 2018 17:49:08 +0200 Original-Received: from localhost ([::1]:37392 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fsrtG-0007qI-Jo for geb-bug-gnu-emacs@m.gmane.org; Thu, 23 Aug 2018 11:51:18 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:42192) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fsrt3-0007og-3F for bug-gnu-emacs@gnu.org; Thu, 23 Aug 2018 11:51:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fsrsz-0000ox-Ul for bug-gnu-emacs@gnu.org; Thu, 23 Aug 2018 11:51:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:54008) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fsrsz-0000oj-PN for bug-gnu-emacs@gnu.org; Thu, 23 Aug 2018 11:51:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fsrsz-0007rr-LQ for bug-gnu-emacs@gnu.org; Thu, 23 Aug 2018 11:51:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Felix E. Klee" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 23 Aug 2018 15:51:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 32359 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 32359-submit@debbugs.gnu.org id=B32359.153503941430189 (code B ref 32359); Thu, 23 Aug 2018 15:51:01 +0000 Original-Received: (at 32359) by debbugs.gnu.org; 23 Aug 2018 15:50:14 +0000 Original-Received: from localhost ([127.0.0.1]:59026 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fsrsD-0007qq-OY for submit@debbugs.gnu.org; Thu, 23 Aug 2018 11:50:13 -0400 Original-Received: from quechua.inka.de ([193.197.184.2]:32948 helo=mail.inka.de) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fsrsC-0007qi-0A for 32359@debbugs.gnu.org; Thu, 23 Aug 2018 11:50:12 -0400 Original-Received: from mail-io0-f173.google.com (mail-io0-f173.google.com [209.85.223.173]) by mail.inka.de with esmtpsa id 1fsrsA-0003zF-Gy; Thu, 23 Aug 2018 17:50:10 +0200 Original-Received: by mail-io0-f173.google.com with SMTP id y10-v6so4658707ioa.10 for <32359@debbugs.gnu.org>; Thu, 23 Aug 2018 08:50:10 -0700 (PDT) X-Gm-Message-State: APzg51AKida5ND4f25izZgxishtuXWUoIl7iJ+zeszLj0mSxf092JqhE 7m+YPnZHNX1KNjfDVRUlp/35nVcGsbqIyQJ1D79a4Q== X-Google-Smtp-Source: ANB0VdY05gkE/gCLHCDwn6thId/W8MgoPLttnph508Ze2tGhUczan+BtSuDYALCBSp7a+dfIxPthR4Y6pvzN5TmMZHg= X-Received: by 2002:a6b:2407:: with SMTP id k7-v6mr15127586iok.275.1535039409521; Thu, 23 Aug 2018 08:50:09 -0700 (PDT) Original-Received: by 2002:a6b:258a:0:0:0:0:0 with HTTP; Thu, 23 Aug 2018 08:50:08 -0700 (PDT) X-Originating-IP: [80.187.104.174] In-Reply-To: <83zhy3txbv.fsf@gnu.org> X-Gmail-Original-Message-ID: X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:149696 Archived-At: Hi Eli, thanks for the feedback! On 8/3/18, Eli Zaretskii wrote: > We don't maintain a ChangeLog file; the above should be the commit > log message. Well, the Emacs info page on committing patches states: =E2=80=9CWrite the change log entries for your changes. [=E2=80=A6]=E2=80=9D Furthermore, it links to a page explaining `ChangeLog' files in particular. Is that documentation outdated? `ChangeLog.3' contains entries for previous additions to `svg.el', the latest one as recent as September 2017. Anyhow, if you want a commit log instead of a `ChangeLog' entry, how should I submit the commit? >> +@defun svg-path svg commands &rest args >> +Add the outline of a shape to @var{svg}. The @var{commands} follow the >> +Scalable Vector Graphics standard. This function can be used to create >> +arcs. > > This is too cryptic for the manual, It=E2=80=99s basically in line with the description for the other `svg' fun= ctions. > and the example doesn't help enough. For the intended audience, i.e. those knowing how to author SVG documents, it should be clear. What I could do is add aliases for the path commands: * `moveto-relative' =E2=86=92 `m' * `moveto-absolute' =E2=86=92 `M' * etc. The example would then turn into: (svg-path svg '((moveto-absolute 100 300) (arc-absolute 300 300 0 0 0 300 100) (closepath-absolute)) :stroke-color "blue" :fill-color "yellow") Still users would need to know the command parameters which are detailed in every comprehensive documentation about SVG. > We should at least explain what "arcs" means in this context, =E2=80=9Carcs=E2=80=9D in the context of SVG, i.e. vector graphics refers t= o curved paths: https://www.merriam-webster.com/dictionary/arc > and in general what is this function about; also what kind of object > is SCG. Quote from the documentation in the elisp info page for `svg.el': =E2=80=9C= SVG (Scalable Vector Graphics) is an XML format for specifying images.=E2=80=9D > In general, GNU Coding Standards frown upon using "path" for > anything that is not PATH-style directory lists, so maybe use a > different name or explain what kind of "path" is being referenced > here. Renaming `path' would be super confusing to those familiar with vector graphics. If `path' needs to be avoided, then I=E2=80=99d rather not add `svg-path'. Instead one could add a more general: svg-node (parent tag &rest args) This function is needed anyhow. It would be for inserting custom SVG nodes, i.e. nodes beyond those currently available in the `svg' package. BTW I got in contact with Lars, the original author of `svg.el', and he=E2=80=99s OK with the changes I proposed, including some additional functions. / Felix