Support freedesktop.org specifications #3287

dcpurton · 2022-03-05T06:02:15Z

dcpurton
Mar 5, 2022
Maintainer

Issue #3278 raises questions of whether and to what extent NeoMutt should provide files supporting the freedesktop.org specs.

This discussion thread provides some relevant specification links, content ideas and place for discussion.

Specifications:

To support the specification NeoMutt would need to:

Provide a .desktop file (installed as /usr/share/applications/org.neomutt.NeoMutt.desktop)
Provide at least one screenshot
Provide a component metadata file (installed as /usr/share/metainfo/org.neomutt.NeoMutt.metainfo.xml)
Install existing contrib/logo/ files in /usr/share/icons/hicolor/<size>/apps/

Considerations:

Which OS support the freedesktop.org standards?
What content should be supplied for descriptions?
What translations should be supplied for the various descriptions?
What are the ongoing efforts required for each release and who will maintain things?

Why bother?

It's true that the freedesktop.org specifications are largely geared towards GUI applications, but specifications work best for a user when everyone plays along, so perhaps it's worth considering.

dcpurton · 2022-03-05T06:07:15Z

dcpurton
Mar 5, 2022
Maintainer Author

`.desktop` file

src location

contrib/org.neomutt.NeoMutt.desktop

install location

/usr/share/applications/org.neomutt.NeoMutt.desktop

dcpurton
Mar 5, 2022
Maintainer Author

Screenshots

These screenshots are taken using contrib/samples/sample.neomuttrc with a 16×9 aspect ratio. The INBOX is the January 2022 neommutt-users mailing list archive.

Note: Screenshots need not be installed.

src location

contrib/screenshots/

Default screenshot

contrib/screenshots/neomutt-screenshot-index.png

Secondary screenshot

contrib/screenshots/neomutt-screenshot-pager.png

10 replies

dcpurton Mar 5, 2022
Maintainer Author

The screenshots need to be "achievable".

Out-of-the-box, NeoMutt looks very dull.
With a few colours, some emoji chars and/or Nerd Fonts we can make NeoMutt look pretty.

I think that whatever we show in the screenshots must be easily reproducable by a beginner.
We should ship the config/theme in contrib/

Yes, this is why I used contrib/sample.neomuttrc.

But this configuration isn't that exciting.

dcpurton Mar 5, 2022
Maintainer Author

Ages ago, I created screenshots (with dummy data) for most dialogs: Screenshots
They come in 80x24 and 100x30 variants (png and svg).

That's a useful resource for type of screenshots. For the purposes of the metadata file it probably only needs a few screenshots though, not every possible one.

The spec suggests using a 16×9 ratio for screen shots with default window decorations (something harder than you imagine when you use a tiling window manager with no window decorations enabled 🙂)

dcpurton Mar 5, 2022
Maintainer Author

We want some screenshots to really sell NeoMutt.

Index + Sidebar
Colours, characters

Index + Pager + Sidebar
Highlighting in the Pager, e.g. a diff

Compose
lots of addressees, multipart attachments

Address book (aliases)
Several tagged entries

