Nucleus: From Beginner to Intermediate

Documentation is as important as the rest of the code, so if something is unclear, missing or just plain wrong, please tell it.
ciborium
Posts: 99
Joined: Sun Nov 21, 2004 5:11 am
Location: Arizona
Contact:

Nucleus: From Beginner to Intermediate

Postby ciborium » Sat Nov 27, 2004 9:14 pm

Hi, folks,

I'd been talking about putting up a brief tutorial over in the Skins & Templates area, and have finally finished it, or at least the first version. I've got lots of stuff to do and won't be able to update it much in the next month, but I would love to have feedback, especially from anyone who uses the tutorial (that is, anyone who is a Nucleus beginner), since any responses will help me rewrite and rework the pages when I do get a chance to.

The tutorial can be seen here:

http://printculture.org/nucleushowto.htm

Cheers,

Eric
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Postby hcgtv » Sat Nov 27, 2004 9:33 pm

Looks good Eric, will read it over.
User avatar
moraes
Nucleus Guru
Nucleus Guru
Posts: 2377
Joined: Sun Dec 23, 2001 9:42 pm
Location: Curitiba, Brazil
Contact:

Postby moraes » Sat Nov 27, 2004 11:53 pm

That's a huge work, ciborium! Pretty well written. With your permission, I would like to translate parts of it to portuguese and publish the tutorial in a future 'Nucleus Brazil' community I'm planning to launch.

moraes
User avatar
PB
Posts: 343
Joined: Fri Apr 18, 2003 5:31 pm
Location: Michigan
Contact:

Postby PB » Sun Nov 28, 2004 12:34 am

Very nice! Goes logically through the steps to make a blog.

Two typos in the CSS section: close the "headline" div and close the .contents description.

Thanks for your kind words about my tutorial on creating a blog enty. If your tutorial will continue to point to this, why don't I rewrite for a more general user (as opposed to my authors), and get new screenshots for obvious changes from upgrades. (Let me know if anyone has specific suggestions.) Then, these should all be published somewhere on nucleuscms.org, right?

Oh, and I'm a girl. :wink:
User avatar
moraes
Nucleus Guru
Nucleus Guru
Posts: 2377
Joined: Sun Dec 23, 2001 9:42 pm
Location: Curitiba, Brazil
Contact:

Postby moraes » Sun Nov 28, 2004 12:54 am

well, just in case you are a perfectionist... :-D

There is a screenshot that maybe would confuse me if I were a newbie. ;-) It says "to change settings for your blog (including its skin) click here", and points to the left admin area menu. That's not completely right. Blog settings are accessed through the 'settings' link located on the 'blog list table' (admin area main page). Actually throught the left menu you change 'global' settings: your profile settings, skins & templates (which are also 'global', since you can use one in many different blogs), plugins & admin options.

m.
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Postby hcgtv » Sun Nov 28, 2004 1:33 am

I've setup a wiki at http://hcgtv.info

We can all make changes online to this document or any document for that matter.

Whoever wants to gain access to this wiki, please send me a user id, a password in an md5 string, your name and email address.

Code: Select all

user:MD5password:Real Name:email


Could one day be at http://docs.nucleuscms.org
User avatar
moraes
Nucleus Guru
Nucleus Guru
Posts: 2377
Joined: Sun Dec 23, 2001 9:42 pm
Location: Curitiba, Brazil
Contact:

Postby moraes » Sun Nov 28, 2004 1:46 am

hcgtv wrote:Whoever wants to gain access to this wiki, please send me a user id, a password in an md5 string, your name and email address.


Tip - you can make a MD5 password here:
http://www.splitbrain.org/encode.php

m.
ciborium
Posts: 99
Joined: Sun Nov 21, 2004 5:11 am
Location: Arizona
Contact:

changes etc

Postby ciborium » Sun Nov 28, 2004 5:16 am

Thanks to everyone for the comments so far. Some quick things:

1) I've made the changes noted by PB (including your gender; sorry!) and Moraes (I changed the text on the screenshot; should be clearer now).

