Advertisement:

Author Topic: As a Regular User - A PDF Compilation for New Users of SMF  (Read 34704 times)

Offline Irisado

  • Doc Coordinator
  • SMF Hero
  • *
  • Posts: 8,832
  • Soñando debajo del arco iris
As a Regular User - A PDF Compilation for New Users of SMF
« on: November 06, 2013, 05:54:37 PM »
The Documentation Team has fully reviewed and edited the 'As a Regular User' section of the SMF Online Manual and is now making it available as a PDF. This is part of the continual process of improving the quality of the documentation and making it more accessible to the SMF community. The PDF covers the basic aspects of SMF and is particularly useful for people that are new to SMF or forums in general.

The PDF is attached to this post, so feel free to download it and let us know what you think. In addition, the PDF can be distributed in accordance with the creative commons license
« Last Edit: November 06, 2013, 06:26:01 PM by Irisado »
Soñando con una playa donde brilla el sol, un arco iris ilumina el cielo, y el mar espejea iridescentemente

Offline margarett

  • SMF Friend
  • SMF Super Hero
  • *
  • Posts: 19,762
  • Gender: Male
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #1 on: November 06, 2013, 08:10:13 PM »
Nicely done ;) Looks nice!
Se forem conduzir, não bebam. Se forem beber... CHAMEM-ME!!!! :D

Quote
Over 90% of all computer problems can be traced back to the interface between the keyboard and the chair

Offline Colin

  • Lead Developer
  • SMF Hero
  • *
  • Posts: 7,701
  • Gender: Male
  • SMF Developer
    • colinschoen on GitHub
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #2 on: November 06, 2013, 08:42:05 PM »
Very useful! Thank you.
"If everybody is thinking alike, then somebody is not thinking." - Gen. George S. Patton Jr.

Colin

Online CoreISP

  • Server Admin
  • Server Team
  • SMF Super Hero
  • *
  • Posts: 16,787
  • Gender: Male
  • CoreISP.net
    • liroyvh on LinkedIn
    • @liroyvh on Twitter
    • CoreISP Corporation :: WebHosting, Dedicated Servers, and more!
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #3 on: November 07, 2013, 12:07:08 AM »
Good job :)
- CoreISP.net Corporation -
  WebHosting, Colocation, Domain Registration & Network Services
- DedicatedBox.us Servers -
  Low priced Servers in a high-quality Network, the place for all your (advanced) server needs.
  We specialize in hosting big boards. Contact us!

((U + C + I)x(10 − S)) / 20xAx1 / (1 − sin(F / 10))
President/CEO of Simple Machines - Server Manager
Please do not PM for support - anything else is usually OK.

Offline 4Kstore

  • SMF Hero
  • ******
  • Posts: 4,296
  • Gender: Male
    • agustintari on Facebook
    • @agustintarifa on Twitter
    • SSIMPLE TEAM PAGE
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #4 on: November 07, 2013, 01:44:02 AM »
Very nice! good job
¡¡NEW MOD: Sparkles User Names!!!

Offline sǝๅqɯɐɥS

  • SMF Hero
  • ******
  • Posts: 4,419
  • Gender: Male
    • i30 Owners Club
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #5 on: November 07, 2013, 04:00:28 AM »
This is a very good piece of work; nicely done.

If I have one criticism, it's in the interchange of personal and impersonal addressing: some parts of the brief speak directly to the reader and refer to him as "you", while others refer to "the member" or "a guest".

For example:

Quote
The Login Screen:
This is the screen you see when you use the "Login" option of the main menu

▪ Username - The member's username
▪ Password - The member's password

 ... When using a shared computer, a member probably should not stay logged in for a long time.

Logging out
When you have finished browsing the forum, you may decide to logout


As the document is entitled "As A Regular User" I'd prefer to see the personal aspect prevail.

On that matter, is it correct to include descriptions of detail that are impertinent to "regular users", such as the mechanics for IP tracking, warning, and banning?

Offline Irisado

  • Doc Coordinator
  • SMF Hero
  • *
  • Posts: 8,832
  • Soñando debajo del arco iris
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #6 on: November 07, 2013, 07:26:25 AM »
The use of 'you' is for when articles address the reader directly, while words such as 'member' or less commonly 'user' are chosen when explaining how a function works.

In the case of the examples you cite, 'member' was preferred because those sentences explain a function of SMF, whereas the logging out section is a direct suggestion to the user, rather than a technical explanation of the function of logging out.

