ExampleFilter: Difference between revisions
From Avisynth wiki
Jump to navigationJump to search
Raffriff42 (talk | contribs) remove HTML comments from template params |
Raffriff42 (talk | contribs) Undo revision 4897 by Raffriff42 (talk) |
||
| Line 16: | Line 16: | ||
# If your title ''is'' unique, you will be greeted with the "There is currently no text in this page" banner. Click on the "edit this page" link. | # If your title ''is'' unique, you will be greeted with the "There is currently no text in this page" banner. Click on the "edit this page" link. | ||
# Paste the source code you copied in Step 2. | # Paste the source code you copied in Step 2. | ||
# Fill in as much information as you can. Leave the rest. | # Areas that need your attention are marked with HTML comments <nowiki><</nowiki><nowiki>!--</nowiki> like this <nowiki>--</nowiki><nowiki>></nowiki>. Fill in as much information as you can. Leave the rest. | ||
# Click the Show Preview button to see how your page will look. | # Click the Show Preview button to see how your page will look. | ||
# Click the Save page button to create the new page. | # Click the Save page button to create the new page. | ||
| Line 31: | Line 31: | ||
<!-- ================= END INSTRUCTIONS ================= --> | <!-- ================= END INSTRUCTIONS ================= --> | ||
{{FilterCat4|External_filters|Plugins|TODO|TODO}} | {{FilterCat4|External_filters|Plugins|<!-- category -->TODO|<!-- category -->TODO}} | ||
{{Filter3 | {{Filter3 | ||
|My Name | |<!-- author -->My Name | ||
|1.0.0.0.0 | |<!-- version -->1.0.0.0.0 | ||
|[http://google.com ExampleFilter.com] | |<!-- download URL -->[http://google.com ExampleFilter.com] | ||
|External filters | |<!-- category -->External filters | ||
|[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2] | |<!-- license -->[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2] | ||
|[http://doom9.org Announcing ExampleFilter]}} | |<!-- discussion URL -->[http://doom9.org Announcing ExampleFilter]}} | ||
<br> | <br> | ||
== Description == | == Description == | ||
| Line 57: | Line 57: | ||
== [[Script variables|Syntax and Parameters]] == | == [[Script variables|Syntax and Parameters]] == | ||
:{{Template:FuncDef|ExampleFilter (''clip'', '' | :{{Template:FuncDef|<!-- function name -->ExampleFilter (''clip'', ''<!-- par 1 type -->bool'' "<!-- par 1 name -->blah", ''<!-- par 2 type -->'' "<!-- par 2 name -->", ''<!-- par 3 type -->'' "<!-- par 3 name -->", ''<!-- par 4 type -->'' "<!-- par 4 name -->", ''<!-- par 5 type -->'' "<!-- par 5 name -->", ''<!-- par 6 type -->'' "<!-- par 6 name -->", ''<!-- par 7 type -->'' "<!-- par 7 name -->", ''<!-- par 8 type -->'' "<!-- par 8 name -->", ''<!-- par 9 type -->'' "<!-- par 9 name -->")}} | ||
<br> | <br> | ||
::{{Par2| |clip| }} | ::{{Par2| |clip| }} | ||
:::Input clip. | :::Input clip. | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 1 type -->bool|<!-- par 1 name -->blah|<!-- par 1 default value -->false}} | ||
:::Example description for parameter ''blah''. | :::<!-- par 1 description -->Example description for parameter ''blah''. | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 2 type -->|<!-- par 2 name -->|<!-- par 2 default value -->}} | ||
:::par 2 description | :::<!-- par 2 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 3 type -->|<!-- par 3 name -->|<!-- par 3 default value -->}} | ||
:::par 3 description | :::<!-- par 3 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 4 type -->|<!-- par 4 name -->|<!-- par 4 default value -->}} | ||
:::par 4 description | :::<!-- par 4 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 5 type -->|<!-- par 5 name -->|<!-- par 5 default value -->}} | ||
:::par 5 description | :::<!-- par 5 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 6 type -->|<!-- par 6 name -->|<!-- par 6 default value -->}} | ||
:::par 6 description | :::<!-- par 6 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 7 type -->|<!-- par 7 name -->|<!-- par 7 default value -->}} | ||
:::par 7 description | :::<!-- par 7 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 8 type -->|<!-- par 8 name -->|<!-- par 8 default value -->}} | ||
:::par 8 description | :::<!-- par 8 description --> | ||
<br> | <br> | ||
::{{Par2| | ::{{Par2|<!-- par 9 type -->|<!-- par 9 name -->|<!-- par 9 default value -->}} | ||
:::par 9 description | :::<!-- par 9 description --> | ||
<br> | <br> | ||
Revision as of 14:48, 6 November 2014
Welcome filter authors! To help you document your filter in this Wiki, here is a template to get you started.
Instructions:
- Right-Click the Edit tab at the top of this page and open in a new browser tab. Keep the instructions open in this tab for reference.
- In the new tab, you will see a page full of Wiki code (the source code for this very page); copy everything below "END INSTRUCTIONS" to the clipboard.
- In the new tab, edit the page URL:
- Replace ?title=ExampleFilter with /YourFilterName
- Your filter name should be one word - no spaces - but this is not mandatory.
- First letter must be UPPERCASE due to Wikicode requirements.
- Don't forget to remove the "?" and replace it with "/"
- Hit Enter. If the title is already in use, you will be taken to that page.
- If the page already exists, hit your browser's Back button.
- Try a different title: Rename your filter, or add a suffix like "/CoolFilter (updated)"
- If your title is unique, you will be greeted with the "There is currently no text in this page" banner. Click on the "edit this page" link.
- Paste the source code you copied in Step 2.
- Areas that need your attention are marked with HTML comments <!-- like this -->. Fill in as much information as you can. Leave the rest.
- Click the Show Preview button to see how your page will look.
- Click the Save page button to create the new page.
- If you did something wrong, Click the Edit tab and fix it.
Please don't worry about formatting or incomplete information; just do the best you can.
A more experienced user will come along and clean up the page for you, and add a link to your page @External filters (don't do this yourself).
NOTE: Willful vandalism will result in the termination of your account.
| Abstract | |
|---|---|
| Author | My Name |
| Version | 1.0.0.0.0 |
| Download | ExampleFilter.com |
| Category | External filters |
| License | GPLv2 |
| Discussion | Announcing ExampleFilter |
Description
ExampleFilter is an example filter. This page serves as boilerplate text for new filter pages.
Requirements
- AviSynth 2.5.8 or 2.6.0 Alpha 5 or greater
- Supported color formats: RGB24, RGB32, YUY2, YV12, *YV16, *YV24, *YV411, *Y8
- * Not available in AviSynth 2.5.8.
- ExampleFilter (clip, bool "blah", ' "", ' "", ' "", ' "", ' "", ' "", ' "", ' "")
- clip =
- Input clip.
- clip =
- blah bool = false
- Example description for parameter blah.
- blah bool = false
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
Examples
## This is some example code.
Avisource("example.avi")
ExampleFilter(blah=true)
## This is another example.
Avisource("example.avi")
ExampleFilter(blah=false)
Back to External Filters ←