Tag documentation feedback

Ruby Apps Radiant CMS
1

Hi All,

Hopefully this is the right place.

  • small typo in “available tags” documentation for <r:find />:
    e$B!He(B Inside this tag all page related tags refer to the
    pagee$B!Ie(B → e$B!He(Ball page-relatede$B!Ie(B (missing hyphen)

  • it would be nice to have an example regexp in the “available tags”
    documentation <r:if_url /> tag notes, or a link to an accepted regexp
    commands guide. I forgot we don’t need to escape slashes after doing
    some some ERB regexp

  • I love the brevity and speed of the “available tags” documentation
    feature, but sometimes I’d like to see more detail, eg example code
    and what it’d produce, to more easily understand what a tag does.
    Currently this info is partially available in Standard Tags[1], Using
    Radiant[2], the Tag Primer 1 article[3] and the Tag Primer 2
    article[4]. I’d love to see the current docs available as part of the
    wiki allowing extra information to be integrated. This would also
    allow the inline docs to link there for more information.

  • It would be great to have a collection of example code snippets with
    output for doing basic things. I’m muddling through, but I’d love to
    see how to implement basic functionality in a smart way.

  • Finally I’d love if someone could post some articles on how they set
    up a site with Radiant and the clever things they did, complete with
    template code. Something like the Art of Mission Radiant Intro[5] for
    a more complicated site, how you implemented a specific function, or
    what your workflow is like (eg using SQLite then copying the database
    to the production server).

Thanks for your time

peace - oli

[1] http://wiki.radiantcms.org/Standard_Tags
[2] http://wiki.radiantcms.org/Using_Radiant
[3] http://radiantcms.org/blog/archives/2006/05/11/tag-primer/
[4] http://radiantcms.org/blog/archives/2006/06/15/tag-primer-2/
[5] Art of Mission Radiant CMS

2

Oli S. wrote:

  • Finally I’d love if someone could post some articles on how they set
    up a site with Radiant and the clever things they did, complete with
    template code. Something like the Art of Mission Radiant Intro[5] for
    a more complicated site, how you implemented a specific function, or
    what your workflow is like (eg using SQLite then copying the database
    to the production server).

There’s been discussion on this mailing list / forum about improving the
Radiant documentation and beginner user guides. A few people have
stepped-up already and started working on this, and others have it on
their to-do list. I personally take meticulous notes during my Radiant
installations and upgrades, and plan to turn this into helpful
documentation on radiantcms.org this summer.

I like your ideas about improving the Admin screen tag documentation,
since a lot are missing the list of variables you can pass to the tags.
I’m adding this to my summer to-do list as well.

Thanks for the good ideas!

  • Dave
3

I am currently working on a write-up for installing RadiantCMS on
Webfaction. I hope to expand more and do some small succinct tutorials
on accomplishing certain features using existing extensions. On my
summer to-do as well.

4

David P. wrote:

OK, I admit it. It’s me. I’m the evil one! I really need to find the
time to get back to the mini-project for Radiant documentation. I have
been completely missing in action, working on an unrelated work
project. But, I hope to get back to the Radiant documentation project
asap.

In fact, I’m checking emails sent to this list 2 months ago! It seems
like an age since I have seen/ worked with Radiant!

I will send some details in the next couple of weeks. I see good days
ahead!

Cheers,
Mohit.
6/10/2008 | 12:33 AM.

5

Mohit S. wrote:

OK, I admit it. It’s me. I’m the evil one! I really need to find the
time to get back to the mini-project for Radiant documentation. I have
been completely missing in action, working on an unrelated work
project. But, I hope to get back to the Radiant documentation project
asap.

In fact, I’m checking emails sent to this list 2 months ago! It seems
like an age since I have seen/ worked with Radiant!

I will send some details in the next couple of weeks. I see good days
ahead!

Mohit - please join in the new thread that’s discussing Documentation:
http://www.ruby-forum.com/topic/155933

  • Dave