Simple Machines Community Forum

Customizing SMF => SMF Coding Discussion => Topic started by: [Unknown] on March 18, 2004, 02:43:05 AM

Title: Tutorials I need to write...
Post by: [Unknown] on March 18, 2004, 02:43:05 AM
I have a list of tutorials I want to write in my head, but some of them... have gone missing.  I know I will forget some, so maybe it's better if I take requests.

Currently, I plan to write:
  - details on the templating system.
  - details on packaging a theme/smiley set/package.
  - walk through for SSI.php.
  - walk through for adding several different types of things to profiles.
  - details on writing a modification. (much later when package manager is done.)

Anything else I should write?

Remember that I'm a developer, I write CODING documentation :P.

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Tyris on March 18, 2004, 03:05:08 AM
This almost certainly comes under templating or something... but basically a single text document with ALL the array's and where they appear and what each key is used for etc would be very useful :) (just making sure ;))
Title: Re: Tutorials I need to write...
Post by: [Unknown] on March 18, 2004, 03:10:07 AM
This almost certainly comes under templating or something... but basically a single text document with ALL the array's and where they appear and what each key is used for etc would be very useful :) (just making sure ;))

That would take me a long time, but I do plan to do that a bit later.

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Kris on March 18, 2004, 03:29:01 AM
Looking forward to the tutorial for extending profiles.
Title: Re: Tutorials I need to write...
Post by: Tyris on March 18, 2004, 03:36:00 AM
This almost certainly comes under templating or something... but basically a single text document with ALL the array's and where they appear and what each key is used for etc would be very useful :) (just making sure ;))

That would take me a long time, but I do plan to do that a bit later.

-[Unknown]
really? aaa.. I thought it was gonna be one of the first things along with the templating tutes ><
heheheh... I think I'll go about making my own list by print_r'ing everything ;)
thanx for letting me know tho :)
Title: Re: Tutorials I need to write...
Post by: [Unknown] on March 18, 2004, 03:51:52 AM
heheheh... I think I'll go about making my own list by print_r'ing everything ;)
thanx for letting me know tho :)

You're gonna laugh - but that was exactly what I planned to do as well.  If you can make a list for me, I can describe it.

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Tyris on March 18, 2004, 03:55:55 AM
whee!! ok... well I'm off to watch a movie with my parents in a few minutes... but I'll try to get onto that in the weekend :)
/me goes and dances coz he has something nice and easy to do to help out
Title: Re: Tutorials I need to write...
Post by: Peter Duggan on March 18, 2004, 11:50:46 AM
Remember that I'm a developer, I write CODING documentation :P.

Time to join this discussion to add that *I'm* a doc writer, so I'll be working on help doc/manual type stuff!

Not hijacking this topic (which must stay focused on coding doc), but must just mention that the user help (the stuff that belongs to the 'Help' button) is currently being rewritten, some other new doc is under discussion and, as David has recently pointed out, we hope to bring you some helpful Flash movies in time:

Documentation is a very important aspect of any software project.  We have already posted basic guides to installing and upgrading SMF and more are in the works.  We are trying very hard to compile excellent documentation for both all of you as administrators as well as your end users.  This process will however take time to fully complete.  While offering guides as posts is useful, we plan to offer multiple formats including flash tutorial movies.  Simple Machines' developers have also been great about documenting the code as they are working which should greatly help mod developers.

Don't want to take up any more space in this thread just now, but please look out for a new help doc topic in a more appropriate board soon where I'll also be asking what you, the users, would most like to see documented and whether anyone's interested in helping! :)
Title: Re: Tutorials I need to write...
Post by: Dem0n on March 19, 2004, 01:43:00 PM
Looking forward to the tutorial for extending profiles.

Me too.
Title: Re: Tutorials I need to write...
Post by: AmphetaMarinE on March 21, 2004, 02:12:26 AM
I am really looking forward to an ssi.php tutorial...
That would be most helpful to a php n00b such as myself :)
Title: Re: Tutorials I need to write...
Post by: Anguz on March 27, 2004, 06:19:21 PM
[Unknown], do you think this could be useful to help explain the code?

