<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Using the Project Stamp</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="GStreamer Plugin Writer's Guide" HREF="index.html"><LINK REL="UP" TITLE="Constructing the Boilerplate" HREF="chapter-building-boiler.html"><LINK REL="PREVIOUS" TITLE="Constructing the Boilerplate" HREF="chapter-building-boiler.html"><LINK REL="NEXT" TITLE="Examining the Basic Code" HREF="section-boiler-examine.html"></HEAD ><BODY CLASS="sect1" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" ><SPAN CLASS="application" >GStreamer</SPAN > Plugin Writer's Guide</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="chapter-building-boiler.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" >Chapter 3. Constructing the Boilerplate</TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="section-boiler-examine.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="sect1" ><H1 CLASS="sect1" ><A NAME="section-boiler-project-stamp" >3.2. Using the Project Stamp</A ></H1 ><P > The first thing to do when making a new element is to specify some basic details about it: what its name is, who wrote it, what version number it is, etc. We also need to define an object to represent the element and to store the data the element needs. These details are collectively known as the <SPAN CLASS="emphasis" ><I CLASS="emphasis" >boilerplate</I ></SPAN >. </P ><P > The standard way of defining the boilerplate is simply to write some code, and fill in some structures. As mentioned in the previous section, the easiest way to do this is to copy a template and add functionality according to your needs. To help you do so, there are some tools in the <TT CLASS="filename" >./gst-template/tools/</TT > directory. One tool, <TT CLASS="filename" >gst-quick-stamp</TT >, is a quick command line tool. The other, <TT CLASS="filename" >gst-project-stamp</TT >, is a full GNOME druid application that takes you through the steps of creating a new project (either a plugin or an application). </P ><P > To use <B CLASS="command" >pluginstamp.sh</B >, first open up a terminal window. Change to the <TT CLASS="filename" >gst-template</TT > directory, and then run the <B CLASS="command" >pluginstamp.sh</B > command. The arguments to the <B CLASS="command" >pluginstamp.sh</B > are: </P ><P ></P ><OL TYPE="1" ><LI ><P >the name of the plugin, and</P ></LI ><LI ><P > the directory that should hold a new subdirectory for the source tree of the plugin. </P ></LI ></OL ><P > Note that capitalization is important for the name of the plugin. Under some operating systems, capitalization is also important when specifying directory names. For example, the following commands create the ExampleFilter plugin based on the plugin template and put the output files in a new directory called <TT CLASS="filename" >~/src/examplefilter/</TT >: </P ><PRE CLASS="screen" > <SAMP CLASS="prompt" >shell $ </SAMP ><KBD CLASS="userinput" >cd gst-template</KBD > <SAMP CLASS="prompt" >shell $ </SAMP ><KBD CLASS="userinput" >tools/pluginstamp.sh ExampleFilter ~/src</KBD > </PRE ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="chapter-building-boiler.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="section-boiler-examine.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Constructing the Boilerplate</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="chapter-building-boiler.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >Examining the Basic Code</TD ></TR ></TABLE ></DIV ></BODY ></HTML >