Planned Documention Topics

This forum spearheads the effort to fill out and complete the Coranto Docs Wiki. Announcements of new docs added will be posted here.
There's a lot that needs to be put together... want to help? Inquire within.

Moderators: Spunkmeyer, Dale Ray, SrNupsen, Bluetooth, Jackanape

Postby Feathers » Tue Jan 23, 2007 7:27 pm

I'm planning to expand the Profiles section of the Wiki in the next few days with some examples of how we've used them on the PDA247 sites.

If anyone else has any good Profile examples let me know and I can include them too.
Mike
(Maintaining the vB3Comments addon)
Feathers
 
Posts: 110
Joined: Wed Jan 10, 2007 6:06 pm
Location: London

Postby Dale Ray » Tue Jan 23, 2007 9:07 pm

I split this from the topic where you posted it before we got too far off-topic.

If you are going to post descriptions about how to achieve a certain result with Coranto that may involve profiles, styles, and perl (or some other language) and may belong under 'Customizations' instead.

Another possibility is to add a high level section called 'Recipes' that is dedicated to step-by-step instructions to reach a certain end.
Last edited by Dale Ray on Tue Jan 23, 2007 11:56 pm, edited 1 time in total.
Dale Ray
User avatar
Dale Ray
 
Posts: 1001
Joined: Sun Jan 19, 2003 6:02 pm
Location: NW Indiana

Postby Jackanape » Tue Jan 23, 2007 9:38 pm

Dale wrote:Another possibility is to add a high level section called 'Recipes' that is dedicated to step-by-step instructions to reach a certain end.


I like that...much more descriptive...
User avatar
Jackanape
 
Posts: 632
Joined: Tue Jan 09, 2007 12:15 am
Location: Capitol of the Great State of New York

Postby Feathers » Tue Jan 23, 2007 10:01 pm

Dale wrote:I split this from the topic where you posted it before we got too far off-topic.

Fair enough.

Dale wrote:If you are going to post descriptions about how to acheive a certain result with Coranto that may involve profiles, styles, and perl (or some other language) and may belong under 'Customizations' instead.

Another possibility is to add a high level section called 'Recipes' that is dedicated to step-by-step instructions to reach a certain end.

That's true, and I suspect there's a place for that in time, but what I was thinking of was something a lot more basic. The 'Profile Overview' article exists but there is nothing else in that section that actually explains why someone may want to use a Profile.

What concerns me is that looking at the documentation as a new user, I'm not convinced that I'd find all the information I'd want initally as it is spread between the Installation Tutorials, the Profiles section and the Customisation area.

What I was thinking of was trying to come up with a little more detail for the 'Overview' piece and then producing a 2nd or 3rd article describing what profiles may be used for - maybe not going into too much detail of how to achieve a given end but at least describing the ends.

Something similar could be done for Styles, though I'm not so sure that would work without full examples which I guess would fit more into the Customisation section.

Basically, I'd like to see larger sets of very basic introductory stuff clustered together in one or two obvious places and 'Profiles' seems to be a prime candidate and one that I could add to.

Feel free to discuss...
Mike
(Maintaining the vB3Comments addon)
Feathers
 
Posts: 110
Joined: Wed Jan 10, 2007 6:06 pm
Location: London

Postby Dale Ray » Tue Jan 23, 2007 11:55 pm

Expanding on any of the topics is great.

I see that the Profiles section is for documenting what Profiles are for, how they are used, and how to set them up. Examples are of course a great way to make the point that needs to be made.

I have revised the top level page of the Customization section and added a top level Coranto Recipes section.

Customizations are things you can add or incorporate into an existing site. Recipes are start to finish how-tos or guides that, if followed, will result in at least one page of content for a site and could result in a complete site.

