24 lines
8.2 KiB
HTML
24 lines
8.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · cowsay.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://millironx.com/Cowsay.jl/"/><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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Usage"><span>Usage</span></a></li></ul></li><li><a class="tocitem" href="cows/">Available Cowfiles</a></li><li><a class="tocitem" href="cowfiles/">Make your own Cowfile</a></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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MillironX/cowsay.jl/blob/master/docs/src/index.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="Cowsay.jl"><a class="docs-heading-anchor" href="#Cowsay.jl">Cowsay.jl</a><a id="Cowsay.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Cowsay.jl" title="Permalink"></a></h1><p>A Julia package that lets you use <a href="https://en.wikipedia.org/wiki/Cowsay">cowsay</a> in your Julia programs!</p><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="Cowsay.cowsay" href="#Cowsay.cowsay"><code>Cowsay.cowsay</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">cowsay([io,] message::AbstractString; kwargs...)
|
|
cowthink([io,] message::AbstractString; kwargs...)</code></pre><p>Print an ASCII picture of a cow saying/thinking <code>message</code></p><p><strong>Arguments</strong></p><ul><li><code>message::AbstractString</code>: Tell the cow what to say</li></ul><p><strong>Keywords</strong></p><ul><li><code>cow=default</code>: Specify a particular function handle to print the ASCII art. See below for more details on what constitutes a valid function handle.</li><li><code>eyes::AbstractString="oo"</code>: A two-character string to be drawn in for the eyes. Not all cowfiles support this, though.</li><li><code>tongue::AbstractString=" "</code>: A two-character string to be drawn in for the tongue. Not all cowfiles support this.</li><li><code>wrap::Int=40</code>: The number of characters at which to wrap <code>message</code> to a new line</li><li><code>nowrap::Bool=false</code>: Don't perform text wrapping on <code>message</code></li></ul><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia> cowsay("Have you mooed today?")
|
|
_______________________
|
|
< Have you mooed today? >
|
|
-----------------------
|
|
\ ^__^
|
|
\ (oo)\_______
|
|
(__)\ )\/\
|
|
||----w |
|
|
|| ||
|
|
|
|
julia> cowthink("Have I mooed today?")
|
|
_____________________
|
|
( Have I mooed today? )
|
|
---------------------
|
|
o ^__^
|
|
o (oo)\_______
|
|
(__)\ )\/\
|
|
||----w |
|
|
|| ||</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MillironX/cowsay.jl/blob/c31104da842b48c58ff08cb9c21fd83c3f970f3a/src/Cowsay.jl#L43-L84">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Cowsay.cowsaid" href="#Cowsay.cowsaid"><code>Cowsay.cowsaid</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">cowsaid(message::AbstractString; kwargs...)
|
|
cowthunk(message::AbstractString; kwargs...)</code></pre><p>Constructs cow art and returns it as a string instead of printing it. See <a href="#Cowsay.cowsay"><code>cowsay</code></a> for implementation details.</p><p><strong>Example</strong></p><pre><code class="language-julia-repl hljs">julia> cowsaid("Have you mooed today?")
|
|
" _______________________\n< Have you mooed today? >\n -----------------------\n \\ ^__^\n \\ (oo)\\_______\n (__)\\ )\\/\\\n ||----w |\n || ||\n"</code></pre><pre><code class="language-julia-repl hljs">julia> cowthunk("Have I mooed today?")
|
|
" _____________________\n( Have I mooed today? )\n ---------------------\n o ^__^\n o (oo)\\_______\n (__)\\ )\\/\\\n ||----w |\n || ||\n"</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MillironX/cowsay.jl/blob/c31104da842b48c58ff08cb9c21fd83c3f970f3a/src/Cowsay.jl#L108-L126">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-nextpage" 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 2 February 2022 00:57">Wednesday 2 February 2022</span>. Using Julia version 1.7.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|