-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jan 16, 2024
1 parent
1c7a7c9
commit f4ddffd
Showing
6 changed files
with
12 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-15T04:56:35","documenter_version":"1.2.1"}} | ||
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-16T02:05:30","documenter_version":"1.2.1"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Developer Docs · CJKFrequencies.jl Documentation</title><meta name="title" content="Developer Docs · CJKFrequencies.jl Documentation"/><meta property="og:title" content="Developer Docs · CJKFrequencies.jl Documentation"/><meta property="twitter:title" content="Developer Docs · CJKFrequencies.jl Documentation"/><meta name="description" content="Documentation for CJKFrequencies.jl Documentation."/><meta property="og:description" content="Documentation for CJKFrequencies.jl Documentation."/><meta property="twitter:description" content="Documentation for CJKFrequencies.jl Documentation."/><script data-outdated-warner src="../assets/warner.js"></script><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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="../">CJKFrequencies.jl Documentation</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">API Reference</span><ul><li><a class="tocitem" href="../api/freqlist/">Frequency Lists</a></li><li><a class="tocitem" href="../api/lexicon/">Lexicons</a></li></ul></li><li class="is-active"><a class="tocitem" href>Developer Docs</a><ul class="internal"><li><a class="tocitem" href="#Adding-a-new-character/word-frequency-dataset"><span>Adding a new character/word frequency dataset</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Developer Docs</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Developer Docs</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaCJK/CJKFrequencies.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaCJK/CJKFrequencies.jl/blob/main/docs/src/devdocs.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Developer-Docs"><a class="docs-heading-anchor" href="#Developer-Docs">Developer Docs</a><a id="Developer-Docs-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-Docs" title="Permalink"></a></h1><h2 id="Adding-a-new-character/word-frequency-dataset"><a class="docs-heading-anchor" href="#Adding-a-new-character/word-frequency-dataset">Adding a new character/word frequency dataset</a><a id="Adding-a-new-character/word-frequency-dataset-1"></a><a class="docs-heading-anchor-permalink" href="#Adding-a-new-character/word-frequency-dataset" title="Permalink"></a></h2><p>To add a new character frequency dataset using this API, a method just needs to be added to the <code>charfreq</code> function. It should have the signature</p><pre><code class="language-julia hljs">function charfreq(cf::CustomDataSetStruct)::CJKFrequency end</code></pre><p>where the <code>CustomDataSetStruct</code> is any struct that you define for that particular character frequency data set. If needed, the constructor for the struct should take any arguments (e.g. see <a href="../api/freqlist/#CJKFrequencies.SimplifiedLCMC"><code>SimplifiedLCMC</code></a> for an example with arguments).</p><p>The return value should have type <a href="../api/freqlist/#CJKFrequencies.CJKFrequency"><code>CJKFrequency</code></a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/lexicon/">« Lexicons</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 15 January 2024 04:56">Monday 15 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Developer Docs · CJKFrequencies.jl Documentation</title><meta name="title" content="Developer Docs · CJKFrequencies.jl Documentation"/><meta property="og:title" content="Developer Docs · CJKFrequencies.jl Documentation"/><meta property="twitter:title" content="Developer Docs · CJKFrequencies.jl Documentation"/><meta name="description" content="Documentation for CJKFrequencies.jl Documentation."/><meta property="og:description" content="Documentation for CJKFrequencies.jl Documentation."/><meta property="twitter:description" content="Documentation for CJKFrequencies.jl Documentation."/><script data-outdated-warner src="../assets/warner.js"></script><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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="../">CJKFrequencies.jl Documentation</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">API Reference</span><ul><li><a class="tocitem" href="../api/freqlist/">Frequency Lists</a></li><li><a class="tocitem" href="../api/lexicon/">Lexicons</a></li></ul></li><li class="is-active"><a class="tocitem" href>Developer Docs</a><ul class="internal"><li><a class="tocitem" href="#Adding-a-new-character/word-frequency-dataset"><span>Adding a new character/word frequency dataset</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Developer Docs</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Developer Docs</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaCJK/CJKFrequencies.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaCJK/CJKFrequencies.jl/blob/main/docs/src/devdocs.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Developer-Docs"><a class="docs-heading-anchor" href="#Developer-Docs">Developer Docs</a><a id="Developer-Docs-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-Docs" title="Permalink"></a></h1><h2 id="Adding-a-new-character/word-frequency-dataset"><a class="docs-heading-anchor" href="#Adding-a-new-character/word-frequency-dataset">Adding a new character/word frequency dataset</a><a id="Adding-a-new-character/word-frequency-dataset-1"></a><a class="docs-heading-anchor-permalink" href="#Adding-a-new-character/word-frequency-dataset" title="Permalink"></a></h2><p>To add a new character frequency dataset using this API, a method just needs to be added to the <code>charfreq</code> function. It should have the signature</p><pre><code class="language-julia hljs">function charfreq(cf::CustomDataSetStruct)::CJKFrequency end</code></pre><p>where the <code>CustomDataSetStruct</code> is any struct that you define for that particular character frequency data set. If needed, the constructor for the struct should take any arguments (e.g. see <a href="../api/freqlist/#CJKFrequencies.SimplifiedLCMC"><code>SimplifiedLCMC</code></a> for an example with arguments).</p><p>The return value should have type <a href="../api/freqlist/#CJKFrequencies.CJKFrequency"><code>CJKFrequency</code></a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/lexicon/">« Lexicons</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 16 January 2024 02:05">Tuesday 16 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.