This doesn't mean that we will have always used the correct word every time, but that was the rationale behind the choice.

Regarding the mechanics you list, I don't think that there is any issue with giving a rough outline about these options, since they can directly affect regular users.  We're not giving away a huge amount about administration functions, and curious minds could find out about the administration functions anyway by looking through other wiki pages ;).
Soñando con una playa donde brilla el sol, un arco iris ilumina el cielo, y el mar espejea iridescentemente

Offline socializemetoday

  • Semi-Newbie
  • *
  • Posts: 11
    • socializemetoday on Facebook
    • @socializmetoday on Twitter
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #7 on: November 25, 2013, 12:14:16 AM »
Thanks. Really useful information. I always need assistance when I work with smf on my site

Offline johnpaul2k2

  • Sr. Member
  • ****
  • Posts: 738
  • Gender: Male
  • Okija amaka
    • Mgbenka
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #8 on: March 04, 2014, 08:27:47 AM »
please does it covers the coding aspect?


Offline Irisado

  • Doc Coordinator
  • SMF Hero
  • *
  • Posts: 8,832
  • Soñando debajo del arco iris
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #10 on: March 04, 2014, 08:47:46 AM »
That's beyond the scope of the PDF.  I've replied in more detail in your thread on this issue.
Soñando con una playa donde brilla el sol, un arco iris ilumina el cielo, y el mar espejea iridescentemente

Offline Illori

  • Project Manager
  • SMF Master
  • *
  • Posts: 47,495
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #11 on: March 04, 2014, 08:47:51 AM »
no it does not, as the title of this thread says it only covers as a regular user category.

Offline umina

  • Newbie
  • *
  • Posts: 2
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #12 on: March 10, 2014, 02:52:21 PM »
This sounds like my next step in understanding SMF, but I can't figure out where the attached PDF file is!

I'm having a very basic issue.  What is the difference between a forum, topic, category, and board.  An example would really help, but a hierarchical diagram would be awesome.

I'm setting up a new system to handle the organization of the insurrection inside our HOA and since this is going to be a "flame on" application once I open it up, I really need to make sure I get the basic structure perfect the first time.

There must be an example somewhere.

From what I understand forums are global segments within the site.  Beyond that boards, categories, and topics are confusing.  I think they go in that order as far as granularity is concerned, but I'm concerned that violating of the hierarchy might cause me to create a site that destroys the presumed architecture of the application and destroy the performance of SMF by accident.  (For a stupid example, lets say every topic was a forum).

Therefore explicitly understanding the intended relationship could be really important.  I tried the documentation, searched the forums, and came up empty handed.

So I went to Google.  This got me really confused.  One site hxxp:www.aacconline.org/smf/index.php?action=help;page=index#message [nonactive] goes to great length to explain the granularity to its users.  It has board and category reversed from my first impression, but the explanation certainly did not help regardless.

I found other sites that have similar help postings, but things like "The forum name links back to the top of the board index" get pretty confusing if the board is inside the forum two levels deep (forum->category->board->topic->posts).  This says to me that "board index" is not being used correctly, but as a newbie to SMF I wouldn't make that statement.

Any insight, example, or pointer to a properly structured open site would be appreciated.

/Len


Offline Burke ♞ Knight

  • SMF Hero
  • ******
  • Posts: 3,534
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #14 on: March 10, 2014, 02:58:03 PM »
Quote
This sounds like my next step in understanding SMF, but I can't figure out where the attached PDF file is!

Tried looking on the first post?
There as attachment. :)

TheKnown

  • Guest
Re: As a Regular User - A PDF Compilation for New Users of SMF
« Reply #15 on: March 10, 2014, 02:59:57 PM »
This sounds like my next step in understanding SMF, but I can't figure out where the attached PDF file is!

on the first post under the signature.

I'm having a very basic issue.  What is the difference between a forum, topic, category, and board.  An example would really help, but a hierarchical diagram would be awesome.

forum what you are on.
category is collection of board(s)
board is a collection of topic(s)
topic is a collection of post(s)
post is a collection of words/numbers/images

each can be plural or singular

I'm setting up a new system to handle the organization of the insurrection inside our HOA and since this is going to be a "flame on" application once I open it up, I really need to make sure I get the basic structure perfect the first time.

if you dont understand how forums etc work how do you plan on doing this effectivley