Re: [Radiant] Summer Reboot
Well, I'm not. Feel free to write it, just make sure it doesn't overlap too much with other Creating an extension articles. Perhaps you could restructure things a bit, I'm not sure the current division and order is optimal. Med venlig hilsen / Best regards, Casper Fabricius http://casperfabricius.com On 18/09/2008, at 21:55, Andrew Gehring wrote: Is anyone doing any work on Creating an extension II I'll happily beta your work :-) Thanks, Andrew ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
On Fri, Sep 19, 2008 at 10:59 AM, Casper Fabricius [EMAIL PROTECTED]wrote: Well, I'm not. Feel free to write it, just make sure it doesn't overlap too much with other Creating an extension articles. Perhaps you could restructure things a bit, I'm not sure the current division and order is optimal. Me too. I think it would be better to give descriptive titles, rather than Creating and extension 1/2/3.etc. E.g. Creating an extension 1 has the url: http://wiki.radiantcms.org/Creating_an_extension_I Baking the number into the URL makes it non-trivial to reorder them. I think that to change the URL, you have to create a new document, and then you loose the editing history from the old document. Anyway, that sort of rearrangement can probably wait until the Summer Reboot documentation is nearer completion. Drew ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
I would be happy to write it, if I felt like I could. However, I don't have enough knowledge in this area to write a comprehensive document, and was hoping somebody was /has... Andrew On Fri, Sep 19, 2008 at 4:24 AM, Andrew Neil [EMAIL PROTECTED] wrote: On Fri, Sep 19, 2008 at 10:59 AM, Casper Fabricius [EMAIL PROTECTED]wrote: Well, I'm not. Feel free to write it, just make sure it doesn't overlap too much with other Creating an extension articles. Perhaps you could restructure things a bit, I'm not sure the current division and order is optimal. Me too. I think it would be better to give descriptive titles, rather than Creating and extension 1/2/3.etc. E.g. Creating an extension 1 has the url: http://wiki.radiantcms.org/Creating_an_extension_I Baking the number into the URL makes it non-trivial to reorder them. I think that to change the URL, you have to create a new document, and then you loose the editing history from the old document. Anyway, that sort of rearrangement can probably wait until the Summer Reboot documentation is nearer completion. Drew ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
HI Casper, Casper Fabricius wrote: Well, I'm not. Feel free to write it, just make sure it doesn't overlap too much with other Creating an extension articles. Perhaps you could restructure things a bit, I'm not sure the current division and order is optimal. I structured the first version of the table of contents.. and the extensions chapter was really created in that manner with the numbers, et al simply because I felt that there were a number of things that extensions could do - and there were a few things that would be useful for people to know how to do. With that as the starting point, based on my knowledge (and what I had read on the mailing list), I created that structure. Of course, you (and others) are more knowledgeable in this area, so please update it as you see fit. :) Cheers Mohit. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
Andrew Neil wrote: Me too. I think it would be better to give descriptive titles, rather than Creating and extension 1/2/3.etc. E.g. Creating an extension 1 has the url: http://wiki.radiantcms.org/Creating_an_extension_I You're right! There are descriptive titles, but only in the top-level Table of Contents on the main Summer Reboot page. Unfortunately, that's a really long title and I think it was chosen to just use the first part of it as the URL. But, it can be reordered later in the process. Baking the number into the URL makes it non-trivial to reorder them. I think that to change the URL, you have to create a new document, and then you loose the editing history from the old document. Anyway, that sort of rearrangement can probably wait until the Summer Reboot documentation is nearer completion. Yes, that would be the right time. Cheers, Mohit. 9/19/2008 | 10:27 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
I meant to add this list: 3. Writing your Own Extension * Creating an extension I – Adding tags (and some useful tags) [AW] * Creating an extension II – Adding a tab in Admin UI (and what is shards?) * Creating an extension III – Modifying the Page UI from an extension [CF] * Creating an extension IV – Extending and overriding Radiant behavior [CF] * Creating an extension V – Creating a custom page type [CF] * Creating an extension VI – Skinning controllers with front-end layouts (share_layouts) [SC] * Global Tags Cheers, Mohit. 9/19/2008 | 10:28 PM. Mohit Sindhwani wrote: Andrew Neil wrote: Me too. I think it would be better to give descriptive titles, rather than Creating and extension 1/2/3.etc. E.g. Creating an extension 1 has the url: http://wiki.radiantcms.org/Creating_an_extension_I You're right! There are descriptive titles, but only in the top-level Table of Contents on the main Summer Reboot page. Unfortunately, that's a really long title and I think it was chosen to just use the first part of it as the URL. But, it can be reordered later in the process. Baking the number into the URL makes it non-trivial to reorder them. I think that to change the URL, you have to create a new document, and then you loose the editing history from the old document. Anyway, that sort of rearrangement can probably wait until the Summer Reboot documentation is nearer completion. Yes, that would be the right time. Cheers, Mohit. 9/19/2008 | 10:27 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
Andrew Gehring wrote:
I would be happy to write it, if I felt like I could. However, I don't
have enough knowledge in this area to write a comprehensive document,
and was hoping somebody was /has...
Not sure if this helps, but what I had copied out towards the start of
that article was collected by looking at the source code for the Radiant
Settings extension that adds a tab in the Admin area.
There are 2 things that you can refer to:
[1] The original tutorial about creating a blog roll -
http://wiki.radiantcms.org/Creating_Radiant_Extensions
From this one, you can see the main things you need to -
There are two remaining steps in order to get our LinkController to
show up in the admin interface. First, we need to setup the routes
definitions for the controller and second we need to add the
associated tab to the admin interface.
To do this, open up the main extension file again
(“vendor/extensions/link_roll/link_roll_extension.rb”). Change the
define_routes block so that it looks like this ...
[2] Look at the source for some extension that creates a tab in the
admin area. Some of the stuff below is from the settings Extension URL:
http://githib.com/Squeegy/radiant-settings;
I'm sorry for lifting and pasting this code from the
settings_extension.rb file in the vendor/extensions/settingds directory:
#this creates routes so that your controller in the admin space is
connected in!
define_routes do |map|
map.namespace 'admin' do |admin|
admin.resources :settings
end
end
#This is the main thing that adds a tab to the admin area when your
extension is activated/ started
def activate
Radiant::Config.extend ConfigFindAllAsTree
admin.tabs.add Settings, /admin/settings, :after = Layouts #,
:visibility = [:developer]
Page.class_eval {
include SettingsTags
}
end
#To undo the effect, just remove it when deactivated.
def deactivate
admin.tabs.remove Settings
end
Hopefully, this helps you get started. However, I do not know how to do
some of the fancy things that Shards lets you do - like modify only a
part of the UI or something. I don't know (yet) how copy/move adds icons
to each row of the page list - I guess I could look at the source, just
haven't yet.
Cheers
Mohit.
___
Radiant mailing list
Post: Radiant@radiantcms.org
Search: http://radiantcms.org/mailing-list/search/
Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot
Hopefully, this helps you get started. However, I do not know how to do some of the fancy things that Shards lets you do - like modify only a part of the UI or something. I don't know (yet) how copy/move adds icons to each row of the page list - I guess I could look at the source, just haven't yet. I've been meaning to try to take time to write some of that one myself. Help has a plethora of information about this, both in the documentation it adds to the interface, and in the extension code itself. Just install Help via script/extension install help, with ray:help if you have Ray installed, or by cloning git://github.com/saturnflyer/ radiant-help-extension.git into vendor/extensions/help Fire up Radiant and go to: /admin/role_help/developer where you'll find a quick description of how to edit Radiant regions, and go to /admin/extension_help/help/developer where you can view the HELP_developer.rdoc In /admin/role_help/developer you'll also see a list in the right-hand column of all installed main regions available to edit or alter. These extensions change (there may be more of them) depending on the page that you are on. To see an example, compare the list of Help regions on /admin/role_help/developer to /admin/role_help/admin I'll be adding more info to it about that. I even commented the code for creating editable regions in the Radiant interface. Take a look at the help_extension.rb http://github.com/saturnflyer/radiant-help-extension/tree/master/help_extension.rb You can also find more help information with script/extension install help_inline which will install Help Inline which actually injects information into the interface. I'm still working on that one to make it even more helpful, but it should really facilitate new users. Help Inline does not depend on Help, but it will have additional features if you have both installed. And lastly, I'm going to be pulling details off of the wiki for help_use_cases which aims to add more details to the descriptions of the installed tags (to which any extension could also add). Help Use Cases *does* depend on Help. Jim Gay http://www.saturnflyer.com ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer reboot Radius articles
Andrew Neil wrote: Hello all (and especially Mohit), Hello Drew (and everyone) A couple of weeks ago I started work on the article Using the built-in tags for the Summer Reboot. My intention was to go over a handful of Radius tags which carry out 'typical' functions, such as inserting content, changing scope, showing content on condition that... etc. I'm trying to illustrate how the various tags work by providing examples, often using a fake site map. I had thought of creating a simple sample DB that we could use for this purpose. If there's interest, I can hammer something out this weekend. I have recently learned how to extract out content from a Word document - splitting at every Heading 1, Heading 2, Heading 3, etc. to create a bunch of textile files that can be inserted into Radiant. I could use something like that if need be. Well, the article has grown rather large, and so I have decided that it is appropriate to branch it into a series of shorter articles: http://wiki.radiantcms.org/Introduction_to_Radius http://wiki.radiantcms.org/Tags_that_insert_content http://wiki.radiantcms.org/Tags_that_change_the_scope http://wiki.radiantcms.org/Conditional_tags *snip* I think the re-organization makes sense. I'm just thinking if it's better to consider posting this whole thing into a separate chapter. Let's see how much stuff goes into it. If there's a lot, we'll do that later. This is great. I had written up something on inserting dates - I'll find the correct section and post it in. Currently, it's at: http://notepad.onghu.com/2007/9/10/radiant-cms-showing-the-date-of-articles If anyone has time to proof my articles, I'd be glad to hear any feedback. Especially if you are new to Radiant, because you are the target audience for this set of articles. If you already have experience using Radius tags, perhaps you can read with a view to finding mistakes. If no one else gets to it first, I shall do so this weekend. Last weekend, I finally got back to using Radiant for a site that I've wanted to for a very long time, and was very happy to see that the Summer Reboot documentation really helps! I've also got code now that helps you insert pages automatically using Ruby into a Radiant install (thanks Saji!) but the actual code is a real mess. Once I clean it up a bit, I can publish that as reference for anyone who may need it - and also into the wiki under 'Advanced' uses. Cheers, Mohit. 9/2/2008 | 2:26 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer reboot article
Andrew Neil wrote: Hey folks, This is far from finished, but I hope that by shouting about it, I can provide some impetus for others to get their docs rolling: http://wiki.radiantcms.org/Using_the_built-in_tags Pitched at beginner level. Regards, Drew Thanks for getting involved, Drew. I'll try to review it tonight if I get the chance. Cheers, Mohit. 8/14/2008 | 3:36 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer reboot article
I wouldn't mind having the articles I've contributed so far reviewed by someone either: http://wiki.radiantcms.org/Creating_an_extension_IV http://wiki.radiantcms.org/Creating_an_extension_V Cheers, Casper On 14/08/2008, at 9:36, Mohit Sindhwani wrote: Andrew Neil wrote: Hey folks, This is far from finished, but I hope that by shouting about it, I can provide some impetus for others to get their docs rolling: http://wiki.radiantcms.org/Using_the_built-in_tags Pitched at beginner level. Regards, Drew Thanks for getting involved, Drew. I'll try to review it tonight if I get the chance. Cheers, Mohit. 8/14/2008 | 3:36 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer reboot article
Casper Fabricius wrote: I wouldn't mind having the articles I've contributed so far reviewed by someone either: http://wiki.radiantcms.org/Creating_an_extension_IV http://wiki.radiantcms.org/Creating_an_extension_V Thanks for your articles, Casper! So far, I've read #5 (haven't yet got to read #4) yet, but I will definitely do so. #5 is really a beauty - I need to try it out to be sure it's perfectly right. Will do that for #4 also. I feel that we are now moving quite close to having good documentation for creating extensions. I notice that you've claimed #3 of the extensions also! You're quite the prolific writer on that subject. Both your articles are on my list for reading/ proofreading this weekend. I do hope that I get the chance to do so. I will also actually try out your articles this weekend if I can - if possible, I shall try to create screenshots to add to them. In some cases, screenshots are a distraction but I think it's useful in most cases! Thanks again! Cheers, Mohit. 8/14/2008 | 11:48 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer reboot article
Thanks, Mohit. Screenshots are a good idea. If more people contributes documentation, we might be able to reach the goal of completing Summer Reboot by the end of August! :) Cheers, Casper On 14/08/2008, at 17:48, Mohit Sindhwani wrote: Casper Fabricius wrote: I wouldn't mind having the articles I've contributed so far reviewed by someone either: http://wiki.radiantcms.org/Creating_an_extension_IV http://wiki.radiantcms.org/Creating_an_extension_V Thanks for your articles, Casper! So far, I've read #5 (haven't yet got to read #4) yet, but I will definitely do so. #5 is really a beauty - I need to try it out to be sure it's perfectly right. Will do that for #4 also. I feel that we are now moving quite close to having good documentation for creating extensions. I notice that you've claimed #3 of the extensions also! You're quite the prolific writer on that subject. Both your articles are on my list for reading/ proofreading this weekend. I do hope that I get the chance to do so. I will also actually try out your articles this weekend if I can - if possible, I shall try to create screenshots to add to them. In some cases, screenshots are a distraction but I think it's useful in most cases! Thanks again! Cheers, Mohit. 8/14/2008 | 11:48 PM. ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot Update
On Jul 17, 2008, at 1:52 PM, Jim Gay wrote: On Jul 17, 2008, at 1:32 PM, Oli Studholme wrote: Im happy to flesh out the tag documentation and add examples, but someone else will need to write the script to automatically generate/update wiki pages using the available tags text. If such a script is impractical Ill start doing it manually if a tag reference header page is created. The Help extension does this for you when you install it. Even better, it gives you documentation for all installed tags and to which page types they apply. http://github.com/saturnflyer/radiant-help-extension/tree/master It does not, however, provide examples beyond what comes with the tag descriptions. I just added http://github.com/saturnflyer/radiant-help_use_cases-extension/tree/master So your extra documentation could be added in as an option (although this still isn't as non-technical as editing a wiki) It has almost nothing in it, but I added the ability to extend the docs for the installed tags in Help http://github.com/saturnflyer/radiant-help-extension/commit/d9a4634724465ca115bd0f246b4665917efbe724 (thanks Sean) This will allow extension developers to add help use cases to their tags outside of the description in the model. My priority is to flesh out the features and documentation of Help, but I'll be adding more info to Help Use Cases as time goes on. If you are interested in writing docs for each tag, I'll gladly grab it and put it into Help Use Cases. -Jim Jim Gay http://www.saturnflyer.com ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
Re: [Radiant] Summer Reboot Update
Hi All, Sorry for being late to the party. I originally posted to the list on May 2nd about documentation (“tag documentation feedback”), mentioning among other things a tag reference. This would have one page per tag, be in a wiki, and hopefully auto-import the current “available tags” documentation from the code (would it be possible to script that?). I’ve added this to the summer reboot wiki page as an appendix. Currently the summer reboot documentation ToC is kind of book-like, in that a user would start at the start (or a chapter/topic of interest) and read linearly to the end. I’d also like to suggest we support reference style, for example the tag reference docs, and problem-solving style (how-to articles), for example short code example articles on one topic; how to implement blog-style categories using r:aggregate /, how to produce common variants of monthly archive lists etc. Currently the docs are a little repetitive or fractured in places, for example tag information is spread over four places on the wiki and blog, so we should also think how to avoid repeating content too much. For tags I’d propose putting the most detail into a tag reference, and having eg the “Using the built-in tags” article be an overview grouped by topic with examples, with links to the tag reference and how-to articles for more detail. I think that putting the detail into atomic reference pages will make it easier to keep the main documentation articles light and quick to read, and help reduce repetition. I’m happy to flesh out the tag documentation and add examples, but someone else will need to write the script to automatically generate/update wiki pages using the available tags text. If such a script is impractical I’ll start doing it manually if a tag reference header page is created. Some reference for how others do this: Movable Type: http://www.movabletype.org/documentation/appendices/tags/ Expression Engine: http://expressionengine.com/docs/overview/tags.html WordPress: http://codex.wordpress.org/Template_Tags These things would be nice for the tag reference: * best practice code examples, with expected results * code coloring in code examples * links to related tags, how-to articles that use this tag, and relevant part of tag overview article and other documentation * a link in the Radiant admin “available tags” documentation to the more detailed tag reference page on the wiki Finally it would be great if there was automatic linking of how-to articles and tag reference pages, ie if a how-to article on monthly archive lists has a code example with r:children:each, r:find, r:date and r:header, that it would automatically link to those tag reference pages, and in turn the how-to article would be linked to on each relevant tag reference page. hope that’s of some use peace - oli ___ Radiant mailing list Post: Radiant@radiantcms.org Search: http://radiantcms.org/mailing-list/search/ Site: http://lists.radiantcms.org/mailman/listinfo/radiant
