search

TinkaPlugin / Tinka

Tinka is an easy plugin packer for TiddlyWiki5.
Other
26 stars 4 forks source link

Naming of entries unclear #6

Closed gernert closed 4 years ago

gernert commented 7 years ago

When creating a new plugin/theme you have to fill in a 'Plugin/Theme Title'. When repackaging, these 'Plugin/Theme Title' cannot be found anymore as such. In case of a theme, 'Name' (mandatory for a theme) contains 'Theme Title' while in case of a plugin 'Name' is empty.

TinkaPlugin commented 7 years ago

Similiarly to my answer in #5, when I introduced this feature, I wanted to give these fields proper names that make it clear what it does, since the original way TW handled the name and description field of plugins and themes differently turned out to be confusing for beginners. After creating the plugin though, I do want to give people full access to all of the relevant fields with their internal names that a plugin can possibly have and not rename/hide things depending on the plugin type.

This little quirk is however mentioned and described in the documentation of the plugin, so right now, I wouldn't have any ideas on how to handle this differently. Do you have any suggestions?

gernert commented 7 years ago

Hi Andreas,

I think the documentation is confusing as well. The names of the entry fields are explained (Author, Source, Dependentes, ...) but instead of Theme Title the documentation mentions Name:

Name: For themes, this contains the theme title that is shown in the control panel.

May be better to write it the other way around:

Theme Title: the name of the theme as shown in the control panel and in the theme dropdown menu.

For the Tinka packer names maybe some extra 'explanation' for the names of the entry fields:

Plugin Title: (= description)

Theme Title: (= name)

What do you think?

TinkaPlugin commented 4 years ago

I hope this issue is now solved with the newest version.