Freelancer Community Network

ForgeTips » History » Version 16

Bullwinkle, 05/10/2010 10:43 PM

1 4 Bullwinkle
h1. Forge Tips
2 1 Bullwinkle
3 1 Bullwinkle
Collected Tips about using the-Starport Forge -- Bullwinkle
4 2 Bullwinkle
5 8 Bullwinkle
[[ForgeTips#Sub-Projects|Sub-Projects]]
6 9 Bullwinkle
[[ForgeTips#Forums|Forums]]
7 16 Bullwinkle
[[ForgeTips#Whats_New_--_Keeping_Track_of_Your_Team|What's New -- Keeping Track of Your Team]]
8 1 Bullwinkle
[[ForgeTips#Using the Wiki|Using the Wiki]]
9 8 Bullwinkle
[[ForgeTips#Files Module|Files Module]]
10 11 Bullwinkle
[[ForgeTips#Version Control|Version Control]]
11 1 Bullwinkle
12 10 Bullwinkle
13 8 Bullwinkle
h1. Sub-Projects
14 1 Bullwinkle
15 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. 
16 1 Bullwinkle
17 8 Bullwinkle
That way, the team can work in privacy, and still publish finished work in the Public project:
18 1 Bullwinkle
19 8 Bullwinkle
*Main Project (Public)*
20 8 Bullwinkle
* Wiki
21 8 Bullwinkle
* Files
22 8 Bullwinkle
* News
23 1 Bullwinkle
24 8 Bullwinkle
*Dev Sub-Project (Private)*
25 8 Bullwinkle
* Wiki
26 8 Bullwinkle
* Forums
27 8 Bullwinkle
* Issues (bug tracker)
28 8 Bullwinkle
* Repository (SubVersion Version Control)
29 8 Bullwinkle
* Activity
30 8 Bullwinkle
* Files
31 1 Bullwinkle
32 9 Bullwinkle
33 9 Bullwinkle
h1. Forums
34 9 Bullwinkle
35 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?
36 9 Bullwinkle
37 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.
38 9 Bullwinkle
39 9 Bullwinkle
Use the Activity Page and/or Watches to follow the topics in your forums... see "What's New", below.
40 1 Bullwinkle
41 1 Bullwinkle
42 16 Bullwinkle
h1. Whats_New_--_Keeping_Track_of_Your_Team
43 1 Bullwinkle
44 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:
45 1 Bullwinkle
46 8 Bullwinkle
h2. Activity Page
47 5 Bullwinkle
48 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:
49 5 Bullwinkle
50 8 Bullwinkle
!Activity01.png!
51 5 Bullwinkle
52 8 Bullwinkle
h2. Watches
53 5 Bullwinkle
54 8 Bullwinkle
Many of the project pages can be "Watched", which means that you will get an email when that page changes. 
55 5 Bullwinkle
56 8 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 (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:
57 5 Bullwinkle
58 8 Bullwinkle
> !Watch01.png!
59 3 Bullwinkle
60 1 Bullwinkle
61 1 Bullwinkle
h1. Using the Wiki
62 1 Bullwinkle
63 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.
64 1 Bullwinkle
65 1 Bullwinkle
Use the buttons at the top of the page to insert formatting codes, or just memorize them.
66 1 Bullwinkle
67 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.
68 1 Bullwinkle
69 1 Bullwinkle
This is a link in *Edit Mode*:
70 1 Bullwinkle
71 1 Bullwinkle
!Wiki01.png!
72 1 Bullwinkle
73 1 Bullwinkle
74 1 Bullwinkle
75 1 Bullwinkle
76 1 Bullwinkle
2) To *Cancel* your editing session and return to Read mode, *click Wiki* on the Forge toolbar:
77 1 Bullwinkle
78 1 Bullwinkle
79 1 Bullwinkle
!Wiki02.png!
80 1 Bullwinkle
81 1 Bullwinkle
82 1 Bullwinkle
83 1 Bullwinkle
84 3 Bullwinkle
You should now be in *Read mode*. Simply click your new link to create a new page.
85 2 Bullwinkle
86 2 Bullwinkle
87 2 Bullwinkle
!Wiki03.png!
88 8 Bullwinkle
89 8 Bullwinkle
90 8 Bullwinkle
91 8 Bullwinkle
h1. Files Module
92 8 Bullwinkle
93 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).
94 8 Bullwinkle
95 8 Bullwinkle
In order to keep your Files organized, you can use Versions to mimic sub-folders. *In Settings, Create a New Version*:
96 8 Bullwinkle
97 8 Bullwinkle
!Files01.png!
98 8 Bullwinkle
99 8 Bullwinkle
100 8 Bullwinkle
101 8 Bullwinkle
The Version *Name* is what users will see in the Files listing as a header -- similar to a folder.
102 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.
103 8 Bullwinkle
104 8 Bullwinkle
!Files02.png!
105 8 Bullwinkle
106 8 Bullwinkle
107 8 Bullwinkle
108 8 Bullwinkle
Go to the Files Module, and click *New File* to upload a file.
109 8 Bullwinkle
In the *New File dialog*, use the pull-down menu to choose the Version/Folder where you want the file.
110 8 Bullwinkle
111 8 Bullwinkle
!Files03.png!
112 10 Bullwinkle
113 10 Bullwinkle
114 10 Bullwinkle
115 11 Bullwinkle
h1. Version Control
116 10 Bullwinkle
117 11 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:
118 10 Bullwinkle
119 10 Bullwinkle
* Automatic backup of _every_ change made by _every_ developer on the team.
120 10 Bullwinkle
* Two developers cannot edit the same file at the same, thereby avoiding conflicts.
121 10 Bullwinkle
* Encourages good documentation and good communication between team members.
122 10 Bullwinkle
* Ability to mark a "version", which includes all of the source files required to make that version.
123 10 Bullwinkle
* Ability to roll back changes (in case you try something that does not work).
124 10 Bullwinkle
125 10 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).