[ELPA] Submitting new package Org-remark

[ELPA] Submitting new package Org-remark

[Noboru Ota]

Hi everyone,

Wishing you all Happy Year 2022.

I would like to submit a new package named "Org-remark" to ELPA.
It lets you highlight and annotate any text file with using Org mode.

- GitHub repository: https://github.com/nobiot/org-remark

- A 8-minute introductory video is available on YouTube at https://youtu.be/c8DHrAsFiLc

I would appreciate it if someone could advise if my request should be
acceptable.

If the request is acceptable, I believe the ELPA spec definition should
be set as follows (this is based on my other package, Org-transclusion)


---
 ("org-remark"	:url "https://github.com/nobiot/org-remark"
   :make "README-elpa"
   :doc "docs/org-remark.org"
   :auto-sync t)
---


Thank you and have a great weekend.
Noboru

Re: [ELPA] Submitting new package Org-remark

[Stefan Monnier]

> I would like to submit a new package named "Org-remark" to ELPA.

Looks good, added,
[ I used `README.org` for the readme, instead of :make "README-elpa", tho  ]


        Stefan

Re: [ELPA] Submitting new package Org-remark

[Noboru Ota]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> Looks good, added,
> [ I used `README.org` for the readme, instead of :make "README-elpa", tho  ]

Thank you, Stefan.

Could we discuss the use of `README.org` and `README-elpa` a bit
further, please? Perhaps we need both :readme and :make specs.

I would like to use an ASCII export of README.org, not the raw
README.org file for the package description.

Currently, `describe-package' shows the raw `README.org` *after* the
package has been installed.  I have observed the following details
below, and thought I should generate `README-elpa` to have the same
`README` before and after installation of package. This way, I can also
have a link to an Info node directly within the description (I provide
an Info node as a user manual).


Observation below in Emacs 27.2 on Windows and Emacs 29.0.50 on Ubuntu
Linux:

1. Before the user installs a package, `describe-package` (and
   `package-list-packages`) displays `package-name-readme.txt`.  ELPA
   generates it and when `README.org` is used as the README file, it
   gets exported to ASCII plain text (I believe this is done in
   functions `elpaa--get-README' and `elpaa--section-to-plain-text' in
   elpa-admin.el)