http://phpdocu.sourceforge.net/
Title: Re: Tutorials I need to write...
Post by: [Unknown] on March 28, 2004, 03:27:07 AM
(I dunno, this isn't long enough to be separate, I'll have to put it with something, but it's important for people new to the system...)

The Basic Flow of SMF
SMF has a pretty logical flow model.  For general code and functions, everything flows like this:

Client -> index.php -> Source file and database -> Template system -> Client

The files in the Sources directory essentially parse input and raw data, and make it ready for the template system to accept it.  The source file run depends on the array in index.php, which sends it there....

After the source file is done, index.php takes the data to the appropriate templates and sub templates, and has them display it.

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: writeto on March 28, 2004, 04:41:51 AM
Perhaps a flowing diagram would be beneficial when you publish that.
Title: Re: Tutorials I need to write...
Post by: [Unknown] on March 29, 2004, 06:13:49 AM
http://unknown.network32.net/tutorial.smf_custom-profile

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: ms_ukyankee on March 29, 2004, 08:32:33 AM
Suggestion for another tutorial (or section of a tutorial), which I will have questions about, and I've seen it asked regarding other forums:

- How to restrict non forum pages to logged in members or special membergroups.

Your tutorial looks pretty good to me, [Unknown], but would like also to know how to require the additional field information on Registration, so maybe a note that mentions whether adding the field the Reg template will work, etc.
Title: Re: Tutorials I need to write...
Post by: souleman on March 31, 2004, 11:13:59 AM
Maybe pretty usless or already exist, but a list of what files are for SMF.  After upgrading, I noticed that I have a LOT of files left over from yabbse (especially after doing some mods).  It would be helpful to know what the files are for also, although most of them are pretty self explanatory just by looking at the name of the file.

Another wuld be a list of the tables in the database.  I don't think I need both smilies and smilys (or something like that) tables, but not sure which is from yabbse and which is from SMF. 

I will take the time to figure it out and get it all cleaned up, but once it goes public, some people that are doing the upgrade will probably not want to spend the time to figure it out themself, so it would be nice to have.
Title: Re: Tutorials I need to write...
Post by: [Unknown] on March 31, 2004, 10:58:27 PM
It's too big to post ;) :P.

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Tristan Perry on July 28, 2004, 03:36:50 PM
It's too big to post ;) :P.

-[Unknown]
I'm guessing you didn't do that by memory, right?  :P
Title: Re: Tutorials I need to write...
Post by: [Unknown] on July 31, 2004, 08:30:54 PM
Sorry, but I'm not going to sit there and type 24 kilobytes of filenames.  No way, sorry :P.

I just used some fancy-shmancy development tools I've got ;).

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: The_Altered1 on September 29, 2004, 08:04:30 PM
Mainly all I would like to see is a standard method for importing/exporting themes. That way everyone would follow a standard example and not variate from that.  Keep it a constant/consistant process.

It's not that hard to do, but I can just see 20 different readme files from different people stating different ways to install their themes. Not good for the inexperienced smf user.
Title: Re: Tutorials I need to write...
Post by: Winters on October 16, 2004, 02:04:05 PM
I read a bit about SSI on this forum (and the tutorials), what would be helpful for me would be an overview of the pros and cons of the .php vs. the .shtml method.
Title: Re: Tutorials I need to write...
Post by: Metho on October 16, 2004, 02:27:35 PM
I would think, though I'm not entirely sure, that it's just a coding preference. Like I always use the php, because that's what I'm comfortable in. It's like a warm blankie.

- Methonis
Title: Re: Tutorials I need to write...
Post by: [Unknown] on November 11, 2004, 07:54:26 PM
A permissions tutorial? (http://www.simplemachines.org/community/index.php?topic=19136.0)
Integrating the forum into your site... (http://www.simplemachines.org/community/index.php?topic=19638.0)

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Trekkie101 on December 07, 2004, 06:47:23 AM
Nice site, MK Portal, we need some SMf fan sites that shows that we love it, im thinking of starting something like SMF~World but dunno what to put there that isnt here,
Title: Re: Tutorials I need to write...
Post by: [Unknown] on December 07, 2004, 08:04:43 AM
Custom actions...

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: [Unknown] on December 18, 2004, 03:40:23 AM
Package SDK, anyone? (http://support.simplemachines.org/community/index.php?topic=20319.0)

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Robert Frost on February 27, 2005, 05:26:44 PM
yay! an SSI for dummies tutorial would come handy ;)
Title: Re: Tutorials I need to write...
Post by: MrFlicks on April 05, 2005, 06:35:08 PM
Hmm ) Pondering all the above :-\
Title: Re: Tutorials I need to write...
Post by: [Unknown] on April 20, 2005, 11:12:13 PM
Creating modifications, ahoy.

-[Unknown]
Title: Re: Tutorials I need to write...
Post by: Anguz on April 21, 2005, 12:09:58 AM
Nice.
Title: Re: Tutorials I need to write...
Post by: MentalMuscle on April 22, 2005, 11:10:14 AM
http://unknown.network32.net/tutorial.smf_custom-profile

-[Unknown]

Thanks for writing up this document [Unknown].  This provides some great information.  I do have one question about the custom registration fields.  I will be implementing this to gather prior gaming history information from new members joining my gaming community site.  We have a unique community rank/award system that we track for every member in their own individual post.

From what I can tell the information gathered at registration will go in the new members profile, but how do I get it to generate a post as well in a particular category with the same information?  I believe the ability to populate both with the gathered information was suggested early in the document.

The profile is good for the general population to peruse, but the officers want evey detail about a member in a nice little (often times not so little) post.
Title: Re: Tutorials I need to write...
Post by: Elijah Bliss on May 15, 2005, 02:39:57 AM
Custom BBC Tag Tutorial?

I think a basic tutorial with a few references would be very handy. I see quite a few requests for custom tags and I think showing the masses how to get started instead of the masses relying on the handful who know how would be beneficial.
Title: Re: Tutorials I need to write...
Post by: mosey on July 17, 2005, 08:32:56 PM
How about some suggestions as to the best way to use SMF's member database throughout your site in areas other than just the forum - In other words, use SMF's member data to log into my own custom scripts in non-forum areas of my site rather than making everyone sign up twice to access all features of my site.
Title: Re: Tutorials I need to write...
Post by: xenovanis on July 17, 2005, 10:59:09 PM
How about some suggestions as to the best way to use SMF's member database throughout your site in areas other than just the forum - In other words, use SMF's member data to log into my own custom scripts in non-forum areas of my site rather than making everyone sign up twice to access all features of my site.

BASIC SSI FAQ (http://www.simplemachines.org/community/index.php?topic=23842.0)

Maybe that will help you?
Title: Re: Tutorials I need to write...
Post by: oldschr on August 23, 2005, 05:55:08 PM
How to add your own buttons on the header.
Title: Re: Tutorials I need to write...
Post by: vicez on September 24, 2005, 07:42:15 AM
http://unknown.network32.net/tutorial.smf_custom-profile

-[Unknown]

Is it just me or page cannot be found?
Title: Re: Tutorials I need to write...
Post by: Snickers on September 24, 2005, 07:44:00 AM
try this: http://www.unknownbrackets.com/tutorials/custom-profile
Title: Re: Tutorials I need to write...
Post by: Purplemadness on September 25, 2005, 01:31:06 PM
How to add your own buttons on the header.

The same, it's really handy to know ;)
Title: Re: Tutorials I need to write...
Post by: songdancer on December 21, 2005, 01:00:00 PM
I've been researching and reading the forums, and here are a few of things that I haven't quite found enough info on as a newbie (or that I keep coding wrong and can't figure out from the existing threads on the subjects):

Making the forum default to expanded status (deleting the upshrink function so that it isn't available at all).

Adding google adwords or other ads to the site at the header or footer or left side or right side.

Adding additional fields to the forum registration form (location, phone #, etc)--and also having that location (state) to display in user's posts.




Thanks!


Title: Re: Tutorials I need to write...
Post by: eriktm on April 06, 2006, 11:43:32 AM
Remember that I'm a developer, I write CODING documentation :P.

I tought you was a SMF Friend :P