2 lines
7 KiB
HTML
2 lines
7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Make your own Cowfile · cowsay.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://millironx.com/Cowsay.jl/cowfiles/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">cowsay.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../cows/">Available Cowfiles</a></li><li class="is-active"><a class="tocitem" href>Make your own Cowfile</a><ul class="internal"><li><a class="tocitem" href="#Helpful-hints-for-making-cow-functions"><span>Helpful hints for making cow functions</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Make your own Cowfile</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Make your own Cowfile</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MillironX/cowsay.jl/blob/master/docs/src/cowfiles.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Making-a-cow-function"><a class="docs-heading-anchor" href="#Making-a-cow-function">Making a cow function</a><a id="Making-a-cow-function-1"></a><a class="docs-heading-anchor-permalink" href="#Making-a-cow-function" title="Permalink"></a></h1><p>The original cowsay used Perl scripts (called 'cowfiles') to allow for creating more ASCII cow art. Cowsay.jl uses Julia functions, instead. In order to be usable by <code>Cowsay.cowsay</code>, a cow function <strong>must</strong></p><ol><li><p>Take the correct arguments</p><p>The function must take three (3) <a href="https://docs.julialang.org/en/v1/manual/functions/#Keyword-Arguments">keyword arguments</a> of the form</p><ul><li><code>eyes::AbstractString="oo"</code></li><li><code>tongue::AbstractString=" "</code></li><li><code>thoughts::AbstractString="\\"</code></li></ul><p>When drawing the cow artwork, you may then use the variables <code>eyes</code> in place of the eyes, <code>tongue</code> in place of the tongue, and <code>thoughts</code> in place of the speech ballon trail. Use of these variables in constructing the cow is optional (but makes the use of your cow function far more fun), but all three arguments must be present in the signature, regardless.</p></li><li><p>Return a string</p><p>The cow artwork must be returned from the function as a string. This is distinctly different from how the original cowsay modified the <code>$the_cow</code> variable.</p></li></ol><h2 id="Helpful-hints-for-making-cow-functions"><a class="docs-heading-anchor" href="#Helpful-hints-for-making-cow-functions">Helpful hints for making cow functions</a><a id="Helpful-hints-for-making-cow-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Helpful-hints-for-making-cow-functions" title="Permalink"></a></h2><ol><li>Include one function per file, with the extension <code>.cow.jl</code></li><li>Do not indent within a <code>.cow.jl</code> file to better see the artwork</li><li>Make use of string literals (<code>"""</code>) and string interpolation (<code>$</code>) to build the cow art</li><li>Be sure to escape backslashes (<code>\</code>) and dollar signs (<code>$</code>) within your artwork</li><li>When converting from Perl cowfiles, <em>unescape</em> at symbols (<code>@</code>), as these are <strong>not</strong> special in Julia strings</li><li>Split the <code>eyes</code> variable to get individual left- and right-eye when creating large cow functions</li><li>Have fun!</li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../cows/">« Available Cowfiles</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.10 on <span class="colophon-date" title="Wednesday 11 May 2022 01:06">Wednesday 11 May 2022</span>. Using Julia version 1.7.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|