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

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