ceylon / ceylon.language

DEPRECATED
Apache License 2.0
153 stars 57 forks source link

Add tags to categorize the module #753

Closed FroMage closed 9 years ago

FroMage commented 9 years ago

We should try the tag functionality we've added in ceylondoc for that very purpose. It allows us to filter the doc based on categories, such as basic types, numbers, streams, functions.

To kick-start the discussion and illustrate what this does, I'll add a commit so you can run and doc and check the results in the generated API docs in Filters (top-right menu). If you guys agree, feel free to suggest categories and members (or just do it). If you disagree we can always revert my commit. But PLEASE try it out, it's pretty neat.

tombentley commented 9 years ago

When I click on "Basic types" I get taken to the search page with "Basic%20types" in the input and no results.

Also, I want a tag cloud.

tombentley commented 9 years ago

Also, I want a tag cloud.

It doesn't lamely have to use a bigger font for more popular tags though.

tombentley commented 9 years ago

Oh, and finally, it might be useful to issue a warning about tags with only one member (that will tend to catch typos, for instance), and a tag with only one thing is a bit pointless.

Apart from these things it seems vaguely useful.

FroMage commented 9 years ago

What? I don't get to the search page by clicking Basic types, that's really weird.

lucaswerkmeister commented 9 years ago

Are tags on modules supported? The ceylon.html module descriptor is tagged – the only use of tagged in language module and SDK I could find yesterday – but I don’t see the tags anywhere on the Herd.

FroMage commented 9 years ago

Oh, when you click on the tag, not the menu. Yes that's a bug.

FroMage commented 9 years ago

Are tags on modules supported?

If not, they should be.

tombentley commented 9 years ago

Oh, when you click on the tag, not the menu

The menu?... Ah the filter thing you mean? I didn't even spot that, it's not obvious at all. Should it have an "untagged" option?

FroMage commented 9 years ago

check the results in the generated API docs in Filters (top-right menu)

:(

That's the only place where this feature shines. It's extremely nice IMO.

Should it have an "untagged" option?

Good question. I am not sure it'd be very useful.

tombentley commented 9 years ago

So what other tags do we need for the language module?

Any others?

Also I can't help but feel we'll one day want a refactoring to change a tag, but that's another issue I guess.

FroMage commented 9 years ago

Sorting, Operator

Both good ideas IMO.

@gavinking any opinion?

gavinking commented 9 years ago

The major categories are: numbers, streams, collections, sequences, strings, functions, environment.

FroMage commented 9 years ago

Not operators?

FroMage commented 9 years ago

And metamodel and serialisation I guess.

gavinking commented 9 years ago

Um. Not really...

gavinking commented 9 years ago

Yes, meta and serialization of course.

FroMage commented 9 years ago

Added tags everywhere, and added the Comparisons tag to the list, since we had lots of stuff for that.

Remaining untagged things:

Any idea/comment?

FroMage commented 9 years ago

Well, if nobody has comments, let's just close this as good enough until someone becomes interested again.