2) Moraes, of course you can take whatever you'd like and translate it into Portuguese.

3) PB, given how much I'm piggybacking on your work, it would of course be great if you made the changes you've suggested above. Maybe at that point it could be integrated into one giant document. ...which brings me to...

4) I really like the idea of having this in a wiki, b/c it would allow us to collaboratively build up the structure of it. One thing, for instance, that people could do is come up with beginner, intermediate, and advanced tasks or examples for people to try out--they could be linked off the main document as extra work for people who wanted it. We could also add sections on the parts I've labeled "advanced" (some of which, I'm discovering, are more advanced than others).

-- Eric
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Re: changes etc

Postby hcgtv » Sun Nov 28, 2004 8:11 am

ciborium wrote:4) I really like the idea of having this in a wiki, b/c it would allow us to collaboratively build up the structure of it.

Ok: http://hcgtv.info/nucleus:how-tos:beginner

I ran it thru a command called html2txt with a filter that was on the DokuWiki site.
http://www.splitbrain.org/dokuwiki/wiki ... o_dokuwiki

The by product is a table of contents and each section is editable.

The links didn't get converted, so the filter needs work but we can just change the links in the document for now.
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Postby hcgtv » Sun Nov 28, 2004 10:59 am

How about a set of lessons? http://hcgtv.info/?idx=nucleus:tutorial
User avatar
moraes
Nucleus Guru
Nucleus Guru
Posts: 2377
Joined: Sun Dec 23, 2001 9:42 pm
Location: Curitiba, Brazil
Contact:

Postby moraes » Sun Nov 28, 2004 11:20 am

That's a great idea to setup such wiki, Bert. Will it be moved to docs.nucleuscms.org once the docs are finished? Oh, I see a problem with the plugin event names here:
http://hcgtv.info/nucleus:plugins?s=install_plugin

@ciborium: quick fix, nice! :-)

m.
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Postby hcgtv » Sun Nov 28, 2004 11:41 am

moraes wrote:That's a great idea to setup such wiki, Bert. Will it be moved to docs.nucleuscms.org once the docs are finished?

Let's see how it progresses, but I don't see why not.
moraes wrote: Oh, I see a problem with the plugin event names here:
http://hcgtv.info/nucleus:plugins?s=install_plugin

I haven't converted the docs yet, they are still in html, I just set the 'htmlok' switch to on.
User avatar
PB
Posts: 343
Joined: Fri Apr 18, 2003 5:31 pm
Location: Michigan
Contact:

Postby PB » Tue Nov 30, 2004 2:54 am

I'll make my blog entry tutorial more generic - although, like Eric, it may take a bit to get to it.

Bert, how does the wiki deal with images?
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Postby hcgtv » Tue Nov 30, 2004 3:00 am

PB wrote:Bert, how does the wiki deal with images?

Just fine, http://hcgtv.info/wiki:syntax
User avatar
hcgtv
Nucleus Guru
Nucleus Guru
Posts: 2657
Joined: Fri Feb 27, 2004 3:50 pm
Location: Charlotte, NC
Contact:

Postby hcgtv » Mon Dec 06, 2004 9:05 pm

El wiki has moved to it's permanent location: http://nupusi.com/docs/

The users that asked me to add them are in there.

This week, I'll start converting the Nucleus docs to the dokuwiki format. Still playing around with the conversion filter for html2text, so I don't have to do that much work.

All I can say is that DokuWiki is very nice and fast, it's the first wiki that has kept my attention for any length of time.
ciborium
Posts: 99
Joined: Sun Nov 21, 2004 5:11 am
Location: Arizona
Contact:

Postby ciborium » Mon Jan 08, 2007 9:37 pm

For now, you can find a backup copy of the tutorial here:

http://www.printculture.com/item-30.html

It's on an old version of the blog, but the CSS seems to be in place so all's well... click on the banner at the top of the page if you want to see what Printculture looks like now...
Printculture. A daily blogzine on politics, culture, and new media.

Return to “Documentation”