misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/templates.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
   2
   3 <html>
   4   <head>
   5     <meta name="generator" content="HTML Tidy, see www.w3.org">
   6
   7     <title></title>
   8   </head>
   9
  10   <body>
  11 <H1>Templates</H1>
  12 <P>The Nexuiz demo recorder offers you
  13 templates that you can use to create new jobs (which are based on a
  14 template) more quickly and efficiently. Imagine these &quot;templates&quot;
  15 didn't exist ... you would always have to specify the complete path
  16 to the engine, the video file, the demo file, and the final video
  17 file &ndash; each single time when creating a job, from scratch. This
  18 would take a long time and would be inefficient.</P>
  19 <P>Instead you are encouraged to create
  20 templates. Templates can be created either from scratch (click on the
  21 <B>+ Create</B> button next to the template table) or from an
  22 existing job (select the job, then click on the button <B>Create from
  23 job</B>).</P>
  24 <P>The latter will just add a new entry
  25 in the templates table, without prompting you for any further
  26 information. The template's name and summary will be &quot;Generated
  27 from job&quot;, and you can change this by double-clicking this
  28 generated template, renaming it and giving it a meaningful summary,
  29 then click save. You will notice that all other values have been
  30 taken from the job and don't need to be filled out by you anymore.</P>
  31 <P>Here you can see the template dialog
  32 when creating a new template:</P>
  33 <P><img src="images/create_template.gif" /></P>
  34 <P>The dialog looks very much alike the
  35 &quot;create job&quot; dialog presented to you in the <a href="basic_tutorial.html#jobs_create">Basic
  36 tutorial</a>. There are a few differences, however:</P>
  37 <UL>
  38         <LI><P>The dialog shows you a <B>template
  39         name</B> and <B>description</B></P>
  40         <LI><P>Instead of specifying a <B>demo
  41         file</B> you are now specifying a <B>demo directory</B></P>
  42         <LI><P>Instead of specifying a <B>video
  43         destination file</B>, you now just specify the <B>directory</B></P>
  44         <LI><P>You
  45         don't specify a <B>start time</B> or <B>end time</B> for templates,
  46         because these 2 input parameters are specific for each job and don't
  47         make sense to be saved for a template</P>
  48 </UL>
  49 <P>Once you have a template you can
  50 create new jobs easily by selecting a template in the templates table
  51 and then click on the <B>Create from template</B> button in the jobs
  52 panel.
  53 </P>
  54 <H2>What could templates also be good
  55 for?</H2>
  56 <UL>
  57         <LI><P>Using different configs for
  58         recording (you can set a config to be used either in the &ldquo;engine
  59         parameters&rdquo; field, e.g. <B>+exec myconfig.cfg</B>, or you
  60         could put the <B>exec myconfig.cfg</B> into the &ldquo;exec before&rdquo;
  61         field.</P>
  62         <LI><P>Recording with different Nexuiz
  63         engines to compare the visual quality</P>
  64         <LI><P>Inspire me &hellip; what do you
  65         use templates for? Post it to the forum!</P>
  66 </UL>
  67   </body>
  68 </html>
  69