← Back to team overview

zim-wiki team mailing list archive

Re: Favicons for pages in index


I think icons for pages would be useful.

Single Icon Option
My first thought is for a set of icons that are normally "off" but can be turned on per page. I'd like the same icon image to be able to apply to more than one page but not multiple icon's per page. It seems an unnecessary restriction to say an icon can only be used once per notebook.

My use case is to help me pick out important pages, but also to give some sense of categorisation - so I might have more than one page with a "tasks" icon, several with "computer" icon etc.

Tags To Control Icons
I'm interested in Jaap's option b) though, because having a tag in a page might be a good way of enabling the page icon. I don't see how multiple icons per page would be useful in the normal tree pane though. It sounds like a different scenario which I can't imagine yet, but adding a tag seems a very good way of controlling the feature, even if we say it only displays the first specified icon tag. Or perhaps there is a way for the user to prioritise the icons globally? So for example, I have a folder of icons which match tag names, and if I want to prioritise which tags are used I can add a configuration file which can include an order of priority, and perhaps be used to turn icons off for particular tags. If needed a GUI could be added, but I guess a configuration file would do to start.

Text Styles (An Alternative)
FYI: KeynoteNF allows an icon to be selected for each "note", each of which has it's own tab/tree/editor, with the icon appearing on the tab next to the note name. There are no icons shown in the tree but KNF does allow text styles in the tree which I find quite useful to highlight where I'm working.

So an alternative to icons in the tree might be to allow text styles, either directly editable (e.g. in the rename dialog), or again linked to tags. A special case would might be to highlight based on occurrences of "TODO".

In KeynoteNF I use this to highlight pick out large numbers of nodes in bold (e.g. for prominent info, tasks, active clients), and to pick out a handful of very important nodes in red or bold-red (e.g. for templates, and where I'm working).

If I had to choose, I'd go for text styles before icons because I think text styles are easier for the eye to interpret and understand compared to the more subtle differences between icons, which would be quite small.


On 26/02/2013 08:06, Jaap Karssenberg wrote:
On Mon, Feb 25, 2013 at 5:21 PM, Tim <cyboreal@xxxxxxxxx> wrote:
Would anyone else benefit from having some means of displaying an icon
before a page title in the Index tree? I would love to have some means
of visually representing the pages in a very large notebook, to rapidly
identify the page for which I am looking. I imagine this could be
accomplished simply by having a "favicon.png" or "favicon.ico" in the
directory for a given page and instruct Zim to load it if such a file
exists. There could also be a default icon for pages with no icon
specified. Anyone else see this as a feature worth implementing?
There have been several requests for icons for pages before, but so
far I avoided looking into it as I don't see much use for it myself.
But feel free to have a look at it and commit a patch.

I think it is useful to talk a bit in terms of use cases: what do you
want to use it for?

A) When you talk about favicon I assume you want to mark "special"
pages in the index, e.g home page. So each icon will only appear only
once. This is very doable, you need to add the logic to determine the
icons, add them in the index and then just pack the icon in the
treeview cells.

B) Other users may want to use icons more like tags. So multiple pages
about the same topic can have the same icon. Here I see more problems,
because you potentially want multiple icons per page. Also when they
act as tags, you may want to search for them etc. In fact in this case
I would propose adding a tag to a page and let the tag have an icon
instead of adding an icon directly. If this is what you are thinking
of, it will need more design work to come up with a good patch.



P.S. I think I will veto calling the icon "favicon" by default,
instead configure an icon name per page without the need for the icon
to have a special name. Supporting the name "favicon" as a special
name can be considered though if you really are doing website
development in zim.

Mailing list: https://launchpad.net/~zim-wiki
Post to     : zim-wiki@xxxxxxxxxxxxxxxxxxx
Unsubscribe : https://launchpad.net/~zim-wiki
More help   : https://help.launchpad.net/ListHelp