Can we add a title to each dialog?
(so that we can tell the view what they're looking at)

The metadata file allows for captions.

What would be the best way to showcase NotMuch?

I confess I don't use NotMuch. But maybe I should?

dcpurton Mar 6, 2022
Maintainer Author

We want some screenshots to really sell NeoMutt.

Perhaps you could have a competition:

Submit your best default screenshot and self contained theme to sell NeoMutt!

Submit name-theme.neomuttrc to be included in the ~/theme-test.neomuttrc below.
Submit a default screen shot which includes the index.
Submit up to 4 other screenshots showing (e.g., pager, attachment lists, compose window, NotMuch integration, etc.
NeoMutt should be run as neomutt -n -F theme-test.neomuttrc.

source "~/neomutt-theme-competition/name-theme.neomuttrc"

unset record
unset signature

set folder = "~/neomutt-theme-competition"
set from = "[email protected]"
set realname = "John Doe"

set spoolfile = "+INBOX"

# set other features you definitely want to showcase, e.g., set sidebar_visible.

# vim: syn=neomuttrc

Screenshot specifications

Screenshot aspect ration should be 16×9.
Terminal window should be between 80 and 100 characters wide.

You could provide INBOX (and other files to showcase the side bar) as suitable sample mbox files. You would want a range of emails that looked real and included PGP signed/encrypted emails, emails with attachments, threads, emojis in subject lines, multipart emails, etc.

The screenshots don't have to be in their final format, since the output should be reproducible and you can makes a series that all match once you settle on a final sample config.

dcpurton Mar 7, 2022
Maintainer Author

Here's a starting point for setting up a colour theme to submit screenshots.

This is similar to the config for one of my accounts except I don't use the sidebar or have the index visible while view messages.

To test unpack attached dcpurton.tar.gz and run:

neomutt -n -F theme-test.neomuttrc

`theme-test.neomuttrc`

unset signature

set folder = "."
set from = "[email protected]"
set mail_check_stats = yes
set postponed = "+Drafts"
set realname = "John Doe"
set read_only = yes
set record = "+Sent"
set sidebar_format = "%D%?F? [%F]?%* %?N?%N/?%S "
set sidebar_visible = yes
set sidebar_width = 20
set spoolfile = "+INBOX"
set trash = "+Bin"

named-mailboxes INBOX +INBOX Sent +Sent Archive +Archive Drafts +Drafts Bin +Bin

bind index,pager \Cj sidebar-next
bind index,pager \Ck sidebar-prev
bind index,pager \Co sidebar-open
bind index,pager \Cv sidebar-toggle-visible

# source theme file
source "./dcpurton-theme.neomuttrc"

# vim: syn=neomuttrc

Screenshot

Config and test files

dcpurton.tar.gz

INBOX contains a few messages with varying structure.

dcpurton · 2022-03-05T06:22:05Z

dcpurton
Mar 5, 2022
Maintainer Author

Upstream metadata

src location

contrib/org.neomutt.NeoMutt.metainfo.xml

install location

/usr/share/metainfo/org.neomutt.NeoMutt.metainfo.xml

suggested content

Notes:

The description below is taken from the Debian package. It probably needs to be re-written.
The release info is taken from the most recent release. It's probably not worth filing in NeoMutt's complete release history.

<?xml version="1.0" encoding="UTF-8"?>
<component type="desktop-application">
  <id>org.neomutt.NeoMutt</id>
  <metadata_license>CC0-1.0</metadata_license>
  <project_license>GPL-2.0+</project_license>
  <name>NeoMutt</name>
  <summary>A text-based Mail User Agent</summary>
  <icon type="remote" width="256" height="256">https://github.com/neomutt/neomutt/raw/master/contrib/logo/neomutt-256.png</icon>

  <description>
    <p>
      NeoMutt is based on Mutt but with added features. It supports all the
      features that are supported by Mutt, including POP and IMAP support, SSL
      encryption and SASL authentication, threading and GPG support.
    </p>
    <p>
      On the top of that, Neomutt provides:
    </p>
    <ul>
      <li>Notmuch: a mail indexing tools that provides advanced features such as
        full-text search, thread reconstruction and added features.</li>
      <li>Color attachment headers using regex, just like mail bodies.</li>
      <li>Custom rules for theming the mail index.</li>
      <li>NNTP support.</li>
      <li>Visual progress bar for slow operations.</li>
      <li>Trash folder.</li>
    </ul>
  </description>

  <categories>
    <category>Network</category>
    <category>Email</category>
    <category>News</category>
    <category>ConsoleOnly</category>
  </categories>

  <provides>
    <binary>neomutt</binary>
  </provides>

  <launchable type="desktop-id">org.neomutt.NeoMutt.desktop</launchable>

  <screenshots>
    <screenshot type="default">
      <caption>Mail index</caption>
      <image>https://github.com/neomutt/neomutt/raw/master/contrib/screenshots/neomutt-screenshot-index.png</image>
    </screenshot>
    <screenshot>
      <caption>Mail index and pager</caption>
      <image>https://github.com/neomutt/neomutt/raw/master/contrib/screenshots/neomutt-screenshot-pager.png</image>
    </screenshot>
  </screenshots>

  <content_rating type="oars-1.1">
    <content_attribute id="social-chat">intense</content_attribute>
    <content_attribute id="social-contacts">intense</content_attribute>
  </content_rating>  

  <url type="homepage">https://neomutt.org/</url>
  <url type="bugtracker">https://github.com/neomutt/neomutt/issues</url>
  <url type="help">https://neomutt.org/guide/</url>
  <url type="donation">https://www.paypal.me/russon/</url>
  <url type="translate">https://neomutt.org/translate</url>
  <url type="contact">https://neomutt.org/about#contact-the-developers</url>

  <developer_name>Neomutt Developers</developer_name>
  <update_contact>[email protected]</update_contact>

  <releases>
    <release version="20211029" date="2021-10-29">
      <description>
        <p>This is a bug-fix release.</p>
        <p>Features:</p>
        <ul>
          <li>Notmuch: support separate database and mail roots without .notmuch</li>
        </ul>
        <p>Bug Fixes:</p>
        <ul>
          <li>fix notmuch crash on open failure</li>
          <li>fix crypto crash handling pgp keys</li>
          <li>fix ncrypt/pgp file_get_size return check</li>
          <li>fix restore case-insensitive header sort</li>
          <li>fix pager redrawing of long lines</li>
          <li>fix notmuch: check database dir for xapian dir</li>
          <li>fix notmuch: update index count after <code>&lt;entire-thread&gt;</code></li>
          <li>fix protect hash table against empty keys</li>
          <li>fix prevent real_subj being set but empty</li>
          <li>fix leak when saving fcc</li>
          <li>fix leak after <code>&lt;edit-or-view-raw-message&gt;</code></li>
          <li>fix leak after trash to hidden mailbox</li>
          <li>fix leak restoring postponed emails</li>
        </ul>
      </description>
    </release>
  </releases>
</component>

3 replies

flatcap Mar 5, 2022
Maintainer

Describing the NeoMutt -- It's something I've been putting off for years!
Once we figure out the wording it needs to get copied everywhere: docs, website, github, etc

flatcap Mar 5, 2022
Maintainer

It's probably not worth filing in NeoMutt's complete release history

True, but we could abbreviate it.
One app contains a list of empty, but dated releases:

<release version="2.8.22" date="2017-05-11"/>
<release version="2.8.20" date="2017-02-01"/>

We could do that for a handful of recent releases,
but I favour one addition: a URL to the GitHub Release

<release version="2021-10-29" type="development" date="2021-10-29">
  <url type="details">https://github.com/neomutt/neomutt/releases/tag/20211029</url>
</release>

dcpurton Mar 5, 2022
Maintainer Author

It's probably not worth filing in NeoMutt's complete release history

True, but we could abbreviate it.
One app contains a list of empty, but dated releases:
<release version="2.8.22" date="2017-05-11"/>
<release version="2.8.20" date="2017-02-01"/>

I notice a number of packages do this kind of thing.

We could do that for a handful of recent releases,
but I favour one addition: a URL to the GitHub Release
<release version="2021-10-29" type="development" date="2021-10-29">
  <url type="details">https://github.com/neomutt/neomutt/releases/tag/20211029</url>
</release>

That's a good idea. You could just keep the detail inline for the most recent release.

vuori · 2023-09-10T13:45:07Z

vuori
Sep 10, 2023
Collaborator

We talked about this a bit on IRC, and the suggestions here look fine. Would you be willing to put together a PR for this?

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support freedesktop.org specifications #3287

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 4 comments 13 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Support freedesktop.org specifications #3287

dcpurton Mar 5, 2022 Maintainer

Specifications:

To support the specification NeoMutt would need to:

Considerations:

Why bother?

Replies: 4 comments · 13 replies

dcpurton Mar 5, 2022 Maintainer Author

.desktop file

src location

install location

Suggested content

dcpurton Mar 5, 2022 Maintainer Author

Screenshots

src location

Default screenshot

Secondary screenshot

dcpurton Mar 5, 2022 Maintainer Author

dcpurton Mar 5, 2022 Maintainer Author

dcpurton Mar 5, 2022 Maintainer Author

dcpurton Mar 6, 2022 Maintainer Author

Submit your best default screenshot and self contained theme to sell NeoMutt!

Screenshot specifications

dcpurton Mar 7, 2022 Maintainer Author

theme-test.neomuttrc

Screenshot

Config and test files

dcpurton Mar 5, 2022 Maintainer Author

Upstream metadata

src location

install location

suggested content

flatcap Mar 5, 2022 Maintainer

flatcap Mar 5, 2022 Maintainer

dcpurton Mar 5, 2022 Maintainer Author

vuori Sep 10, 2023 Collaborator

dcpurton
Mar 5, 2022
Maintainer

Replies: 4 comments 13 replies

dcpurton
Mar 5, 2022
Maintainer Author

`.desktop` file

dcpurton
Mar 5, 2022
Maintainer Author

dcpurton Mar 5, 2022
Maintainer Author

dcpurton Mar 5, 2022
Maintainer Author

dcpurton Mar 5, 2022
Maintainer Author

dcpurton Mar 6, 2022
Maintainer Author

dcpurton Mar 7, 2022
Maintainer Author

`theme-test.neomuttrc`

dcpurton
Mar 5, 2022
Maintainer Author

flatcap Mar 5, 2022
Maintainer

flatcap Mar 5, 2022
Maintainer

dcpurton Mar 5, 2022
Maintainer Author

vuori
Sep 10, 2023
Collaborator