On Thu, Dec 20, 2012 at 3:28 PM, Eric Chiesse <echie...@gmail.com> wrote:
> Thanks Hisham,
>
> One more thing. The description on the rocks web page does not look
> fine. I think it's because the html does not respect plain text line
> breaks and white space.
>
> Can I use html tags on the description.detailed field of the rockspec
> in order to improve browser readability? Is it expected?
IIRC, it respects double line breaks as a paragraph terminator.
I think plain text is the most "portable" format, considering that the
command-line tool also displays the description ("luarocks show"). I'm
not sure if using HTML tags is a good idea; I'd rather not, since then
we'll have to worry about defining an allowed subset, etc. (I think
some users even wrote Markdown markup in their descriptions, but
that's currently ignored, and Markdown is supposed to look like plain
text anyway).
The current index.html is one possible output, but then there's also
MoonRocks -- given that MoonRocks allows direct insertion of rocks,
filtering the text is even more important.
Ideally I think one important use of the description field is to aid
searching (I guess MoonRocks will get a search field at some point,
but even today Ctrl+F in the repo's index.html helps finding stuff)
and for that purpose plain text works well.
As for Luno's description, a plain English list of features would
probably suffice, without enumerating modules, which may change on
different releases -- it's better when the description is
version-agnostic, since both the current index.html and MoonRocks
display the latest description along with the list of versions.
How about:
[[
Luno is a native lua implementation of a series of helpers for common tasks
not covered in the standard library. Luno also provides support for functional
and object oriented programming paradigms.
The library comprises packages for dealing with command line arguments; IO,
string and table functions; helpers for functional programming and OOP.
Luno means Lua (moon) in esperanto.
]]
(The final remark on the name is not really necessary, but it is harmless :) )
-- Hisham
http://hisham.hm/
------------------------------------------------------------------------------
LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial
Remotely access PCs and mobile devices and provide instant support
Improve your efficiency, and focus on delivering more value-add services
Discover what IT Professionals Know. Rescue delivers
http://p.sf.net/sfu/logmein_12329d2d
_______________________________________________
Luarocks-developers mailing list
Luarocks-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/luarocks-developers
