Daniel and I talk about naming convention that we will use in our java/RIFE project. There is too much files and folders and types, so we decided to write our naming convention today, here is the result:
FILES
- Folders :
- All folder names are SINGULAR
- All folder names are in small capital.
Example: folder for flibz is "flibz", not "FLIBZ" or "Flibz", folder for search form is "searchform", not "SearchForm", or "searchForm", or "SEARCHFORM" - All folder names are written without space
Example: folder name for usability test is "usabilitytest", not "usability test" - Try not to make a long folder name, maximal 2 words, in case 3 or more words needed, try to make folder inside folder.
- Truncated name is acceptable, but not preffered.
Example "docgenerator" is acceptable but "generator" is preffered - Files
- All file names are SINGULAR
- All file names are in small capital, except for Java files. Example: file name for xml file for search form is "search.xml", not "Search.xml" or "SEARCH.xml", the name for html file for add friend is "addfriend.html", not "AddFriend.html" or "addFriend.html" or "ADDFRIEND.html"
- All file names are written without space
Example: file name for add friend is "addfriend.html", not "add friend.html" - Maximal 2 words for file name (xml or html)
- Truncated name is acceptable, but not preffered.
- EXCEPTION : Java Package, see below
- Java file/package
- The package should be named by <projectType>.<projectTitle>.<folderName>.<FileName>
For example, Flibz java package for search form is com.Flibz.implementation.SearchForm.java - All file/package names is SINGULAR
- All file/package names are writtten without space
- All java package are written with small capital, again package, not file
- All java files begin with Big Capital, new words begin with Big Letter
Example : java file names for search form is "SearchForm.java", not "searchform.java" or "SEARCHFORM.java" - Truncated name is acceptable, but not preffered.
RIFE NAMING CONVENTION
- Element
- Inside element folder, only XML files
- See Naming convention for files
- Noun
- Exactly same name with it's implementation (java files), except the capitals
Example : "searchform.xml" has implementation "SearchForm.java" - Site
- Rep
- Template
- Template folder contains only HTML files
- All template name is NOUN
Example : Page for login is "authentication.html" not "authenticate.html" or "login.html" - Implementation
- Inside implementation folder, only Java files
- The folders inside implementation folder must reflect the folders inside element folder
Example: if authentication.xml is placed in "element/core/authentication.xml" then it's implementation should be placed in "implementation/core/Authentication.java" - Noun
- Exactly same name with it's element
INSIDE PAGE
- Submission/Form
- Always VERB
Example: Form inside "authentication.html" should be named "authenticate" - In case verb = noun, the form is named noun+Form
Example: "loginForm" - Started with small capital, new words started with big capital
Example: "loginForm", not "login form" or "loginform" or "LOGINFORM" - However, one word name is prefered
Example : "authenticate" is preffered rather than "loginForm" - Param/input
- Input is named based on the bean property, usually the same as column in database
- NOUN
- Bean
- Is named by table name in database
Example : table name is "user" then the bean is named "User.java" - NOUN
- Function
- do+Verb, so if the form/submission name is "authenticate" then the function to authenticate the user is "doAuthenticate"
- Element ID is elementName+"Element"
Example: <element id="searchElem" file="element/search.xml" /> - URL : as short as possible, as intuitive as possible. Usually the same as the file name of xml file
Example: <element id="searchElement" file="element/search.xml" url="search" />
I'm using RIFE Java Framework for FLIBZ, and this framework is quite an interesting one, since it's introduce new way of thinking. The only drawback I've found is it's suck difficult to understand documentation. So I (and Daniel, my boyfriend) decided to install the javadoc, which you can download here.
WAIT A MINUTE, before you try to install it, it doesn't install as smooth as I wished, it's just simply doesn't work. The problem is : there are folder inside folder inside folder in the zip file, that makes netbeans (or maybe also other IDE) couldn't read that one. To fix it, simply
1. extract it
2. navigate to the docs-->api
3. you'll find some folders and files, select all (CTRL+A)
4. And archive it using rar/winzip or my favourite 7zip (Right click--> Add to archive)
or if you are too lazy to do it, just click here to download the fixed javadoc
To attach the javadoc to netbeans(I'm using netbeans 5.5.1):
1. Go to tools--> Java Platform Manager
2. Choose your platform (mine is JDK 1.6 Default)
3. Choose javadoc tab (in the right side)
4. Click add ZIP/FOLDER
5. navigate to the zip file you've made before
6. Click add ZIP/FOLDER
7. Click OK
8. Don't need to restart IDE, just enjoy your javadoc :)
Attention : I'm using Netbeans 5.5.1, JDK 1.6, RIFE JAVADOC 1.6.1, other platform/program might have different problem
SYSTEM ARCHITECTURE
I am gonna use RIFE as the framework for Flibz.
I've been thinking with a friend, how to combine these two approach to get a better and more flexible methodology while still reduce cost and time.
Since Flibz is a research project, I will be doing a lot of research, below are the research steps I need to do in pre-production phase
Got comments? Send it to mee :)
Hi guys,
Today I made a short survey to get a general idea about daily work life of people that working in interaction design / usability / user experience field in website development. This survey is used to support my graduation project research about tools for interaction designer in website development area.
For people in similar area, please help me fill this survey, you can access it here .
Thanks a lot.
Best regards,
Lya Santoso
I didn't have time to give it a try yet, but if you have, please comment on this website, I'd like to see it :-)
Addition to previous blog : If you need to run Flash Server side by side with other Java web application server (Jboss / Jboss Web, Apache Tomcat, GlassFish, etc), you should try Red5 War Version
Go to http://osflash.org/red5/070final, scroll down to get WAR files and download it in the server. Extract it in the deploy folder of your web application server, and viola, it's installed.
To change test page, change ROOT.war.
Got cool flash project started, but no fund (yet) to support? Tired of Flash Media Development Server, which limit your connection to 10 only? Got 11 nerdy employees that need to access the server at the same time? It's time to use Red5 .
Red5 is an open source version of Flash Media Server, and it's based on Java (which make it better). You can run it on all platform.
To install it in Linux, go to this link, so straight forward.
My thesis proposal hasn't really been legally accepted, but I've started writing my full thesis. This is one of the practical example of practical Top Down Research.
Top down and bottom up approach are widely used, not only in research but also in ordering, design, investment, software making and even corporate blogging. Although a lot of people try to compare these two approach, I still think there is no the best approach. Whichever is the most suitable to you, it's always depends on your project.
So, what's the difference in these two approach? In this blog post I'll try to compare both in my most fair judgment, although I believe this blog post can only cover the approach in research point of view
Bottom Up Approach
This approach is where people gather all data they can get (like blog
posts, or research papers) and later on filter the data and order it so
that it's "publishable".
Practical example of this approach:
- Get all the books you can get that looks similar with your topic, read all of them, highlight all of important sentences. After enough data collected, write the thesis.
- Make a survey, a big one, and hire a statistician to analyze the results and write a report after that.
- Get more ideas. More data means more idea, this kind of approach give you more flexibility in your research/blog, it could drive your project anywhere you want.
- More costly compared to top-down (also time consuming)
- More data to analyze, it's more difficult
Top Down Approach
In the other way, top down research is an approach to order the finished result first (like the whole thesis) written in outline, and then fill it up with data later.
Practical example of this approach:
- Write your thesis outline, fill it in with dummy data (don't forget to highlight the one that needs attention), conduct research based on that outline, not more.
- Make a report about a survey and conduct a short survey just to fill in the data needed.
- Save time and cost.
- More structure in your project
- It's not flexible, you need to predict all the outcome before you conduct research
- Not suitable for qualitative research
It's quite easy actually, to do "remote desktop" to your server (I use text-based Linux CentOS server). Most of the things have been done in the installation of the Operating System itself (the maker of the OS is sweet enough to make our job easier).
You only need to do 2 step:
- Check your ip address:
- You can use ifconfig command to see your ip address
[root@flibz ~] # ifconfig -
Check on about second line : inet addr : <ip number here> Bcast: something else .....
- Example of your ip address is 297.135.76.12
- Download Putty here or go here to see full list + current version.
- Run putty.exe
- Login with your server password
- Enjoy your remote desktop server
My boyfriend came across this website today. They give a service to combine and optimize all of your images in a page/site and generate css to show the correct "part of" the images correctly.
This way, you can speed up the performance of your website (since to download one image is faster than hundreds of unoptimized one) and it works really good, even though they are still in beta and it might not be free from bugs.
Check it out, they have some other services too.I'll definitelly use them for Flibz website.
Just finished it. If you have time, I'd be interested to see a screenshot of your desktop! I'm also interested... read more
on Survey about IxD/UX daily work life