|
|
|
Getting Started, Step-by-Step
Note: the instructions below are for Webgenz 5.1.1. If you are using a more recent version of Webgenz, please refer
to the instructions located here.
If you're using Webgenz for the very first time, you're likely to have a few questions about how to get started.
Here's a detailed list of steps to help simplify the process.
- First, you'll need to configure Webgenz so that it knows about your favorite text editor and web browser.
Webgenz allows you to designate a text editor which is used whenever you edit a
template file or macro file
through Webgenz. You can also designate a web browser that is used to preview the web pages you create
in Webgenz. To configure your text editor and web browser in Webgenz select "Tools -> Options..." from
the main Webgenz menu bar. After doing so, you'll see a screen that looks similar to the one below.
The two most important options to configure at this time are the "Editor" and "Browser" options. Click the "Browse..."
buttons next to these options and select your favorite editor and web browser. After doing this, press "OK". (Note: if
you're ambitious, you can also configure your favorite image editor as well as a custom application. Once you configure
these programs, you will notice that there are icons on the Webgenz tool bar that allows you to launch these programs).
- With this basic task out of the way, we can now turn our attention to setting up a Webgenz Project. However, before
we do this, we'll need to create a few files that will serve as the foundation for our project. Do the following:
- Create a new Windows Folder (i.e. subdirectory) where you will store all of the files
related to this project.
- As a general practice, it is recommended that you create another Windows Folder within
the Windows Folder you just created called "templates".
- Create a very basic Project Definition File. The heart and soul of a Webgenz Project is the
Project Definition File. The
Project Definition File is a text file that contains a list of all the files that comprise
your Webgenz Project. To create a very basic version of the Project Definition File, you can
simply copy-and-paste the lines below into a new file. (Note: you'll be enhancing this file
significantly as you build your web site. This is just a basic "placeholder" to help you
get started).
Globals=globals.par!
[Index]
index.html,templates\index.tpl,index.par!
!
Save this file. As a general convention, the Project Definition File is usually given a .txt extension.
For more details on the structure of a Project Definition File, you are strongly
encouraged to refer to the userguide.
- Next, we'll create a basic template file. Again, at this point we are just creating a
placeholder that you will enhance once you have finished setting up the Project. Copy-and-paste the following
lines into a new file. Save this file as "index.tpl" in the "templates" folder that you
created earlier. (Note: the name of this file is important. Notice that it is referenced by
the Project Definition File. If it is not named correctly, it will not be found when Webgenz
reads the Project Definition File).
<HTML>
<HEAD>
<TITLE>[@TITLE]</TITLE>
</HEAD>
<BODY>
<H3>[@TITLE]</H3>
<HR>
[@CONTENT]
<HR>
[@COPYRIGHT]
</BODY>
</HTML>
- Finally, we need to create two content files. We
will create a global content file and a content file specifically for the index page of our site.
The content files contain the definitions of the macros that are
referenced in the template file.
First, let's create the global content file. Copy-and-paste the following
lines into a new file. Save this file as "globals.par" in the Windows Folder that you
created in Step 2.1. (Again, notice that globals.par is referenced in the Project Definition File).
[@COPYRIGHT]:
Copyright(c) 2001. My Company, Inc.
[@]
Now, let's create a content file specifically for the index page of our site. Copy-and-paste the following
lines into a new file. Save this file as "index.par" in the Windows Folder that you
created earlier. As I mentioned above, the files we're creating now are simply placeholders; you
will be elaborating on these files as you build your site.
[@TITLE]:
Welcome to My Site!
[@]
[@CONTENT]:
Welcome to my home page. I hope you enjoy your visit to my site.
[@]
- Now we're ready to move on. The next
step is to define a new Project in Webgenz. To define a new Project, simply select the "File -> New Project..." menu
choice from the main Webgenz menu bar. After doing so, you will see a screen that looks like the one below.
Select a name for your Project and enter it in the "Name" field. Next, you need to make the
association between the new Webgenz Project and the Project Definition File that you created
in the previous step. Press the "Browse..." button next to the field labeled "Definition File".
Select the Project Definition File that you created in Step 2.3.
Before leaving this screen, you need to set the "Root Path" of the document
files (i.e. the output files that Webgenz creates) and the content files used in your Project. For now, set
both of these paths to the name of the Windows Folder that you created in Step 2.1. After entering in this
information, your screen should look similar to the one below.
Press the "Create" button. If everything went well, you will return to the main Webgenz
screen and see a screen similar to the following.
- OK. We've now setup a basic Webgenz Project. If you double-click on a content file or a template file, these
files will open in your text editor. To preview the generated HTML file in a web browser, we simply "generate" the file
by pressing the first button on the Webgenz toolbar (the button that looks like a VCR "play" button). After doing
this, just double-click on the HTML document in the center listbox and you will be able to preview the document
in the web browser that you configured in Step 1.
- What's next? Now that you have a basic project setup in Webgenz, you continue to iterate on the development of
the project. Typically, this means that you will enhance your template with design and layout elements, add more
content, and continue to add documents to the Project Definition File. Remember, you can define and create your own
macros, you can nest macros, and more. Have fun!
To learn more about Webgenz
read the user guide or download a
fully-functional version of Webgenz for evaluation now! Webgenz is
shareware.
|