2. After the user has installed a package, `describe-package` (and
   `package-list-packages`) displays one of these files: "README-elpa"
   "README-elpa.md" "README" "README.rst" "README.org".  When
   `README.org` is used, the raw text is displayed without being
   exported to ASCII format (I believe this is done in function
   `describe-package-1' and `package--get-description')


Warm regards,
Noboru

Re: [ELPA] Submitting new package Org-remark

[Stefan Monnier]

[ BTW, your package didn't build yet because of:

    ======== Building tarball archive-devel/org-remark-0.2.0.0.20220129.95541.tar...
    Problem with copyright notices:
    Missing copyright notice in org-remark/demo/custom-pens.el
    Build error for archive-devel/org-remark-0.2.0.0.20220129.95541.tar: (error "Abort")
    ######## Build of package archive-devel/org-remark-0.2.0.0.20220129.95541.tar FAILED!! ]

> I would like to use an ASCII export of README.org, not the raw
> README.org file for the package description.

The current scripts generate an HTML version of `README.org` for the
webpage and an ASCII version for the `<pkg>-readme.txt` (used by
`list-packages`) from the :readme, so I think it should be better
overall, and it definitely should not use the raw Org text any more.

> Currently, `describe-package' shows the raw `README.org` *after* the
> package has been installed.

This should depend on when the package was built: the scripts were
changed a month or two ago and they only affect those packages that have
been rebuilt since.

> 1. Before the user installs a package, `describe-package` (and
>    `package-list-packages`) displays `package-name-readme.txt`.  ELPA
>    generates it and when `README.org` is used as the README file, it
>    gets exported to ASCII plain text (I believe this is done in
>    functions `elpaa--get-README' and `elpaa--section-to-plain-text' in
>    elpa-admin.el)

That's right.

> 2. After the user has installed a package, `describe-package` (and
>    `package-list-packages`) displays one of these files: "README-elpa"
>    "README-elpa.md" "README" "README.rst" "README.org".  When
>    `README.org` is used, the raw text is displayed without being
>    exported to ASCII format (I believe this is done in function
>    `describe-package-1' and `package--get-description')

Oh, my!  You're absolutely right.  I wasn't aware of this code in
`describe-packages`.  We should improve it to use the same approach as
in `elpaa--get-README` and `elpaa--section-to-plain-text` (tho maybe
using some other part of Org which renders directly in an Emacs buffer
rather than a txt file, so it looks better).

There's also the problem that `describe-package` doesn't have access to the
spec we put in `elpa-packages`, so it can only guess which README file
to use based on a heuristic.

Any chance you'd be interested in improving `describe-package`?


        Stefan

Re: [ELPA] Submitting new package Org-remark

[Noboru Ota]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> [ BTW, your package didn't build yet because of:

>     ======== Building tarball
>     archive-devel/org-remark-0.2.0.0.20220129.95541.tar...  Problem
>     with copyright notices: Missing copyright notice in
>     org-remark/demo/custom-pens.el Build error for

Thank you, Stefan.

I see.  I assumed `.elpaignore` would also get applied to copyright check
function, but I just learned that it is not the case.

I have a feeling that `elpa-admin.el' could have a patch so that it
would also use `.elpaignore' to filter out `.el' files to check copyright
assignment?  Function `elpaa--copyright-files' looks at `:ignored-files'
spec but not `.elpaignore' like function `elpaa--make-one-tarball-1'
does.


> Any chance you'd be interested in improving `describe-package`?

Interested, yes.  I will need some time to get round to it (I have another
request from you regarding `text-clone'; I have not forgotten about it).

If the time is not an issue, I will see what I can do.  I have a big
life event coming in October this year and my mind is already being
consumed by it (Org-remark is last project hanging off from the last year).  Of course, others can jump in and do what is suggested.



Thanks again.
Noboru

Re: [ELPA] Submitting new package Org-remark

[Stefan Monnier]

Noboru Ota [2022-01-30 10:37:52] wrote:
> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> [ BTW, your package didn't build yet because of:
>>     ======== Building tarball
>>     archive-devel/org-remark-0.2.0.0.20220129.95541.tar...  Problem
>>     with copyright notices: Missing copyright notice in
>>     org-remark/demo/custom-pens.el Build error for
>
> Thank you, Stefan.
>
> I see.  I assumed `.elpaignore` would also get applied to copyright check
> function, but I just learned that it is not the case.
>
> I have a feeling that `elpa-admin.el' could have a patch so that it
> would also use `.elpaignore' to filter out `.el' files to check copyright
> assignment?  Function `elpaa--copyright-files' looks at `:ignored-files'
> spec but not `.elpaignore' like function `elpaa--make-one-tarball-1'
> does.

Patch welcome ;-)

>> Any chance you'd be interested in improving `describe-package`?
> Interested, yes.  I will need some time to get round to it (I have another
> request from you regarding `text-clone'; I have not forgotten about it).
> If the time is not an issue, I will see what I can do.

No worries: if someone else gets to it before you do, I'm sure we'll
find something else enticing for you to do ;-)


        Stefan

Re: [ELPA] Submitting new package Org-remark

[Uwe Brauer]

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

>>> "NO" == Noboru Ota <me@nobiot.com> writes:
Hi


> Hi everyone,
> Wishing you all Happy Year 2022.

The same to you
> I would like to submit a new package named "Org-remark" to ELPA.
> It lets you highlight and annotate any text file with using Org mode.

That looks very interesting, but I believe from the video that it can
work in other modes as well?

> - GitHub repository: https://github.com/nobiot/org-remark

I have some problems with the package: I am running org-mode 9.5
(actually master from a couple a weeks ago) and GNU emacs 29 (actually
master from a couple a weeks ago)

    1. When I clone the repository, and then  want to open it (I might to edit the
       makefile) but then I obtain a message concerning the setting of
       variables because of the presence of .dir-locals.el. Is this
       really necessary.

    2. When I then want to compile the files it does not work, since I
       did not had in set (setq load-path (cons (expand-file-name "~/ALLES/src/org-remark") load-path))

    3. There is a keybinding problem, at least for me:
       (define-key global-map (kbd "C-c n m") #'org-remark-mark)
       gives the following error, I attach

Regards

Uwe Brauer 



[-- Attachment #1.2: remark-bug.txt --]
[-- Type: text/plain, Size: 4904 bytes --]

Debugger entered--Lisp error: (error "Key sequence C-c n m starts with non-prefix key C-...")
  define-key((keymap #^[nil nil keymap 
#^^[3 0 set-mark-command move-beginning-of-line backward-char mode-specific-command-prefix delete-char move-end-of-line forward-char keyboard-quit help-command indent-for-tab-command electric-newline-and-maybe-indent kill-line recenter-top-bottom newline next-line open-line previous-line quoted-insert isearch-backward isearch-forward transpose-chars universal-argument scroll-up-command kill-region Control-X-prefix yank suspend-frame ESC-prefix dabbrev-expand abort-recursive-edit nil undo self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command match-paren self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command ...] #^^[1 0 #^^[2 0 
#^^[3 0 set-mark-command move-beginning-of-line backward-char mode-specific-command-prefix delete-char move-end-of-line forward-char keyboard-quit help-command indent-for-tab-command electric-newline-and-maybe-indent kill-line recenter-top-bottom newline next-line open-line previous-line quoted-insert isearch-backward isearch-forward transpose-chars universal-argument scroll-up-command kill-region Control-X-prefix yank suspend-frame ESC-prefix dabbrev-expand abort-recursive-edit nil undo self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command match-paren self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command ...] self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command] self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command] self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command self-insert-command ...] (s-home . org-transclusion-make-from-link) (s-f12 . org-transclusion-add) (S-prior . my-toggle-input) (S-backspace . copy-region-as-kill) (C-M-backspace . byte-compile-and-load-file) (S-home . flyspell-auto-correct-word) (s-backspace . comment-region) (16777219 . my-insert-coding-string-simple) (16777315 . my-insert-coding-string) (16777321 . my-toggle-iso-accentuate-buffer) (16777332 . ahg-tags) (16777323 . ahg-do-command) (8388705 . auto-fill-mode) (8388609 . cfw:open-org-calendar) (pause . bbdb) (C-print . flyspell-auto-correct-word) (print . flyspell-auto-correct-word) (C-M-next . my-comment-mail) (C-M-prior . byte-compile-and-load-file) (8388722 . copy-to-buffer) (16777262 . org-time-stamp) (8388654 . my-insert-guillemotright) (8388652 . my-insert-guillemotleft) (8388667 . comment-dwim) (M-up . move-text-up) (M-down . move-text-down) (M-delete . ediff-regions-wordwise) (C-M-delete . ediff-files) (67108924 . mark-beginning-of-buffer) (67108926 . mark-end-of-buffer) (8388611 . pandoc-org-2-various) (8388707 . org-capture) (16777337 . browse-kill-ring) (8388729 . browse-kill-ring) (25165932 . org-annotate-file) (8388716 . my-toggle-virtual-fill) (16777228 . my-toggle-locale-es-de-us) (8388713 . vc-register) (16777328 . count-words-page) (8388724 . vc-create-tag) (8388726 . vc-print-log) (16777334 . my-refresh-vc-stuff) ...) "\3nm" org-remark-mark)
  eval((define-key global-map (kbd "C-c n m") #'org-remark-mark) nil)
  elisp--eval-last-sexp(nil)
  eval-last-sexp(nil)
  funcall-interactively(eval-last-sexp nil)
  call-interactively(eval-last-sexp nil nil)
  command-execute(eval-last-sexp)

[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]