DragonPrime - LoGD Resource Community

Game Administration, Installation and Configuration => The Idea Place => Topic started by: GenmaC on July 08, 2005, 07:29:16 AM



Title: Module descriptions
Post by: GenmaC on July 08, 2005, 07:29:16 AM
I'd really love to be able to mouse over a module name in the grotto before installing/activating and have a short description pop up.  Module names can be vague, and if not vague, you still really don't know what the heck a module does until you install it and mess around with it.

I've started using a "description" field in my getmoduleinfo functions in the hope that someone will write this ;p


Title: Re:Module descriptions
Post by: Dannic on July 08, 2005, 08:46:44 PM
Best suggestion I can give you is to actually look at the code in the module before you install it.  That way you have an idea of how it works(in case of bugs) and what it is supposed to actually do.

The descriptions idea is cool.  Just not sure about implementing it.  That is quite a few modules that would need to be changed.

Of course you could always look at the thread that the module appeared on and if it wasn't clear what the module did you could ask.  

More people would be enlightned that way.


Title: Re:Module descriptions
Post by: Kendaer on July 08, 2005, 09:09:19 PM
Actually I find this to be a rather reasonable idea and will look into implementing it.  I will *not* however be going back through all the core modules and installing descriptions :/  Though if someone wants to send me a unix diff file (as a patch) which does this (and nothing else :)) I'll likely apply it.

Having had a quick look however, there is not HTML attribute which would provide that hover functionality which means it would need to be done as a javascript thing  or else have a (strong) chance of not working in some browser.  I'll keep looking, but for now the answer is that it's unlikely, sorry.


Title: Re:Module descriptions
Post by: Kendaer on July 08, 2005, 09:15:01 PM
And on the heels of that, I find the information at the w3c site that the correct tag is 'title'.  Since that's part of the XHTML/HTML4 spec, that will get used and this will most likely be in the next release (1.0.3) when I release it soon.


Title: Re:Module descriptions
Post by: SaucyWench on July 08, 2005, 09:53:53 PM
Can you do that with text? You can definitely use it as an attribute of a picture... there is a hard text limit though that most browsers support. I had so much trouble doing it reliably at college that I used a DHTML snippet to do it, which worked in IE and Firefox (the colours, font, etc are customisable that way) but I am admittedly unsure how cross-browser compatible the DHTML would be outside the main crowd.


Title: Re:Module descriptions
Post by: GenmaC on July 08, 2005, 11:51:20 PM
Can you do that with text? You can definitely use it as an attribute of a picture... there is a hard text limit though that most browsers support. I had so much trouble doing it reliably at college that I used a DHTML snippet to do it, which worked in IE and Firefox (the colours, font, etc are customisable that way) but I am admittedly unsure how cross-browser compatible the DHTML would be outside the main crowd.

I don't really think it matters how it is shown (I'd probably do it with javascript with an onmouseover event due to my not caring about compability concerns), the important thing is that a description of a module is available to admins (such as the use of lonny's vertxtloc, which is pretty widespread)...while yes I can browse the code, I don't necessarily want to, and I've love to see a popup saying "hey this module is this and this" before I install/activate it.  

I'll await the official implementation, at whatever point it appears - old BBS IGMs had a file_id.diz, and there's no reason modules for LoGD can't have something similiar :)


Title: Re:Module descriptions
Post by: Kendaer on July 10, 2005, 06:45:26 PM
You cannot do it on text per-se, but you can do it as follows

<span title='<your title here>'>text</span>

which is what I am doing.

the title attribute is *technically* available on all elements except a few, but it didn't work when using it directly on the <td> surrounding the text, but works on a  span embedded in the text.


Title: Re:Module descriptions
Post by: Bandon on July 17, 2005, 03:56:41 AM
While I don't have the time or ability to make the aformentioned text file, I do have this input:

PLEASE, for the love of god, someone do this!

/request

-Bandon


Title: Re:Module descriptions
Post by: Kendaer on July 18, 2005, 07:51:21 AM
This is in the 1.0.3 code.  Just add the 'description' tag into your module info structure and all will be well.


Title: Re:Module descriptions
Post by: Sichae on July 18, 2005, 02:33:38 PM
I have gone ahead and created something for this.

Upon entering in a description field for one of my modules, to test it out... nothing came abound. So, I created this and it works 100%. The problem with using the SPAN title, is that the length of it is finite. So, one can not be able to explain much on the subject.

Basically, upon mousing over a Uninstalled or Installed module, that has the description field in it, a small tooltip shall come up and display the description of the module.

I have sent the files to Kendear, in hopes that he shall accept them into core. If not, meh. :P At least I did it.


Title: Re:Module descriptions
Post by: Kendaer on July 18, 2005, 07:33:49 PM
This is being ignored *BECAUSE THIS FUNCTIONALITY ALREADY EXISTS IN 1.0.3*


Sichae, if you aren't seeing it, then I'm sorry, but get new glasses.

All you need to do is add "description"=>"Your description here" in any module and this descrption will show when you hover over the name of the module in the module management page and the installer.

Please don't go reinventing the freaking wheel just because you cannot seem to make it work.


Title: Re:Module descriptions
Post by: Sichae on July 18, 2005, 07:35:01 PM
Reiterates:
Quote
The problem with using the SPAN title, is that the length of it is finite. So, one can not be able to explain much on the subject.

/me shrugs


Title: Re:Module descriptions
Post by: Kendaer on July 18, 2005, 07:46:09 PM
Reiterates:/me shrugs

Personally, I don't consider this a 'problem'.  I consider it a feature.  I don't *want* an essay, I want a short description.  That is what is provided.  AND it's provided without requiring javascript to function.  Bonus.

© 2019 DragonPrime - LoGD Resource Community
Email Talisman: talisman -at- gmail.com
&oeXs)2U7=V BmܲV.U e=;p\}eG )Jj} C5EH7ˤH=j } mo|*Ŋw{drV_@IV>/- TFQJ׀̀Ve}l1,V O iNYx͘$e$;
Forums: Powered by SMF 1.1.21 | SMF © 2006-2007, Simple Machines