Freelancer Community Network

ForgeTips » History » Version 29

Bullwinkle, 05/12/2010 02:44 AM

1 4 Bullwinkle
h1. Forge Tips
2 1 Bullwinkle
3 1 Bullwinkle
Collected Tips about using the-Starport Forge -- Bullwinkle
4 2 Bullwinkle
5 20 Bullwinkle
{{toc}}
6 20 Bullwinkle
7 8 Bullwinkle
h1. Sub-Projects
8 1 Bullwinkle
9 8 Bullwinkle
You can add and manage your own sub-projects as you like. There are many uses for sub-projects. One that we found immediately useful was to keep our main project Public, and create a Private Development sub-project. 
10 1 Bullwinkle
11 8 Bullwinkle
That way, the team can work in privacy, and still publish finished work in the Public project:
12 1 Bullwinkle
13 8 Bullwinkle
*Main Project (Public)*
14 8 Bullwinkle
* Wiki
15 8 Bullwinkle
* Files
16 8 Bullwinkle
* News
17 1 Bullwinkle
18 8 Bullwinkle
*Dev Sub-Project (Private)*
19 8 Bullwinkle
* Wiki
20 8 Bullwinkle
* Forums
21 8 Bullwinkle
* Issues (bug tracker)
22 8 Bullwinkle
* Repository (SubVersion Version Control)
23 8 Bullwinkle
* Activity
24 8 Bullwinkle
* Files
25 1 Bullwinkle
26 22 Bullwinkle
.
27 9 Bullwinkle
28 9 Bullwinkle
h1. Forums
29 1 Bullwinkle
30 9 Bullwinkle
Want to talk with the team when members live in different time zones? And keep track of the conversation, just in case somebody says something important? But you don't want to fill up the-Starport's forum with off-topic chatter?
31 9 Bullwinkle
32 9 Bullwinkle
Then project Forums may be for you. They work very much like the-Starport's main forum, except that you have more control over them. A Forum in your Public Project will be open to all, while a Forum in your Private Sub-Project is only readable by your team.
33 9 Bullwinkle
34 9 Bullwinkle
Use the Activity Page and/or Watches to follow the topics in your forums... see "What's New", below.
35 18 Bullwinkle
36 22 Bullwinkle
.
37 18 Bullwinkle
38 21 Bullwinkle
h1. Whats New -- Keeping Track of Your Team
39 1 Bullwinkle
40 8 Bullwinkle
If your team is busy making updates to your mod or project documentation, then it can be challenging to keep track of who has changed what recently. Two features of the Forge help you to see What's New:
41 1 Bullwinkle
42 8 Bullwinkle
h2. Activity Page
43 5 Bullwinkle
44 8 Bullwinkle
Look at the Activity Page for a quick way to see What's New in your project. Use the filter checkboxes on the right to select which items you want to see on the Activity Page:
45 5 Bullwinkle
46 8 Bullwinkle
!Activity01.png!
47 5 Bullwinkle
48 22 Bullwinkle
.
49 22 Bullwinkle
50 8 Bullwinkle
h2. Watches
51 5 Bullwinkle
52 1 Bullwinkle
Many of the project pages can be "Watched", which means that you will get an email when that page changes. 
53 8 Bullwinkle
54 24 Bullwinkle
For example, if you keep track of team chatter (questions, answers, decisions) by using a private Forum, then you might want to receive an email when a team member makes a post. Wiki pages, Issues, and other pages can also be Watched. To set a Watch, look for a small "Watch" button in the upper right-hand corner of the page:
55 5 Bullwinkle
56 8 Bullwinkle
> !Watch01.png!
57 3 Bullwinkle
58 20 Bullwinkle
59 22 Bullwinkle
.
60 22 Bullwinkle
61 22 Bullwinkle
.
62 22 Bullwinkle
63 20 Bullwinkle
h1. Using the Wiki
64 1 Bullwinkle
65 1 Bullwinkle
The Wiki on the Adventures of Trent Forge is powerful and easy to use. You can make many kinds of web pages with it.
66 1 Bullwinkle
67 1 Bullwinkle
Use the buttons at the top of the page to insert formatting codes, or just memorize them.
68 1 Bullwinkle
69 1 Bullwinkle
If you want to create a new page, simply create a link to a new page with a unique name (in Edit mode). Then, click the link (in Read mode) to create the new page.
70 1 Bullwinkle
71 1 Bullwinkle
This is a link in *Edit Mode*:
72 1 Bullwinkle
73 1 Bullwinkle
!Wiki01.png!
74 1 Bullwinkle
75 1 Bullwinkle
76 22 Bullwinkle
.
77 1 Bullwinkle
78 1 Bullwinkle
2) To *Cancel* your editing session and return to Read mode, *click Wiki* on the Forge toolbar:
79 1 Bullwinkle
80 1 Bullwinkle
81 1 Bullwinkle
!Wiki02.png!
82 1 Bullwinkle
83 1 Bullwinkle
84 1 Bullwinkle
85 22 Bullwinkle
.
86 1 Bullwinkle
87 22 Bullwinkle
88 1 Bullwinkle
You should now be in *Read mode*. Simply click your new link to create a new page.
89 1 Bullwinkle
90 2 Bullwinkle
91 2 Bullwinkle
!Wiki03.png!
92 2 Bullwinkle
93 8 Bullwinkle
94 1 Bullwinkle
95 22 Bullwinkle
.
96 22 Bullwinkle
97 21 Bullwinkle
h1. Files Module
98 8 Bullwinkle
99 8 Bullwinkle
The Files module gives you *a place to host files for the public*, such as a version of a mod. Once uploaded to the Forge, Files cannot be renamed or moved. The reason for this is that each file in the Files module gets a URL so that you can link to the file from elsewhere (such as the-Starport forum, for example).
100 8 Bullwinkle
101 8 Bullwinkle
In order to keep your Files organized, you can use Versions to mimic sub-folders. *In Settings, Create a New Version*:
102 8 Bullwinkle
103 8 Bullwinkle
!Files01.png!
104 8 Bullwinkle
105 8 Bullwinkle
106 1 Bullwinkle
107 22 Bullwinkle
.
108 22 Bullwinkle
109 8 Bullwinkle
The Version *Name* is what users will see in the Files listing as a header -- similar to a folder.
110 8 Bullwinkle
The Optional *Wiki Page* is the name of a page in your project's Wiki that is linked to this Version's Files.
111 1 Bullwinkle
112 8 Bullwinkle
!Files02.png!
113 8 Bullwinkle
114 1 Bullwinkle
115 1 Bullwinkle
116 22 Bullwinkle
.
117 22 Bullwinkle
118 8 Bullwinkle
Go to the Files Module, and click *New File* to upload a file.
119 8 Bullwinkle
120 8 Bullwinkle
!Files03.png!
121 1 Bullwinkle
122 1 Bullwinkle
123 24 Bullwinkle
124 24 Bullwinkle
.
125 24 Bullwinkle
126 24 Bullwinkle
In the *New File dialog*, use the pull-down menu to choose the Version/Folder where you want the file.
127 24 Bullwinkle
128 24 Bullwinkle
!Files04.png!
129 1 Bullwinkle
130 22 Bullwinkle
.
131 22 Bullwinkle
132 10 Bullwinkle
h1. Version Control
133 11 Bullwinkle
134 10 Bullwinkle
The coolest and most important feature of the Forge is Version Control (via SubVersion - SVN). A Version Control System (VCS) allows team members to work on the same code without interfering with each other. A VCS offers:
135 1 Bullwinkle
136 26 Bullwinkle
* Automatic backup of _every_ change made by _every_ developer on the team. (Well, every _committed_ change.)
137 22 Bullwinkle
* Semi-Automatic Merge(*)
138 10 Bullwinkle
* Encourages good documentation and good communication between team members.
139 10 Bullwinkle
* Ability to mark a "version", which includes all of the source files required to make that version.
140 10 Bullwinkle
* Ability to roll back changes (in case you try something that does not work).
141 1 Bullwinkle
142 1 Bullwinkle
SubVersion is a popular Version Control System (VCS). The server side is SubVersion. The client side can be one of many client tools. TortoiseSVN is popular for Windows users because it is integrated into the Explorer (does not require a special control panel).
143 22 Bullwinkle
144 22 Bullwinkle
bq. (*) If you are familiar with other VCS systems, then you will notice that SubVersion's "Check Out" is different. Instead of locking a file on Check Out, SubVersion allows developers to freely check out the same files. In fact, SubVersion encourages multiple-user Check Out by Checking Out entire folders rather than individual files. 
145 22 Bullwinkle
146 22 Bullwinkle
bq. The underlying assumption is that the two developers will be working on different parts of the file, so that their work should not interfere with each other. This is not always a good assumption, but it avoids the problem that other VCS systems have with forcing developers to wait for each other.
147 22 Bullwinkle
148 22 Bullwinkle
bq. If two developers edit the same file at the same, SubVersion automatically helps the developer to merge his/her changes. This reduces conflicts while allowing maximum team productivity. 
149 22 Bullwinkle
150 22 Bullwinkle
bq. Obviously, poor team communication can cause this feature to backfire. Two developers working on the same part of the same file (or who make sweeping changes to the entire file), can create a difficult Merge. If this happens, conflicts will have to be sorted out the old-fashioned way... with a careful manual merge.
151 22 Bullwinkle
152 26 Bullwinkle
h2. SubVersion Most-Used Commands
153 1 Bullwinkle
154 26 Bullwinkle
*CheckOut*
155 26 Bullwinkle
Get a project (or sub-folders) from the server. Used when getting a new project. Puts a copy of the project tree in your "working copy" folder.
156 1 Bullwinkle
157 26 Bullwinkle
*SVN Commit* (CheckIn)
158 26 Bullwinkle
Update the server with changes you have made. Creates a minor revision number every time any team member commits. Note that it is normal for revision numbers to grow quickly.
159 26 Bullwinkle
160 26 Bullwinkle
*Merge*
161 26 Bullwinkle
Compare (or Diff) your changes with the changes on the server. A Merge will automatically be triggered if you and another developer both Commit changes to the same revision of a file. 
162 26 Bullwinkle
163 26 Bullwinkle
*SVN Update*
164 26 Bullwinkle
Update your working copy with the most recent files from other team members. WARNING: An Update could over-write any changes you have made, so be sure to Commit any changes that you want to keep.
165 26 Bullwinkle
166 26 Bullwinkle
.
167 26 Bullwinkle
168 28 Bullwinkle
h2. How to Get a Working Copy of a Project
169 26 Bullwinkle
170 29 Bullwinkle
1) First, you must know the project's nickname on the Forge server. Let's use FLSES as an example, because it was asked about on the-Starport forum. Browse to the FLSES project page, then look at the end of the URL. The nickname is "flses":
171 26 Bullwinkle
172 26 Bullwinkle
!SVN01.png!
173 1 Bullwinkle
174 27 Bullwinkle
.
175 1 Bullwinkle
176 27 Bullwinkle
2) In Windows Explorer, make a folder where you want to put the FLSES project tree:
177 27 Bullwinkle
178 27 Bullwinkle
!SVN02.png!
179 27 Bullwinkle
180 27 Bullwinkle
.
181 27 Bullwinkle
182 27 Bullwinkle
3) Right-click the folder and select "SVN Checkout":
183 27 Bullwinkle
184 27 Bullwinkle
!SVN03.png!
185 27 Bullwinkle
186 27 Bullwinkle
.
187 27 Bullwinkle
188 27 Bullwinkle
4) In the Checkout dialog, enter the URL of repository: http://svn.the-starport.net/flses. Leave everything else at their default settings:
189 27 Bullwinkle
190 27 Bullwinkle
!SVN04.png!
191 27 Bullwinkle
192 27 Bullwinkle
.
193 27 Bullwinkle
194 27 Bullwinkle
5) Click "OK"
195 25 Bullwinkle
196 25 Bullwinkle
If you are prompted for username and password, use your Forge credentials.
197 25 Bullwinkle
198 25 Bullwinkle
TortoiseSVN should then fill your selected folder with the newest revision from the FLSES SVN Repository.
199 25 Bullwinkle
200 25 Bullwinkle
Don't worry... SubVersion CheckOuts do not lock anything. "Export" does nearly the same thing. The difference between "Export" and "Checkout" in SubVersion is that a CheckOut adds hidden .svn folders which SubVersion then uses if you ever CheckIn a modified file. 
201 25 Bullwinkle
202 25 Bullwinkle
(Note that SubVersion CheckOuts are different than other Version Control Systems which lock Checked Out files.)
203 22 Bullwinkle
204 25 Bullwinkle
.
205 22 Bullwinkle
206 25 Bullwinkle
.
207 22 Bullwinkle
208 23 Bullwinkle
.
209 25 Bullwinkle
210 25 Bullwinkle
.
211 25 Bullwinkle
212 25 Bullwinkle
.
213 23 Bullwinkle
214 23 Bullwinkle
bq. Last edited by *Bullwinkle* 2010-05-11
215 22 Bullwinkle
216 25 Bullwinkle
.
217 22 Bullwinkle
218 25 Bullwinkle
.
219 22 Bullwinkle
220 22 Bullwinkle
.
221 1 Bullwinkle
.