Skip to content

Commit

Permalink
Refreshes Retype-generated documentation.
Browse files Browse the repository at this point in the history
Process triggered by latenitefilms.
  • Loading branch information
Retype GitHub Action committed Jan 23, 2024
1 parent d48ee1e commit e9a49aa
Show file tree
Hide file tree
Showing 18 changed files with 88 additions and 67 deletions.
8 changes: 4 additions & 4 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -27,11 +27,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="/resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="/resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="/resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
8 changes: 4 additions & 4 deletions buy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand Down Expand Up @@ -32,11 +32,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
8 changes: 4 additions & 4 deletions credits/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -30,11 +30,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
8 changes: 4 additions & 4 deletions faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -30,11 +30,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
8 changes: 4 additions & 4 deletions how-to-use/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand Down Expand Up @@ -32,11 +32,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand Down Expand Up @@ -32,11 +32,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
8 changes: 4 additions & 4 deletions latenite/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -30,11 +30,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
55 changes: 38 additions & 17 deletions lua-scripting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand Down Expand Up @@ -32,12 +32,12 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.759305700608" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.759323609787" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down Expand Up @@ -303,23 +303,44 @@ <h1>
<figcaption class="caption"></figcaption>
</figure>
</p>
<p>Metaburner isn&#x27;t sandboxed, so you can also read files from your system:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-lua"><code v-pre class="language-lua">local function readFile(path)
local file = io.open(path, &quot;r&quot;) -- Open the file for reading
if not file then
return nil, &quot;File not found or cannot be opened&quot;
end

local content = file:read(&quot;*a&quot;) -- Read the entire contents of the file
file:close() -- Close the file
return content
end

local path = &quot;/Users/chrishocking/Desktop/Test.txt&quot;
local content, err = readFile(path)

if content then
result = content
else
result =&quot;Error reading file: &quot; .. err
end</code></pre>
</doc-codeblock></div>
<p>Each instance of Metaburner has it&#x27;s own <code v-pre>uniqueIdentifier</code>. You can find this by using this Lua code:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-lua"><code v-pre class="language-lua">result = uniqueIdentifier</code></pre>
</doc-codeblock></div>
<p>You can also see the Unique Identifier in the <strong>Controls</strong> section in the Inspector.</p>
<p>You can use this <code v-pre>uniqueIdentifier</code> to access the FCPXML and Processed Data.</p>
<p>You have access to the full FCPXML via the <code v-pre>fcpxmlData_uniqueIdentifier</code> global variable, which is stored as a <code v-pre>string</code>:</p>
<p><figure class="content-center">
<img src="../static/lua-fcpxml.png" alt="">
<figcaption class="caption"></figcaption>
</figure>
</p>
<p>You have access to Metaburner&#x27;s processed data via the <code v-pre>processedData_uniqueIdentifier</code> global variable, which is stored as a <code v-pre>table</code>:</p>
<p><figure class="content-center">
<img src="../static/lua-processed-data.png" alt="">
<figcaption class="caption"></figcaption>
</figure>
</p>
<p>You have access to the full FCPXML via the <code v-pre>fcpxmlData_uniqueIdentifier</code> global variable, which is stored as a <code v-pre>string</code>.</p>
<p>For example:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-lua"><code v-pre class="language-lua">result= _G[&quot;fcpxmlData_&quot; ..uniqueIdentifier]</code></pre>
</doc-codeblock></div>
<p>You have access to Metaburner&#x27;s processed data via the <code v-pre>processedData_uniqueIdentifier</code> global variable, which is stored as a <code v-pre>table</code>.</p>
<p>For example:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-lua"><code v-pre class="language-lua">result= _G[&quot;processedData_&quot; ..uniqueIdentifier]</code></pre>
</doc-codeblock></div>
<p>You can manipulate this data any way you want.</p>
<p>The Lua environment is shared between all instances of the Metaburner plugin, so you can even pass information between different Metaburner Titles!</p>
<p>You can learn more about Lua Scripting on the <a href="https://commandpost.io/developer/lua-overview/">CommandPost website</a>.</p>
Expand Down
8 changes: 4 additions & 4 deletions privacy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759305700608">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.759323609787">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -30,11 +30,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.759305700608" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.759323609787" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759305700608" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.759323609787" data-turbo-eval="false" defer></script>
</head>
<body>
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
Expand Down
Loading

0 comments on commit e9a49aa

Please sign in to comment.