Of course the Coranto Recipes section is empty right now. :(

But I plan to do a 'recipe' for creating a blog.

These recipes can build off of each other. As an example I can do a simple blog and then using that as a base add an RSS feed, then add archiving, etc. This also breaks the content into smaller chunks.

Comments?
Dale Ray
User avatar
Dale Ray
 
Posts: 1001
Joined: Sun Jan 19, 2003 6:02 pm
Location: NW Indiana

Postby Jackanape » Wed Jan 24, 2007 1:16 am

If I can just find the time, I've got a recipe for a great Photo Gallery, but I'm still refining it, with new ideas to make it better...I'll have to finish the first step first...LOL
Either way, Feathers is right, in the Profiles are one of the msot confusing things about Coranto, even to long time users...it took me a few installations to get down what they could do, exactly. Clarifying that is a great step forward.
User avatar
Jackanape
 
Posts: 632
Joined: Tue Jan 09, 2007 12:15 am
Location: Capitol of the Great State of New York

Postby Feathers » Wed Jan 24, 2007 11:35 am

Jackanape wrote:Clarifying that is a great step forward.

It's also a grand aim, but I'll make a start in the areas I know about and hopefully others will chip in some things I hadn't thought of.
Mike
(Maintaining the vB3Comments addon)
Feathers
 
Posts: 110
Joined: Wed Jan 10, 2007 6:06 pm
Location: London

Postby Spunkmeyer » Wed Jan 24, 2007 6:43 pm

Concerning the Recipe idea: - I'm pretty good at pumping out basic layouts for blogs, pretty quickly. If you'd like me to write a tutorial on how to make a simple page, step by step, I would love to do that. Just let me know if Im reading between the lines, or if that's what you'd actually like us to do. I'd write it down to the code, include comments, how to include a basic coranto installation, as well as tweaking coranto to match the layout of your site.

Oh, just another question: I was going to write a short tutorial on a script that allows coranto to post a different image depending on which user posts.. however, i cant rember who wrote it.

I noticed he/she had written a method of including the images that was more difficult than it needed to be. All that was necessary was a simple if statement such as the following:

Code: Select all
<If: Field: User eq "Spunkmeyer">
<img src="/news/spunkmeyeravatar.jpg" alt="spunk avatar">
 <If: Else: Field: User eq "someoneelse">
<img src="/news/someoneelse.jpg" alt="someoneelse">
 </If>


In any case, I found the above example was incredibly easy, and required minimal effort. I used it in a site of my own, and it works flawlessly. You just place that snippet of code in the <Field: Text> portion of your default news style.

The only issue with it might be the amount of users on the site. If per say you had 50 users for the page, then the list of people in the <if> statement would be 50 lines long. Not saying that is difficult in any means, it just might take up extra bandwidth than say a portion of code only two lines long that did the same thing. The only reason i mention this is the original code for the script that did this didn't end up working for me, even after a great deal of tweaking. Since I only had 7 users, I thought what the hell.

In any case, give me a go ahead or not on the above.
"God Bless the Portable Grassy Knoll"
Spunkmeyer
 
Posts: 69
Joined: Wed Jan 10, 2007 4:36 pm
Location: Whistler, BC, Canada

Postby SrNupsen » Wed Jan 24, 2007 7:57 pm

Code: Select all
<If: Field: User>
<img src="/img/<Field: User>_avatar.jpg" alt="<Field: User>'s avatar" />
  <If: Else>
  <img src="/img/anonymous.jpg" alt="Anonymous sissy" />
</If>


This way you can have a zillion users if you want to.

[EDIT: As long as each user has an image named "[username]_avatar.jpg" in the img directory, ofcourse. But your method also implied uploading a separate image for each user - my method just shortens the style code a lot once you reach a certain number of users.]
Last edited by SrNupsen on Wed Jan 24, 2007 9:52 pm, edited 1 time in total.
-----------------------------------------------------------------------------------------------------
Coranto is free software. I am available for custom work or troubleshooting.

http://www.sundaune.no - transkripsjon, webdesign, nettsider, tekstbyrå
http://www.vagbladet.no - satire, politikk, kultur, sport, nettavis
-----------------------------------------------------------------------------------------------------
SrNupsen
 
Posts: 2229
Joined: Tue Jan 09, 2007 6:46 pm
Location: Nesodden, outside Oslo, Norway

Postby Jackanape » Wed Jan 24, 2007 8:55 pm

Sweet.

Go for it, Spunk!
User avatar
Jackanape
 
Posts: 632
Joined: Tue Jan 09, 2007 12:15 am
Location: Capitol of the Great State of New York

Postby Spunkmeyer » Wed Jan 24, 2007 9:53 pm

Cool, sounds good. I'll give you updates on when it will be ready. I'm also designing a site of my own at the same time, as well as a charity site for the University of British Columbia, so its going to be an ongoing task. I'll keep you updated.

Since this is going to be a step by step / comment oriented tutorial, there's going to be a lot of code examples/text, thus requiring an unknown amount of pages. Will the wiki be able to handle that ok? Oh, one more thing before I begin, am i designing this tutorial for pebcak types, or people that know what they're doing? Can i safely assume I don't have to comment HTML tags?

Oh, and SrNupsen, thanks for the heads up.
"God Bless the Portable Grassy Knoll"
Spunkmeyer
 
Posts: 69
Joined: Wed Jan 10, 2007 4:36 pm
Location: Whistler, BC, Canada

Postby Dale Ray » Thu Jan 25, 2007 1:17 pm

Spunkmeyer wrote:Concerning the Recipe idea: - I'm pretty good at pumping out basic layouts for blogs, pretty quickly. If you'd like me to write a tutorial on how to make a simple page, step by step, I would love to do that.


Go right ahead. Just try to keep the first one as simple as possible. You should be able to do a basic blog with no addons. We can add articles for each blog feature - RSS, archives, etc. The first section should also include how to 'reverse engineer' a site layout to manage the different page sections with Coranto.

The result would be a series of articles:
    Building a Blog with Coranto - The Basics
    Building a Blog with Coranto - RSS Feed
    Building a Blog with Coranto - Archiving Posts
    Building a Blog with Coranto - Adding a Picture Gallery

This approach will keep each article short and easier to follow.
Dale Ray
User avatar
Dale Ray
 
Posts: 1001
Joined: Sun Jan 19, 2003 6:02 pm
Location: NW Indiana


Return to Documentation Project

Who is online

Users browsing this forum: No registered users and 2 guests

cron