[PXCDD-commit] SF.net SVN: pxcdd: [388] trunk/website/userdoc.html
Status: Alpha
Brought to you by:
tangentsoft
Menu
▾
▴
[PXCDD-commit] SF.net SVN: pxcdd: [388] trunk/website/userdoc.html
|
From: <tan...@us...> - 2006-07-10 07:30:40
|
Revision: 388 Author: tangentsoft Date: 2006-07-10 00:30:35 -0700 (Mon, 10 Jul 2006) ViewCVS: http://svn.sourceforge.net/pxcdd/?rev=388&view=rev Log Message: ----------- Added named anchors for programs to userdocs, so we can link to program-specific parts of the docs Modified Paths: -------------- trunk/website/userdoc.html Modified: trunk/website/userdoc.html =================================================================== --- trunk/website/userdoc.html 2006-07-10 07:28:12 UTC (rev 387) +++ trunk/website/userdoc.html 2006-07-10 07:30:35 UTC (rev 388) @@ -49,7 +49,7 @@ <li type="disc">C4D plugins require <a href="http://maxon.net/">CINEMA 4D</a> R8.5 or greater.<li type="disc">Several of the programs are <a href="http://www.python.org">Python</a> scripts, and require <a href="http://www.python.org/download/releases/2.3/">version 2.3</a> or higher. Required Python modules are included with the programs. </ul> <h1>CINEMA 4D Plugins</h1> - <h2>PXCDD Upload</h2> + <h2><a id="c4d_upload_plugin" name="c4d_upload_plugin"></a>PXCDD Upload</h2> <p>This C4D plugin collects the scene file, any textures and project info for slate, and uploads everything to your team's directory on the PXC server (using pxcddup).</p> <p>To upload your project, just choose PXCDD Upload Model from the Plugins > PXCDD menu. In the dialog, complete the Upload Info and Slate Info fields with information about your project. The fields are designed to match PXC specifications for filenames and slates. Please refer to the official spec pages within the Atheneum for further information on each of these fields. Slate information is optional - if it's supplied, the file will be automatically rendered and a slate and timecode will be generated by the server.</p> <p>Additional fields:</p> @@ -60,14 +60,14 @@ </ul> <p>After completing the fields, click OK. The PXCDD Upload window will appear, and you may be prompted for your PXC password. Once you enter your password correctly, you'll see a progress bar as each file uploads. Note that the C4D plugin will only upload files have changed. (It compares the modification date and time between your local copy and any files with the same name on the server.)</p> <p><strong>NOTE</strong>: You should always increment your project file and texture file numbers when modifying them.</p> - <h2>PXCDD New Texture Version</h2> + <h2><a id="c4d_texversion_plugin" name="c4d_texversion_plugin"></a>PXCDD New Texture Version</h2> <p>This C4D plugin increments the filename of a selected texture file and relinks the new texture within all materials, optionally opens an editing application to modify texture.</p> <p>To create a new texture version, choose PXCDD New Texture Version from the Plugins > PXCDD menu. In the dialog, choose the texture you'd like to modify. If you've selected a material before running the plugin, the first texture found within the material will be selected by default.</p> <p>If you'd like to edit the new texture immediately, check the Edit New Texture option, and specify your image editing application (i.e. Photoshop). When you click OK, the filename will be incremented and all instances of the texture will be replaced within your materials. If you chose to edit the texture immediately, the new texture will be opened in your image editing application.</p> <p>Note that the PXC specification allows two methods for versioning files: by date (YYMMDD) or version number (v001). If the source file matches PXC naming specifications and includes a date, the version will be replaced with the current date. If the plugin sees a 'v' followed by a number, that number will be incremented.</p> <h1>Client-Side Command Line Programs</h1> <p>The command line programs are used internally by the C4D plugins. They are documented here mainly for completeness. Most of the time, you can ignore the fact that they exist.</p> - <h2>pxcddup</h2> + <h2><a id="pxcddup" name="pxcddup"></a>pxcddup</h2> <p>This tool uploads files to a specified SFTP server. It has special knowledge of the PXC file server system, but it can be used with any SFTP server if you avoid use of the PXC-specific options. A special feature is that it will accept command line options in a .ddo file, which is necessary to allow it to work with the C4D plugins, due to a limitation of COFFEE.</p> <h3>General usage</h3> <blockquote> @@ -188,7 +188,7 @@ <p>pxcddup looks for host and user keys in the <tt>.ssh</tt> or <tt>ssh</tt> subdirectory under your home directory. The former is generally the one to use on OS X, and the program uses the latter automatically on Windows, where "dot files" aren't commonplace as on *ix systems like OS X.</p> <p>pxcddup does have a GUI; it's pxcddup displaying the progress dialog and such when you tell the upload plugin to send the files to the file server. We call it a command line program because you have to start it using command line options to get any useful functionality. We have plans to make the program usable as you would any other GUI program, to allow you to upload files other than C4D scenes and textures, but that's well into the future.</p> <h1>Server-Side Programs</h1> - <h2>pxcddrss</h2> + <h2><a id="pxcddrss" name="pxcddrss"></a>pxcddrss</h2> <p>This program walks through the specified hierarchy and indexes all files. Optionally, you can specify filenames to include or exclude by mask. This script is intended to run as a periodic background process on the server. It generates an RSS file, which allows team members to use a feed reader to download updated dailies files as they become available.</p> <h3>General usage</h3> <blockquote> @@ -266,7 +266,7 @@ -I *.mov -I *.tif<br> -X *.rss -X ???_???_???_scf* -X ???_???_???_scg*</code></p> </blockquote> - <h2>c4drender</h2> + <h2><a id="c4drender" name="c4drender"></a>c4drender</h2> <p>This program walks through the specified hierarchy to render C4D files. This is a simple network rendering solution with limited scalability, recovery and load balancing. It is intended to be run as a periodic background process on a file server and on any render nodes. It uses <tt>scp</tt> to transfer files between the file server and render nodes. It runs in one of three modes:</p> <ul> <li type="disc">Render: renders any C4D files within the specified hierarchy that don't already appear to have been rendered @@ -316,7 +316,7 @@ </tr> </table> <p>You must specify -c and either -d and -p (for Pixel Corps usage) or files. If you specify both, files will be searched relative to PXC path.</p> - <h2>slategen</h2> + <h2><a id="slategen" name="slategen"></a>slategen</h2> <p>This program creates a "slate" image using information it parses out of an XML file in the format written by <tt>pxcddup</tt> containing information entered by the user in the PXCDD Upload Plugin. It writes the image out in TIFF format by default, but it can optionally use PNG format if you ask it to. The program should build and run on any *ix type system, though it is tested on and intended primarily for OS X systems.</p> <h3>General usage</h3> <blockquote> @@ -336,7 +336,7 @@ </tr> </table> <p>If the given filename contains ".xml", that part will be overwritten with .tif or .png, as apropriate, when creating the slate image's file name. Otherwise, .png or .tif is appended to the end of the XML file name to get the slate image file name.</p> - <h2>pxcqtassy</h2> + <h2><a id="pxcqtassy" name="pxcqtassy"></a>pxcqtassy</h2> <p>This program assembles a number of TIFF images into a QuickTime movie in H.264 format. Its purpose is to take a slate created by <tt>slategen</tt> and rendered plates written out by <tt>c4drender</tt> and assemble that into a single movie file. (That file then gets sent back to the file server, where it is noticed by <tt>pxcddrss</tt> and sent out to people subscribed to the dailies feed.) Because this program uses the Cocoa QTKit framework for creating QuickTime movies, it only runs on OS X.</p> <h3>General usage</h3> <blockquote> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |