Skip to content

Make reader icon location configurable#6261

Closed
joshka wants to merge 1 commit intoFreshRSS:edgefrom
joshka:icon-location
Closed

Make reader icon location configurable#6261
joshka wants to merge 1 commit intoFreshRSS:edgefrom
joshka:icon-location

Conversation

@joshka
Copy link

@joshka joshka commented Apr 4, 2024

Putting the Icons for read/unread and bookmark above the header can break a user's reading flow.

This makes the location of these icons configurable to be placed in one of the following locations:

  • above the title
  • in the same line as the header
  • in the same line as the authors and date

Closes #

Changes proposed in this pull request:

  • Configuration for icons
  • Change icon location in reader view

How to test the feature manually:

  1. Open settings | config | reading
  2. Change option for Icons to each
  3. Open reader view and notice the location of the icons changing

Pull request checklist:

  • clear commit messages
  • code manually tested
  • unit tests written (optional if too hard)
  • documentation updated

there didn't seem to be an obvious place for tests / docs for this.

Additional information can be found in the documentation.

Putting the Icons for read/unread and bookmark above the header can breaks a user's reading flow.

This makes the location of these icons configurable to be placed in one of the following locations:
- above the title
- in the same line as the header
- in the same line as the authors and date
@math-GH
Copy link
Contributor

math-GH commented Apr 4, 2024

Thanks for improving the reading view.

Could you please describe what you mean with the users reading flow and how it is connected with these icons?

This is the current situation (above title/tags): The icons are on the left side
grafik

in header:
I am not a fan of having the icons on the end of headline. I prefer the left side before the headline
grafik

in author and date row:
IMHO I do not see that this makes sense to have the icons here. Also here, I would prefer the left side before the authors list.

grafik

'none' => 'None',
),
'icons' => array(
'_' => 'Icons',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO: Icons is to general. Something like "mark (un)read, favorite buttons" would describe it more precisely

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree - I wasn't sure what to put for this. Maybe instead even Article actions. This would allow these to be replaced with text in some future change / (or theme).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see Article icons is used in the Display config

grafik

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a better UI for the configuration of these things in the reader view too.

'_' => 'Icons',
'above_title' => 'Above title/tags',
'with_authors' => 'In authors and date row',
'header' => 'In header',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In headline or In headline row could be the better description. Maybe a renaming of the key is needed too.

Copy link
Author

@joshka joshka Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied this one from other settings which put things in the same area.

I'm not 100% sure what the impact of renaming keys would be - I think it's generally good to keep consistent names where possible, and the fact that there's translations for this already is a good argument to use the same terms.

It might be worthwhile to define the areas more specifically however as something like

  • above title
  • title
  • subtitle
  • footer
    or something like that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is from the dropdown above.
grafik

But there it is fine enough to say "header".
In your case all place options are "in the header" ;) It needs to be more specific.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One downside is that there are translations available for the existing locations mentioned, so changing this to different wording means you lose all the translations. Also, the location options used match the existing locations used in the other options. I figure consistency is key here.

Comment on lines +142 to +144
<option value="a" <?= FreshRSS_Context::userConf()->show_icons === 'a' ? ' selected="selected"' : '' ?> data-input-visible="true"><?= _t('conf.reading.article.icons.with_authors') ?></option>
<option value="h" <?= FreshRSS_Context::userConf()->show_icons === 'h' ? ' selected="selected"' : '' ?> data-input-visible="true"><?= _t('conf.reading.article.icons.header') ?></option>
<option value="t" <?= FreshRSS_Context::userConf()->show_icons === 't' ? ' selected="selected"' : '' ?> data-input-visible="true"><?= _t('conf.reading.article.icons.above_title') ?></option>
Copy link
Contributor

@math-GH math-GH Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to use more readable value keys (authors = above, t = title etc.)

Copy link
Author

@joshka joshka Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied this from the existing settings that use this approach. I also would have preferred these settings to be meaningful, but chose to keep it consistent rather than doing it right.

@joshka
Copy link
Author

joshka commented Apr 4, 2024

Could you please describe what you mean with the users reading flow and how it is connected with these icons?

I'm transitioning off feedly, which looks somewhat like this (oddly appropriate article lol)

image

When I'm scanning through a feed, I'm interested often in seeing the headline first for any article as in a Visual UX hierarchy this is the most important thing. I found myself pausing whenever I go to the next article in FreshRSS as there's a big red icon that takes the first visual cue away from the title.

image

When thinking about how the hierarchy of elements in a UX, the icons for marking the article read/unread or bookmark have a belongs-to relationship with the article, and hence subjectively belong in the authors and dates line. I felt however this perspective was perhaps too controversial to necessarily be correct for everyone's perspective and noted that the general approach in FreshRSS was to provide options for such things.

TL;DR
I want those icons not to be the highest priority thing in an article. This would make my specific reading workflow faster (hit next, repeatedly only stopping to read things that I truly care about based on the title).

@math-GH
Copy link
Contributor

math-GH commented Apr 4, 2024

great to see this example. Now I understand it much better. We are both on the same site, that the reading view needs a better article actions tool bar that is also on the bottom of the article (similar to the normal view).

Would it be fine for you if I take some hours/days to think about it? I would create a new PR with a proof of new header/footer layout for the reading view. It could help us for more discussions there. I would appreciate your feedback there. Fine for you?

@joshka
Copy link
Author

joshka commented Apr 4, 2024

Would it be fine for you if I take some hours/days to think about it? I would create a new PR with a proof of new header/footer layout for the reading view. It could help us for more discussions there. I would appreciate your feedback there. Fine for you?

Yep - No rush. Ping me with the new PR. I was fixing a personal paper cut. P.S. having the devcontainer made it really easy to contribute a fix.

@Alkarex Alkarex added this to the 1.25.0 milestone Apr 6, 2024
@math-GH math-GH mentioned this pull request Apr 13, 2024
2 tasks
@joshka
Copy link
Author

joshka commented May 12, 2024

Closing out in preference to #6297

@joshka joshka closed this May 12, 2024
@Alkarex Alkarex modified the milestones: 1.25.0, 1.24.2 Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants