[ Midtown Madness 2 Central ] [ Midtown Madness 2 Central ]

Midtown Madness 2 Central > City Editing > Categories - naming convention (Updated Ver B. 23-04-2006)
Goto page 1, 2  Next
View previous topic | View next topic

What do you think about naming convention proposals?
I prefere version "A"
66%
 66%  [ 6 ]
I prefere version "B"
22%
 22%  [ 2 ]
I like both versions
11%
 11%  [ 1 ]
I don't like them
0%
 0%  [ 0 ]
Total Votes : 9

Author
Message Post new topicReply to topic
Maxoff
MM2C Addict

Joined: 11 Nov 2004
Posts: 560
Location: Poland

Status: Offline


Post subject: Categories - naming convention (Updated Ver B. 23-04-2006) Reply with quote

As you probably know, City Editing contains many threads. Some of them concern research, other concern particular tools. It's really hard to find relevant information, because all topics are in one category. Some threads even concern progress reports on certain city projects.

This is the reason, why we should implement a hierarchical tree of categories to make browsing and searching much easier.

-------------------

VERSION A

The naming convention looks like this:
Code:
[category_subcategory_threadtype]

Here is our (mine and fre_ber's) proposal of categories and threadtypes:
Code:
+-* Research
| +-* Terrain
| +-* Ambients
| +-* Sounds
+-* Tools
  +-* MM2CT
  | +-* INFO
  | +-* TUTORIAL or T
  | +-* QUESTION  or Q
  | +-* BUG
  +-* TEX2XV
  | +-* INFO
  | +-* TUTORIAL or T
  | +-* QUESTION or Q
  | +-* BUG
  +-* RS3D
  | +-* INFO
  | +-* TUTORIAL or T
  | +-* QUESTION or Q
  | +-* BUG
  +-* PSDLViewer
    +-* INFO
    +-* TUTORIAL or T
    +-* QUESTION or Q
    +-* BUG

We recommend to use full names like TUTORIAL, but if the topic's name is too long, you can use T instead of TUTORIAL.

Examples of use:
1. If you have problem with roads in your city and you use MM2CT to make it:
Code:
[Tools_MM2CT_QUESTION] Road problem

or
Code:
[Tools_MM2CT_Q] Road problem - I have perimeters error

2. If you want to know how to run PSDL Viewer:
Code:
[Tools_PSDLViewer_QUESTION] I cannot run the program

or
Code:
[Tools_PSDLViewer_Q] I cannot run the program - Java 3D not found

etc.

With that naming convention, it's easy to find relevant information. You just have to prepare the right query for the search engine.

Examples of searching:
1. You want to find all tutorials for MM2CT
Code:
Tools_MM2CT_T*

2. You want to find all questions for MM2CT
Code:
Tools_MM2CT_Q*

3. You want to find all topics about PSDLViewer
Code:
Tools_PSDLViwer*

4. You want to find all topics about sound research
Code:
Research_Sounds*

etc.

-------------------

VERSION B

Code:
Hierarchy        Code   Description
---------        ----   -----------
+-* Research     [R]    MM2 city research
| +-* Terrain    [RT]   General research related to MM2 terrain
| | +-* Info     [RTI]  Current specification or information
| | +-* Question [RTQ]  Question about MM2 terrain
| +-* Ambients   [RA]   Peds and traffic
| | +-* Info     [RAI]  Current specification or information
| | +-* Question [RAQ]  Question about MM2 ambients
| +-* Sounds     [RS]   MM2 city sounds
| | +-* Info     [RSI]  Current specification or information
| | +-* Question [RSQ]  Question about MM2 city sounds
| +-* Info       [RI]   Information about the research itself
| +-* Question   [RQ]   Question about the research itself
| +-* Experiment [RE]   Description of a research experiment
+-* Tools        [T]    MM2 city tools
  +-* MM2CT      [TCT]  Maxoff's MM2 City Toolkit
  | +-* Info     [TCTI] Release information or manual
  | +-* Tutorial [TCTT] Tutorial of usage
  | +-* Question [TCTQ] Question about the tool
  | +-* Bug      [TCTB] Bug report
  +-* TEX2XV     [TTX]  Legoguy's TEX converter
  | +-* Info     [TTXI] Release information or manual
  | +-* Tutorial [TTXT] Tutorial of usage
  | +-* Question [TTXQ] Question about the tool
  | +-* Bug      [TTXB] Bug report
  +-* RS3D       [TRS]  fre_ber's Realsoft3D MM2 plugins
  | +-* Info     [TRSI] Release information or manual
  | +-* Tutorial [TRST] Tutorial of usage
  | +-* Question [TRSQ] Question about the tool
  | +-* Bug      [TRSB] Bug report
  +-* PSDLViewer [TPV]  fre_ber's PSDLViewer
  | +-* Info     [TPVI] Release information or manual
  | +-* Tutorial [TPVT] Tutorial of usage
  | +-* Question [TPVQ] Question about the tool
  | +-* Bug      [TPVB] Bug report
  +-* Info       [TI]   Release information or manual for an unclassified tool
  +-* Question   [TQ]   Question about an unclassified tool


Examples of use:
1. If you have problem with roads in your city and you use MM2CT to make it:
Code:
[TCTQ] Road problem

2. If you want to know how to run PSDL Viewer:
Code:
[TPVQ] I cannot run the program

etc.

Examples of searching:
1. You want to find all tutorials for MM2CT
Code:
[TCTT*

2. You want to find all questions for MM2CT
Code:
[TCTQ*

3. You want to find all topics about PSDLViewer
Code:
[TPV*

4. You want to find all topics about sound research
Code:
[RS*

etc.
-------------------

We hope that it will help you to find information you are searching for, because very often you ask question which has already been answered.

Please use this naming convention in your topics and please try to change names of your old topics.

If you have any suggestions or comments to categories, please write it here.
_________________
... You only have to know how to prepare query, google will do the rest ...
... My software ...
... Guide to Punctuation ...


Last edited by Maxoff on 23 Apr 2006 04:39 pm; edited 7 times in total
Post 18 Apr 2006 11:21 am
View user's profile Send private message Visit poster's website
secondhalf
Waterboy

Joined: 01 Apr 2006
Posts: 2


Status: Offline


Post subject: Reply with quote

Brilliant idea, I like it a lot as it would most likely to inspire this community including me quite a bit in many different areas. Keep up the good work Max!
Post 18 Apr 2006 11:56 am
View user's profile Send private message
fre_ber
triangle fan
Moderator

Joined: 15 Jul 2002
Posts: 2399
Location: ZZ9 Plural Z Alpha

Status: Offline


Post subject: Reply with quote

Hmm, the limit of the thread subject line is really making this difficult. I ended up using abbreviations just about everywhere, and I'd like to think of my subject lines as fairly short and consise...

And for searching, I don't think that letting the author choose between abbreviations or not is a good idea. I have to opt for only abbreviations this time. And maybe we have to get rid of the underscore separator as well? These would look more like library codes than something that is immediately understandable, but it would only require a look in this thread to find out what to search for.
_________________

"He who re-invents the wheel, understands much better how a wheel works."

<[4D]JoeShmo> what we have here, is a failure.. to communicate
Post 18 Apr 2006 12:44 pm
View user's profile Send private message Visit poster's website
fre_ber
triangle fan
Moderator

Joined: 15 Jul 2002
Posts: 2399
Location: ZZ9 Plural Z Alpha

Status: Offline


Post subject: Reply with quote

What about something like this? Or would it be too confusing?

  • Research
    • Terrain
      • Info - [RTI]
      • Question - [RTQ]

    • Ambients
      • Info - [RAI]
      • Question - [RAQ]

    • Sounds
      • Info - [RSI]
      • Question - [RSQ]


  • Tools
    • MM2CT
      • Info - [TCTI]
      • Tutorial - [TCTT]
      • Question - [TCTQ]
      • Bug - [TCTB]

    • TEX2XV
      • Info - [TTXI]
      • Tutorial - [TTXT]
      • Question - [TTXQ]
      • Bug - [TTXB]

    • RS3D
      • Info - [TRSI]
      • Tutorial - [TRST]
      • Question - [TRSQ]
      • Bug - [TRSB]

    • PSDLViewer
      • Info - [TPVI]
      • Tutorial - [TPVT]
      • Question - [TPVQ]
      • Bug - [TPVB]



_________________

"He who re-invents the wheel, understands much better how a wheel works."

<[4D]JoeShmo> what we have here, is a failure.. to communicate
Post 18 Apr 2006 01:12 pm
View user's profile Send private message Visit poster's website
HummersRock
...is still seeing colours.

Joined: 20 Feb 2006
Posts: 2669
Location: Magic Mushroom Land

Status: Offline


Post subject: Reply with quote

That seems too confusing to me. Confused
_________________
My MM2 Creations | My DeviantArt
Post 18 Apr 2006 08:00 pm
View user's profile Send private message Send e-mail Visit poster's website
modelerchris
Mid n00b modeler :p

Joined: 25 Feb 2006
Posts: 400
Location: In your ignoration.

Status: Offline


Post subject: Reply with quote

Its better orgranised, but there are MUCH more tools than that.
_________________
I may be a geek, but hey, I'm smarter than you are!
Awards:
Canned Ham Award - Thank you very much!
Beesting Award - How did I know? Mr. Green

Thank you very much!!!
Post 19 Apr 2006 03:41 am
View user's profile Send private message Send e-mail Visit poster's website
Undertaker
Rock God

Joined: 24 Dec 2004
Posts: 495


Status: Offline


Post subject: Reply with quote

i think when it comes to the programs it's kind of hard to tell which one to use.
_________________
formerly known as pro_racer

Come on in! http://www.mm2shop.tk See my creations!

i didn't know undertaker was a wrestler, no really. i didn't.
Post 19 Apr 2006 04:09 am
View user's profile Send private message Visit poster's website
Maxoff
MM2C Addict

Joined: 11 Nov 2004
Posts: 560
Location: Poland

Status: Offline


Post subject: Reply with quote

modelerchris wrote:
Its better orgranised, but there are MUCH more tools than that.

New tools can be added to categories in the future, so it's not a problem.

Undertaker wrote:
i think when it comes to the programs it's kind of hard to tell which one to use.

In most cases, the problem is connected to particular program. You don't have to start with proper subject, you can always rename it when your problem is solved. Categories are for people who browse and search the forum.

We can start a poll to decide which naming convenction should be use, what do you think about it?
_________________
... You only have to know how to prepare query, google will do the rest ...
... My software ...
... Guide to Punctuation ...
Post 19 Apr 2006 09:22 am
View user's profile Send private message Visit poster's website
fre_ber
triangle fan
Moderator

Joined: 15 Jul 2002
Posts: 2399
Location: ZZ9 Plural Z Alpha

Status: Offline


Post subject: Reply with quote

Yes, do that. However, I must point out that I would also prefer the longer, more descriptive tags. Unfortunately the length of thread subjects is restricted and the allowed length makes it difficult to write a good subject. We wouldn't want threads named "[....] Help?" or something that silly just because the real subject wouldn't fit in the subject input field.

And remember, these tags are only for cataloguing and searching - it isn't really necessary to know what each code really stands for as long as the first post in this thread contains the list of codes with descriptions. Then, what you can do is to first look up the code that mach the category of your own question and then search for posts with that code.
_________________

"He who re-invents the wheel, understands much better how a wheel works."

<[4D]JoeShmo> what we have here, is a failure.. to communicate
Post 19 Apr 2006 05:44 pm
View user's profile Send private message Visit poster's website
Undertaker
Rock God

Joined: 24 Dec 2004
Posts: 495


Status: Offline


Post subject: Reply with quote

oh. ok. that makes sense. i'll go with it.
_________________
formerly known as pro_racer

Come on in! http://www.mm2shop.tk See my creations!

i didn't know undertaker was a wrestler, no really. i didn't.
Post 20 Apr 2006 03:27 am
View user's profile Send private message Visit poster's website
Maxoff
MM2C Addict

Joined: 11 Nov 2004
Posts: 560
Location: Poland

Status: Offline


Post subject: Reply with quote

fre_ber wrote:
We wouldn't want threads named "[....] Help?"

The longest prefix takes 30 letters, so for thread names there will be 30 letters too - it's pessimistic variant. I think that in most cases it's enough.

BTW. I've started a poll, please vote.
_________________
... You only have to know how to prepare query, google will do the rest ...
... My software ...
... Guide to Punctuation ...
Post 21 Apr 2006 09:20 pm
View user's profile Send private message Visit poster's website
fre_ber
triangle fan
Moderator

Joined: 15 Jul 2002
Posts: 2399
Location: ZZ9 Plural Z Alpha

Status: Offline


Post subject: Reply with quote

Hmm... Can a subject really be 60 characters? I had some problems when I tried to add these prefixes to some of my threads. phpBB refused to take all characters.. And I don't think I was anywhere near 60 characters... Maybe I was insane. Neutral
_________________

"He who re-invents the wheel, understands much better how a wheel works."

<[4D]JoeShmo> what we have here, is a failure.. to communicate
Post 21 Apr 2006 09:40 pm
View user's profile Send private message Visit poster's website
Maxoff
MM2C Addict

Joined: 11 Nov 2004
Posts: 560
Location: Poland

Status: Offline


Post subject: Reply with quote

Code:
<input type="text" name="subject" size="45" maxlength="60" style="width:450px" tabindex="2" class="post" value="Categories - naming convention" />

It looks like 60 letters.

Categories - naming convention 12345678901234567890123456789 has 60 characters and it works - I've just checked it.
_________________
... You only have to know how to prepare query, google will do the rest ...
... My software ...
... Guide to Punctuation ...


Last edited by Maxoff on 21 Apr 2006 09:46 pm; edited 1 time in total
Post 21 Apr 2006 09:43 pm
View user's profile Send private message Visit poster's website
fre_ber
triangle fan
Moderator

Joined: 15 Jul 2002
Posts: 2399
Location: ZZ9 Plural Z Alpha

Status: Offline


Post subject: Reply with quote

Oh well, I must have been insane then. Smile
_________________

"He who re-invents the wheel, understands much better how a wheel works."

<[4D]JoeShmo> what we have here, is a failure.. to communicate
Post 21 Apr 2006 09:45 pm
View user's profile Send private message Visit poster's website
fre_ber
triangle fan
Moderator

Joined: 15 Jul 2002
Posts: 2399
Location: ZZ9 Plural Z Alpha

Status: Offline


Post subject: Reply with quote

Yes, it was 60 characters, and it probably always was. But I did take an additional look at my topic names and found that 60 characters are not enough if I am to use Version A. For example, is this a too long topic name?

Stop ligths in London - wrong side

I think not, but this

[RESEARCH_AMBIENTS_QUESTION]Stop ligths in London - wrong side

is longer than 60 characters. This means that I have to vote for Version B.

[RAQ]Stop ligths in London - wrong side

Looks a lot better to me, visually, the classification of the thread shouldn't take as much, or more, attention than the actual topic name. And this still serves the intended purpose of adding a tag that can be used for searching.
_________________

"He who re-invents the wheel, understands much better how a wheel works."

<[4D]JoeShmo> what we have here, is a failure.. to communicate
Post 23 Apr 2006 01:22 pm
View user's profile Send private message Visit poster's website
Display posts from previous: Post new topicReply to topic

Page 1 of 2 All times are GMT
Goto page 1, 2  Next


Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
Home - MM2C.com - Contact - Staff & Seniors - FAQ - Community Rules - Syndication


Powered by phpBB © 2001, 2005 phpBB Group