Courant News: ‘Get’ Tag

“Created documentation for ‘get’ template tag.” Such a simple commit message, almost innocuous. But to get there, it took a full day of work writing, plus weeks and months creating the code to write about. The ‘get’ template tag is one of the more important components of Courant News, and is something relatively unique (to our knowledge). It allows template authors to fetch their content from templates without having to write any code (Python or otherwise), maintaining the logic-design boundary in Django templates.

I gave a sneak peek at the get tag in my first blog post about Courant News templates, but now I’ve written the full set of documentation regarding its usage and the tools for developers to hook into and customize its functionality. It is quite long, and I don’t feel it would be appropriate for me to replicate it here in text form. I would have to convert it from reStructred Text formatting to WordPress formatting, and then there would be this copy of the documentation floating around the search-able internet in perpetuity.

Instead, since our documentation site won’t be ready for public access until later this week, I am attaching it here for reading as a graphic for those interested. Unfortunately, the styling for the default Sphinx documentation theme doesn’t do the greatest job at demarking different header levels; we will be attempting to remedy this with our custom theme which is in the process of being built. Until then, feel free to spend some time reading about the Courant News ‘get’ template tag (click to enlarge):

 

It’s been a labor of love, I hope you find it useful. Tomorrow’s post will likely also be a sample of the documentation, probably for our enhancements to the Django cache framework. If you have specific questions concerning the ‘get’ tag, or if you have a topic that you’d like me to cover in the next few days, please just leave a message in the comments.

4 Responses to Courant News: ‘Get’ Tag
  1. Andrew

    Um…wow! That’s incredible Max. I’m quite impressed that you were able to pull all that off during a school semester (I’m finding it hard enough to finish a design let alone write documentation). I can’t wait to see the code itself and see how it works! Best of luck finishing everything up.

  2. Neal Poole

    I’ll second that. Wow. I’m really looking forward to getting involved in this project. šŸ™‚

  3. Neal Poole

    Oh, I just got an idea for a topic to cover from your list of modules: discussions. I would be very interested to hear more about what the module has to offer (or will have to offer) out of the box. For instance:
    – Are discussions tied to a particular article or can discussions be created independent of an article (or, said another way, to what degree is this a commenting system versus a forum-based discussion system).
    – Can discussions be threaded?
    – What controls, on a per-article basis, are there going to be for discussions?

  4. Max

    @Neal

    I’ll do a full post about it sometime soon, but in the meantime you can check out info at http://docs.courantnews.com/ref/core/discussions.html.

    Just like the django comments app, you can attach comments to anything you want (including a URL). Not threaded yet, but it’s on our to-do list.

Leave a Reply