deploy: 74b2b30ebd
This commit is contained in:
SamTherapy
commit
543be7dce2
|
|
@ -0,0 +1,555 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class BaseDirectory </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class BaseDirectory ">
|
||||
|
||||
<meta name="description" content="The XDG Base Directory specification is a standard created by freedesktop.org that standardizes the location of storing application files.">
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/new/master/apiSpec/new?filename=Xdg_Directories_BaseDirectory.md&value=---%0Auid%3A%20Xdg.Directories.BaseDirectory%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Xdg.Directories.BaseDirectory">
|
||||
|
||||
|
||||
|
||||
<h1 id="Xdg_Directories_BaseDirectory" data-uid="Xdg.Directories.BaseDirectory" class="text-break">
|
||||
Class BaseDirectory <a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L4"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Xdg.html">Xdg</a>.<a class="xref" href="Xdg.Directories.html">Directories</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>Xdg.Directories.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>The XDG Base Directory specification is a standard created by freedesktop.org that standardizes the location of storing application files.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class BaseDirectory</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">BaseDirectory</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="Xdg_Directories_BaseDirectory_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>
|
||||
<br>
|
||||
This allows users to have less clutter in their home directories, and allows programmers to not have to hard-code directories.
|
||||
</p>
|
||||
<br>
|
||||
For all base directories, the directories are resolved as follows:
|
||||
<ol><li><span class="term">
|
||||
The respective <code>XDG_*</code> enivronment variable
|
||||
</span>will always be used if specified</li><li>
|
||||
<table><tbody><tr></tr><tr><td class="term">Windows</td><td class="description">
|
||||
Use <a href="https://learn.microsoft.com/en-us/windows/win32/shell/known-folders">Known Folders</a>.
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
Follow the <a href="https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW1">Apple documentation</a> on application-specific files.
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
Follow the <a href="https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG Base Directory</a> specification.
|
||||
</td></tr></tbody></table>
|
||||
</li></ol>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_BinHome_" data-uid="Xdg.Directories.BaseDirectory.BinHome*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_BinHome" data-uid="Xdg.Directories.BaseDirectory.BinHome">
|
||||
BinHome
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L55"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Base directory for executable files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string BinHome { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A single base directory relative to which user-specifc <strong>executable</strong> files should be written.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_BinHome_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_BIN_HOME</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>""</code>
|
||||
<br>
|
||||
Windows does not support this by default.
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>""</code>
|
||||
<br>
|
||||
macOS does not support this by default.
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/.local/bin</code>
|
||||
</td></tr></tbody></table>
|
||||
NOTE: This is not an XDG standard but a <em>de facto</em> standard.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_CacheHome_" data-uid="Xdg.Directories.BaseDirectory.CacheHome*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_CacheHome" data-uid="Xdg.Directories.BaseDirectory.CacheHome">
|
||||
CacheHome
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L117"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Base directory for non-essential data.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string CacheHome { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A single base directory relative to which user-specifc <strong>non-essential</strong> data should be written.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_CacheHome_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_CACHE_HOME</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%LOCALAPPDATA%\cache</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Library/Caches</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/.cache</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_ConfigDirs_" data-uid="Xdg.Directories.BaseDirectory.ConfigDirs*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_ConfigDirs" data-uid="Xdg.Directories.BaseDirectory.ConfigDirs">
|
||||
ConfigDirs
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L90"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A list of directories to look for configuration files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IList<string> ConfigDirs { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd><p>A set of preference-ordered base directories to which configuration files should be searched.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_ConfigDirs_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_CONFIG_DIRS</code> is set, a list of the directories specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%ProgramData%</code>,
|
||||
<code>%APPADATA%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>~/Library/Preferences</code>,
|
||||
<code>/Library/Application Support</code>,
|
||||
<code>/Library/Preferences</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>/etc/xdg</code>
|
||||
</td></tr></tbody></table>
|
||||
This is typically not used, for most use cases <a class="xref" href="Xdg.Directories.BaseDirectory.html#Xdg_Directories_BaseDirectory_ConfigHome">ConfigHome</a> should be used instead.
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_ConfigHome_" data-uid="Xdg.Directories.BaseDirectory.ConfigHome*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_ConfigHome" data-uid="Xdg.Directories.BaseDirectory.ConfigHome">
|
||||
ConfigHome
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L23"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Base directory for configuration files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string ConfigHome { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A single base directory relative to which user-specifc <strong>configuration</strong> files should be written.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_ConfigHome_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_CONFIG_HOME</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%LOCALAPPDATA%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Library/Application Support</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/.config</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_DataDirs_" data-uid="Xdg.Directories.BaseDirectory.DataDirs*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_DataDirs" data-uid="Xdg.Directories.BaseDirectory.DataDirs">
|
||||
DataDirs
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L69"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A list of directories to search for data files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IList<string> DataDirs { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd><p>A set of preference-ordered base directories to which data files should be searched.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_DataDirs_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_DATA_DIRS</code> is set, a list of the directories specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%APPADATA%</code>,
|
||||
<code>%ProgramData%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>/Library/Application Support</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>/usr/local/share/</code>,
|
||||
<code>/usr/share/</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_DataHome_" data-uid="Xdg.Directories.BaseDirectory.DataHome*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_DataHome" data-uid="Xdg.Directories.BaseDirectory.DataHome">
|
||||
DataHome
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L7"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Base directory for data files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string DataHome { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A single base directory relative to which user-specifc <strong>data</strong> files should be written.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_DataHome_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_DATA_HOME</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%LOCALAPPDATA%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Library/Application Support</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/.local/share</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_RuntimeDir_" data-uid="Xdg.Directories.BaseDirectory.RuntimeDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_RuntimeDir" data-uid="Xdg.Directories.BaseDirectory.RuntimeDir">
|
||||
RuntimeDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L134"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Base directory for runtime-specific files.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string RuntimeDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A single base directory relative to which user-specifc <strong>runtime files</strong> should be written.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_RuntimeDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_RUNTIME_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%LOCALAPPDATA%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Library/Application Support</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>/run/user/$UID</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_BaseDirectory_StateHome_" data-uid="Xdg.Directories.BaseDirectory.StateHome*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_BaseDirectory_StateHome" data-uid="Xdg.Directories.BaseDirectory.StateHome">
|
||||
StateHome
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L39"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Base directory for state data.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string StateHome { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A single base directory relative to which user-specifc <strong>state data</strong> should be written.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_BaseDirectory_StateHome_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_STATE_HOME</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%LOCALAPPDATA%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Library/Application Support</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/.local/state</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/BaseDirectory.cs/#L4" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,321 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Other </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Other ">
|
||||
|
||||
<meta name="description" content="Other useful directories that aren't specified by XDG.">
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/new/master/apiSpec/new?filename=Xdg_Directories_Other.md&value=---%0Auid%3A%20Xdg.Directories.Other%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Xdg.Directories.Other">
|
||||
|
||||
|
||||
|
||||
<h1 id="Xdg_Directories_Other" data-uid="Xdg.Directories.Other" class="text-break">
|
||||
Class Other <a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L4"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Xdg.html">Xdg</a>.<a class="xref" href="Xdg.Directories.html">Directories</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>Xdg.Directories.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Other useful directories that aren't specified by XDG.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class Other</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">Other</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="Xdg_Directories_Other_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>These variables were graciously stolen from the excellent <a href="https://github.com/adrg/xdg">Go XDG implementation</a>.
|
||||
That library largely inspired this one, absolutely recommended if you're working in Go.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Xdg_Directories_Other_Applications_" data-uid="Xdg.Directories.Other.Applications*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_Other_Applications" data-uid="Xdg.Directories.Other.Applications">
|
||||
Applications
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L23"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Application directories</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IList<string> Applications { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd><p>Common application directories.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_Other_Applications_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Programs</code> Special Folder,
|
||||
the <code>Common Programs</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>/Applications</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$XDG_DATA_HOME/applications</code>,
|
||||
<code>$HOME/.local/share/applications</code>,
|
||||
<code>/usr/local/share/applications</code>,
|
||||
<code>/usr/share/applications</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_Other_Fonts_" data-uid="Xdg.Directories.Other.Fonts*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_Other_Fonts" data-uid="Xdg.Directories.Other.Fonts">
|
||||
Fonts
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L49"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Font directories</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IList<string> Fonts { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd><p>Common font directories.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_Other_Fonts_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%SYSTEMROOT%\Fonts</code>,
|
||||
<code>%LOCALAPPDATA%\Microsoft\Windows\Fonts</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Library/Fonts</code>,
|
||||
<code>/Library/Fonts</code>,
|
||||
<code>/System/Library/Fonts</code>,
|
||||
<code>/Network/Library/Fonts</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$XDG_DATA_HOME/fonts</code>,
|
||||
<code>$HOME/.fonts</code>,
|
||||
<code>$HOME/.local/share/fonts</code>,
|
||||
<code>/usr/local/share/fonts</code>
|
||||
<code>/usr/share/fonts</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_Other_Home_" data-uid="Xdg.Directories.Other.Home*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_Other_Home" data-uid="Xdg.Directories.Other.Home">
|
||||
Home
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L7"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Home Directory</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string Home { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The current user's home directory.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_Other_Home_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%USERPROFILE%</code>
|
||||
</td></tr><tr><td class="term">Unix (macOS/Linux/FreeBSD)</td><td class="description">
|
||||
<code>$HOME</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L4" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,539 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class UserDirectory </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class UserDirectory ">
|
||||
|
||||
<meta name="description" content="User directories are &quot;well known&quot; user directories, examples include the Desktop folder and the Documents folder.">
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/new/master/apiSpec/new?filename=Xdg_Directories_UserDirectory.md&value=---%0Auid%3A%20Xdg.Directories.UserDirectory%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Xdg.Directories.UserDirectory">
|
||||
|
||||
|
||||
|
||||
<h1 id="Xdg_Directories_UserDirectory" data-uid="Xdg.Directories.UserDirectory" class="text-break">
|
||||
Class UserDirectory <a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L4"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="Xdg.html">Xdg</a>.<a class="xref" href="Xdg.Directories.html">Directories</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>Xdg.Directories.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>User directories are "well known" user directories, examples include the Desktop folder and the Documents folder.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class UserDirectory</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">UserDirectory</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="Xdg_Directories_UserDirectory_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>For all user directories, the directories are resolved as follows:</p>
|
||||
<ol><li><span class="term"> The respective <code>XDG_*</code> enivronment variable </span>will always be used if specified</li><li>
|
||||
<table><tbody><tr></tr><tr><td class="term">Windows</td><td class="description">
|
||||
Use <a href="https://learn.microsoft.com/en-us/windows/win32/shell/known-folders">Known Folders</a>.
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
Not sure where this is documented by Apple but it largely follows what Linux does.
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
Follow what <a href="https://freedesktop.org/wiki/Software/xdg-user-dirs">xdg-user-dirs</a> sets.
|
||||
</td></tr></tbody></table>
|
||||
</li></ol>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_DesktopDir_" data-uid="Xdg.Directories.UserDirectory.DesktopDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_DesktopDir" data-uid="Xdg.Directories.UserDirectory.DesktopDir">
|
||||
DesktopDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L7"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Desktop folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string DesktopDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The user's desktop directory.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_DesktopDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_DESKTOP_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Desktop</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Desktop</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Desktop</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_DocumentsDir_" data-uid="Xdg.Directories.UserDirectory.DocumentsDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_DocumentsDir" data-uid="Xdg.Directories.UserDirectory.DocumentsDir">
|
||||
DocumentsDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L36"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Document folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string DocumentsDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store documents files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_DocumentsDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_DOCUMENTS_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Documents</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Documents</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Documents</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_DownloadDir_" data-uid="Xdg.Directories.UserDirectory.DownloadDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_DownloadDir" data-uid="Xdg.Directories.UserDirectory.DownloadDir">
|
||||
DownloadDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L21"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Download folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string DownloadDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store downloaded files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_DownloadDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_DOWNLOAD_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>null</code>
|
||||
<br>
|
||||
Windows does not specify the Downloads folder in its magic folder list.
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Downloads</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Downloads</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_MusicDir_" data-uid="Xdg.Directories.UserDirectory.MusicDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_MusicDir" data-uid="Xdg.Directories.UserDirectory.MusicDir">
|
||||
MusicDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L50"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Music folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string MusicDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store music files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_MusicDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_MUSIC_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Music</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Music</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Music</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_PicturesDir_" data-uid="Xdg.Directories.UserDirectory.PicturesDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_PicturesDir" data-uid="Xdg.Directories.UserDirectory.PicturesDir">
|
||||
PicturesDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L64"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Image folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string PicturesDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store image files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_PicturesDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_PICTURES_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Pictures</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Pictures</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Pictures</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_PublicDir_" data-uid="Xdg.Directories.UserDirectory.PublicDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_PublicDir" data-uid="Xdg.Directories.UserDirectory.PublicDir">
|
||||
PublicDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L106"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Public folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string PublicDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store public / shared files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_PublicDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_PUBLICSHARE_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
<code>%PUBLIC%</code>
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Public</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Public</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_TemplatesDir_" data-uid="Xdg.Directories.UserDirectory.TemplatesDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_TemplatesDir" data-uid="Xdg.Directories.UserDirectory.TemplatesDir">
|
||||
TemplatesDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L92"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Template folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string TemplatesDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store template files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_TemplatesDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_TEMPLATES_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Templates</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Templates</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Templatess</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Xdg_Directories_UserDirectory_VideosDir_" data-uid="Xdg.Directories.UserDirectory.VideosDir*"></a>
|
||||
|
||||
<h3 id="Xdg_Directories_UserDirectory_VideosDir" data-uid="Xdg.Directories.UserDirectory.VideosDir">
|
||||
VideosDir
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L78"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Video folder</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string VideosDir { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A location to store video files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Xdg_Directories_UserDirectory_VideosDir_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If <code>XDG_VIDEOS_DIR</code> is set, the directory specified.</p>
|
||||
<table><tbody><tr><td class="term">Windows</td><td class="description">
|
||||
The <code>Videos</code> Special Folder
|
||||
</td></tr><tr><td class="term">macOS</td><td class="description">
|
||||
<code>$HOME/Movies</code>
|
||||
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
|
||||
<code>$HOME/Videos</code>
|
||||
</td></tr></tbody></table>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/UserDirectory.cs/#L4" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace Xdg.Directories </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace Xdg.Directories ">
|
||||
|
||||
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="Xdg.Directories">
|
||||
|
||||
<h1 id="Xdg_Directories" data-uid="Xdg.Directories" class="text-break">Namespace Xdg.Directories</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Xdg.Directories.BaseDirectory.html">BaseDirectory</a></dt>
|
||||
<dd><p>The XDG Base Directory specification is a standard created by freedesktop.org that standardizes the location of storing application files.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Xdg.Directories.Other.html">Other</a></dt>
|
||||
<dd><p>Other useful directories that aren't specified by XDG.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Xdg.Directories.UserDirectory.html">UserDirectory</a></dt>
|
||||
<dd><p>User directories are "well known" user directories, examples include the Desktop folder and the Documents folder.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
<div id="sidetoggle">
|
||||
<div>
|
||||
<div class="sidefilter">
|
||||
<form class="toc-filter">
|
||||
<span class="glyphicon glyphicon-filter filter-icon"></span>
|
||||
<span class="glyphicon glyphicon-remove clear-icon" id="toc_filter_clear"></span>
|
||||
<input type="text" id="toc_filter_input" placeholder="Filter by title" onkeypress="if(event.keyCode==13) {return false;}">
|
||||
</form>
|
||||
</div>
|
||||
<div class="sidetoc">
|
||||
<div class="toc" id="toc">
|
||||
|
||||
<ul class="nav level1">
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="Xdg.Directories.html" name="" title="Xdg.Directories">Xdg.Directories</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="Xdg.Directories.BaseDirectory.html" name="" title="BaseDirectory">BaseDirectory</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Xdg.Directories.Other.html" name="" title="Other">Other</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Xdg.Directories.UserDirectory.html" name="" title="UserDirectory">UserDirectory</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
|
||||
{"items":[{"name":"Xdg.Directories","href":"Xdg.Directories.html","topicHref":"Xdg.Directories.html","topicUid":"Xdg.Directories","items":[{"name":"BaseDirectory","href":"Xdg.Directories.BaseDirectory.html","topicHref":"Xdg.Directories.BaseDirectory.html","topicUid":"Xdg.Directories.BaseDirectory"},{"name":"Other","href":"Xdg.Directories.Other.html","topicHref":"Xdg.Directories.Other.html","topicUid":"Xdg.Directories.Other"},{"name":"UserDirectory","href":"Xdg.Directories.UserDirectory.html","topicHref":"Xdg.Directories.UserDirectory.html","topicUid":"Xdg.Directories.UserDirectory"}]}],"memberLayout":"SamePage","pdf":false}
|
||||
|
|
@ -0,0 +1,279 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Default Locations </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Default Locations ">
|
||||
|
||||
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/defaults.md/#L1">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="default-locations">Default Locations</h1>
|
||||
|
||||
<p>If any of the respective XDG environment are specified, the variable will always be returned.
|
||||
Otherwise, the value depends on the operating system.</p>
|
||||
<p>Inspiration is taken from the <a href="https://github.com/adrg/xdg">Go implementation</a> for Windows and MacOS directories.</p>
|
||||
<details open="">
|
||||
<summary>Base Directory</summary>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Environment Variable</th>
|
||||
<th>Windows</th>
|
||||
<th>macOS</th>
|
||||
<th>Linux/FreeBSD</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>XDG_DATA_HOME</code></td>
|
||||
<td><code>%LOCALAPPDATA%</code></td>
|
||||
<td><code>$HOME/Library/Application Support</code></td>
|
||||
<td><code>$HOME/.local/share</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_CONFIG_HOME</code></td>
|
||||
<td><code>%LOCALAPPDATA%</code></td>
|
||||
<td><code>$HOME/Library/Application Support</code></td>
|
||||
<td><code>$HOME/.config</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_STATE_HOME</code></td>
|
||||
<td><code>%LOCALAPPDATA%</code></td>
|
||||
<td><code>$HOME/Library/Application Support</code></td>
|
||||
<td><code>$HOME/.local/state</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_BIN_HOME</code></td>
|
||||
<td><code>null</code></td>
|
||||
<td><code>null</code></td>
|
||||
<td><code>$HOME/.local/bin</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_DATA_DIRS</code></td>
|
||||
<td><code>%APPDATA%:%PROGRAMDATA%</code></td>
|
||||
<td><code>/Library/Application Support</code></td>
|
||||
<td><code>/usr/local/share:/usr/share</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_CONFIG_DIRS</code></td>
|
||||
<td><code>%LOCALAPPDATA%</code></td>
|
||||
<td><code>$HOME/Library/Preferences:/Library/Application Support:/Library/Preferences</code></td>
|
||||
<td><code>/etc/xdg</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_CACHE_HOME</code></td>
|
||||
<td><code>%LOCALAPPDATA%</code></td>
|
||||
<td><code>$HOME/Library/Application Support</code></td>
|
||||
<td><code>$HOME/.config</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_RUNTIME_HOME</code></td>
|
||||
<td><code>%LOCALAPPDATA%</code></td>
|
||||
<td><code>$HOME/Library/Application Support</code></td>
|
||||
<td><code>/run/user/$UID</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</details>
|
||||
<details open="">
|
||||
<summary>User Directory</summary>
|
||||
<p>User directories on Windows use <a href="https://learn.microsoft.com/en-us/windows/win32/shell/known-folders">Known Folders</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Environment Variable</th>
|
||||
<th>Windows</th>
|
||||
<th>macOS</th>
|
||||
<th>Linux/FreeBSD</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>XDG_DESKTOP_DIR</code></td>
|
||||
<td><code>Desktop</code></td>
|
||||
<td><code>$HOME/Desktop</code></td>
|
||||
<td><code>$HOME/Desktop</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_DOWNLOAD_DIR</code></td>
|
||||
<td><code>null</code></td>
|
||||
<td><code>$HOME/Downloads</code></td>
|
||||
<td><code>$HOME/Downloads</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_DOCUMENTS_DIR</code></td>
|
||||
<td><code>My Documents</code></td>
|
||||
<td><code>$HOME/Documents</code></td>
|
||||
<td><code>$HOME/Documents</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_MUSIC_DIR</code></td>
|
||||
<td><code>My Music</code></td>
|
||||
<td><code>$HOME/Music</code></td>
|
||||
<td><code>$HOME/Music</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_PICTURES_DIRS</code></td>
|
||||
<td><code>My Pictures</code></td>
|
||||
<td><code>$HOME/Pictures</code></td>
|
||||
<td><code>$HOME/Pictures</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_VIDEOS_DIR</code></td>
|
||||
<td><code>My Videos</code></td>
|
||||
<td><code>$HOME/Movies</code></td>
|
||||
<td><code>$HOME/Videos</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_TEMPLATES_DIR</code></td>
|
||||
<td><code>Templates</code></td>
|
||||
<td><code>$HOME/Templates</code></td>
|
||||
<td><code>$HOME/Templates</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>XDG_PUBLICSHARE_DIR</code></td>
|
||||
<td><code>%PUBLIC%</code></td>
|
||||
<td><code>$HOME/Public</code></td>
|
||||
<td><code>$HOME/Public</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</details>
|
||||
<details open="">
|
||||
<summary>Extra Directories</summary>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th></th>
|
||||
<th>Windows</th>
|
||||
<th>macOS</th>
|
||||
<th>Linux/FreeBSD</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Home</td>
|
||||
<td><code>%USERPROFILE%</code></td>
|
||||
<td><code>$HOME</code></td>
|
||||
<td><code>$HOME</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Applications</td>
|
||||
<td><code>Programs</code>, <code>Common Programs</code></td>
|
||||
<td><code>/Applications</code></td>
|
||||
<td><code>$XDG_DATA_HOME/applications</code>, <code>$HOME/.local/share/applications</code>, <code>/usr/local/share/applications</code>, <code>/usr/share/applications</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Fonts</td>
|
||||
<td><code>%SYSTEMROOT%\Fonts</code>, <code>%LOCALAPPDATA%\Microsoft\Windows\Fonts</code></td>
|
||||
<td><code>$HOME/Library/Fonts</code>, <code>/Library/Fonts</code>, <code>/System/Library/Fonts</code>, <code>/Network/Library/Fonts</code></td>
|
||||
<td><code>$XDG_DATA_HOME/fonts</code>, <code>$HOME/.fonts</code>, <code>$HOME/.local/share/fonts</code>, <code>/usr/local/share/fonts</code>, <code>/usr/share/fonts</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</details>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/defaults.md/#L1" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,132 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Installation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Installation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/installation.md/#L1">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="installation">Installation</h1>
|
||||
|
||||
<h2 id="stable-releases">Stable Releases</h2>
|
||||
<p>Use <a href="http://docs.nuget.org/docs/start-here/installing-nuget">NuGet</a> to install <a href="https://www.nuget.org/packages/Xdg.Directories">Xdg.Directories</a>.</p>
|
||||
<p>From the .NET CLI:</p>
|
||||
<pre><code class="lang-bash">dotnet add package Xdg.Directories
|
||||
</code></pre>
|
||||
<p>or from Visual Studio's package manager:</p>
|
||||
<pre><code class="lang-pwsh">Install-Package Xdg.Directories
|
||||
</code></pre>
|
||||
<h2 id="pre-releases">Pre-releases</h2>
|
||||
<p>For bleeding edge users, preview releases are available.</p>
|
||||
<p>They are uploaded to two places automatically every commit:</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/xdg-net/Xdg.Directories/pkgs/nuget/Xdg.Directories">GitHub packages</a> - A GitHub account is needed to download.</li>
|
||||
<li><a href="https://git.froth.zone/mirrors/-/packages/nuget/xdg.directories">Forgejo packages</a> - No login required.</li>
|
||||
</ul>
|
||||
<p>Follow the directions at the respective links to install the package.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/installation.md/#L1" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,130 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>TL;DR </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="TL;DR ">
|
||||
|
||||
|
||||
<link rel="icon" href="../images/icon.png">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
<meta name="docfx:navrel" content="../toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="../">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/quick-use.md/#L1">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./../public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="../index.html">
|
||||
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="tldr">TL;DR</h1>
|
||||
|
||||
<p>Add the Xdg.Directories package to your project:</p>
|
||||
<pre><code class="lang-bash">dotnet add package Xdg.Directories
|
||||
</code></pre>
|
||||
<p>Then use the <code>BaseDirectory</code> and <code>UserDirectory</code> classes to access the XDG directories:</p>
|
||||
<pre><code class="lang-csharp">using System;
|
||||
using Xdg.Directories;
|
||||
|
||||
// Prints /home/$USER/.local/share
|
||||
Console.Writeline(BaseDirectory.DataHome);
|
||||
|
||||
// Prints /home/$USER/Documents
|
||||
Console.Writeline(UserDirectory.DocumentsDir);
|
||||
</code></pre>
|
||||
<p>For more information, see the <a href="/api/Xdg.Directories.html">API documentation</a>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/quick-use.md/#L1" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
<div id="sidetoggle">
|
||||
<div>
|
||||
<div class="sidefilter">
|
||||
<form class="toc-filter">
|
||||
<span class="glyphicon glyphicon-filter filter-icon"></span>
|
||||
<span class="glyphicon glyphicon-remove clear-icon" id="toc_filter_clear"></span>
|
||||
<input type="text" id="toc_filter_input" placeholder="Filter by title" onkeypress="if(event.keyCode==13) {return false;}">
|
||||
</form>
|
||||
</div>
|
||||
<div class="sidetoc">
|
||||
<div class="toc" id="toc">
|
||||
|
||||
<ul class="nav level1">
|
||||
<li>
|
||||
<a>Using the Library</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="defaults.html" name="" title="Default Locations">Default Locations</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="quick-use.html" name="" title="TL;DR">TL;DR</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="installation.html" name="" title="Installation">Installation</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
|
||||
{"items":[{"name":"Using the Library"},{"name":"Default Locations","href":"defaults.html","topicHref":"defaults.html"},{"name":"TL;DR","href":"quick-use.html","topicHref":"quick-use.html"},{"name":"Installation","href":"installation.html","topicHref":"installation.html"}],"pdf":false}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 97 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
|
|
@ -0,0 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="40px"
|
||||
height="40px" viewBox="0 0 50 50" version="1.1">
|
||||
<g id="surface1">
|
||||
<path style=" stroke:none;fill-rule:nonzero;fill:rgb(100%,100%,100%);fill-opacity:1;"
|
||||
d="M 48.4375 25 C 48.4375 37.945312 37.945312 48.4375 25 48.4375 C 12.054688 48.4375 1.5625 37.945312 1.5625 25 C 1.5625 12.054688 12.054688 1.5625 25 1.5625 C 37.945312 1.5625 48.4375 12.054688 48.4375 25 Z M 48.4375 25 " />
|
||||
<path
|
||||
style=" stroke:none;fill-rule:nonzero;fill:rgb(36.862745%,20.784314%,69.411765%);fill-opacity:1;"
|
||||
d="M 25 1.5625 C 12.054688 1.5625 1.5625 12.054688 1.5625 25 C 1.5625 37.945312 12.054688 48.4375 25 48.4375 C 37.945312 48.4375 48.4375 37.945312 48.4375 25 C 48.4375 12.054688 37.945312 1.5625 25 1.5625 M 29.308594 36.335938 L 25 28.605469 L 20.449219 36.335938 L 14.941406 36.335938 L 22.230469 24.785156 L 15.296875 13.667969 L 20.957031 13.667969 L 25 21.046875 L 29.152344 13.667969 L 34.628906 13.667969 L 27.691406 24.601562 L 35.058594 36.335938 Z M 29.308594 36.335938 " />
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
|
|
@ -0,0 +1,132 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Xdg.Directories </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Xdg.Directories ">
|
||||
|
||||
|
||||
<link rel="icon" href="images/icon.png">
|
||||
<link rel="stylesheet" href="public/docfx.min.css">
|
||||
<link rel="stylesheet" href="public/main.css">
|
||||
<meta name="docfx:navrel" content="toc.html">
|
||||
<meta name="docfx:tocrel" content="toc.html">
|
||||
|
||||
<meta name="docfx:rel" content="">
|
||||
|
||||
|
||||
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/index.md/#L1">
|
||||
<meta name="loc:inThisArticle" content="In this article">
|
||||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<meta name="loc:tocFilter" content="Filter by title">
|
||||
<meta name="loc:nextArticle" content="Next">
|
||||
<meta name="loc:prevArticle" content="Previous">
|
||||
<meta name="loc:themeLight" content="Light">
|
||||
<meta name="loc:themeDark" content="Dark">
|
||||
<meta name="loc:themeAuto" content="Auto">
|
||||
<meta name="loc:changeTheme" content="Change theme">
|
||||
<meta name="loc:copy" content="Copy">
|
||||
<meta name="loc:downloadPdf" content="Download PDF">
|
||||
</head>
|
||||
|
||||
<script type="module" src="./public/docfx.min.js"></script>
|
||||
|
||||
<script>
|
||||
const theme = localStorage.getItem('theme') || 'auto'
|
||||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||||
</script>
|
||||
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="landing" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
<a class="navbar-brand" href="index.html">
|
||||
<img id="logo" class="svg" src="images/icon.svg" alt="Xdg.Directories">
|
||||
Xdg.Directories
|
||||
</a>
|
||||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<i class="bi bi-three-dots"></i>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navpanel">
|
||||
<div id="navbar">
|
||||
<form class="search" role="search" id="search">
|
||||
<i class="bi bi-search"></i>
|
||||
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main class="container-xxl">
|
||||
<div class="toc-offcanvas">
|
||||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||||
<div class="offcanvas-header">
|
||||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="offcanvas-body">
|
||||
<nav class="toc" id="toc"></nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content">
|
||||
<div class="actionbar">
|
||||
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||||
<i class="bi bi-list"></i>
|
||||
</button>
|
||||
|
||||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="xdgdirectories">Xdg.Directories</h1>
|
||||
|
||||
<blockquote>
|
||||
<p><em>Want to get straight to the point? Check out the <a href="docs/quick-use.html">quick start guide</a>.</em></p>
|
||||
</blockquote>
|
||||
<p>Xdg.Directories is a library that simplifies using the XDG Base Directory Specification and XDG user directories in .NET applications.</p>
|
||||
<h2 id="features">Features</h2>
|
||||
<ul>
|
||||
<li><strong>Cross-platform</strong>: Supports Windows, MacOS and Linux/FreeBSD.</li>
|
||||
<li><strong>Fast</strong>: The .dll is only 11 KB.</li>
|
||||
<li><strong>Portable</strong>: Completely supports .NET Standard 2.0 and even NativeAOT!</li>
|
||||
<li><strong>Simple</strong>: Easy to use API.</li>
|
||||
<li><strong>Sane Defaults</strong>: Provides default directories for when the XDG environment variables are not set.
|
||||
<ul>
|
||||
<li>These defaults are documented in the code itself and are also available <a href="docs/defaults.html">here</a>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/index.md/#L1" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="affix">
|
||||
<nav id="affix"></nav>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<div class="container-xxl search-results" id="search-results"></div>
|
||||
|
||||
<footer class="border-top text-secondary">
|
||||
<div class="container-xxl">
|
||||
<div class="flex-fill">
|
||||
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
{
|
||||
"api/Xdg.Directories.BaseDirectory.html": {
|
||||
"href": "api/Xdg.Directories.BaseDirectory.html",
|
||||
"title": "Class BaseDirectory",
|
||||
"keywords": "Class BaseDirectory Namespace Xdg.Directories Assembly Xdg.Directories.dll The XDG Base Directory specification is a standard created by freedesktop.org that standardizes the location of storing application files. public static class BaseDirectory Inheritance object BaseDirectory Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks This allows users to have less clutter in their home directories, and allows programmers to not have to hard-code directories. For all base directories, the directories are resolved as follows: The respective XDG_* enivronment variable will always be used if specified Windows Use Known Folders. macOS Follow the Apple documentation on application-specific files. Linux/FreeBSD Follow the XDG Base Directory specification. Properties BinHome Base directory for executable files. public static string BinHome { get; } Property Value string A single base directory relative to which user-specifc executable files should be written. Remarks If XDG_BIN_HOME is set, the directory specified. Windows \"\" Windows does not support this by default. macOS \"\" macOS does not support this by default. Linux/FreeBSD $HOME/.local/bin NOTE: This is not an XDG standard but a de facto standard. CacheHome Base directory for non-essential data. public static string CacheHome { get; } Property Value string A single base directory relative to which user-specifc non-essential data should be written. Remarks If XDG_CACHE_HOME is set, the directory specified. Windows %LOCALAPPDATA%\\cache macOS $HOME/Library/Caches Linux/FreeBSD $HOME/.cache ConfigDirs A list of directories to look for configuration files. public static IList<string> ConfigDirs { get; } Property Value IList<string> A set of preference-ordered base directories to which configuration files should be searched. Remarks If XDG_CONFIG_DIRS is set, a list of the directories specified. Windows %ProgramData%, %APPADATA% macOS ~/Library/Preferences, /Library/Application Support, /Library/Preferences Linux/FreeBSD /etc/xdg This is typically not used, for most use cases ConfigHome should be used instead. ConfigHome Base directory for configuration files. public static string ConfigHome { get; } Property Value string A single base directory relative to which user-specifc configuration files should be written. Remarks If XDG_CONFIG_HOME is set, the directory specified. Windows %LOCALAPPDATA% macOS $HOME/Library/Application Support Linux/FreeBSD $HOME/.config DataDirs A list of directories to search for data files. public static IList<string> DataDirs { get; } Property Value IList<string> A set of preference-ordered base directories to which data files should be searched. Remarks If XDG_DATA_DIRS is set, a list of the directories specified. Windows %APPADATA%, %ProgramData% macOS /Library/Application Support Linux/FreeBSD /usr/local/share/, /usr/share/ DataHome Base directory for data files. public static string DataHome { get; } Property Value string A single base directory relative to which user-specifc data files should be written. Remarks If XDG_DATA_HOME is set, the directory specified. Windows %LOCALAPPDATA% macOS $HOME/Library/Application Support Linux/FreeBSD $HOME/.local/share RuntimeDir Base directory for runtime-specific files. public static string RuntimeDir { get; } Property Value string A single base directory relative to which user-specifc runtime files should be written. Remarks If XDG_RUNTIME_DIR is set, the directory specified. Windows %LOCALAPPDATA% macOS $HOME/Library/Application Support Linux/FreeBSD /run/user/$UID StateHome Base directory for state data. public static string StateHome { get; } Property Value string A single base directory relative to which user-specifc state data should be written. Remarks If XDG_STATE_HOME is set, the directory specified. Windows %LOCALAPPDATA% macOS $HOME/Library/Application Support Linux/FreeBSD $HOME/.local/state"
|
||||
},
|
||||
"api/Xdg.Directories.Other.html": {
|
||||
"href": "api/Xdg.Directories.Other.html",
|
||||
"title": "Class Other",
|
||||
"keywords": "Class Other Namespace Xdg.Directories Assembly Xdg.Directories.dll Other useful directories that aren't specified by XDG. public static class Other Inheritance object Other Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks These variables were graciously stolen from the excellent Go XDG implementation. That library largely inspired this one, absolutely recommended if you're working in Go. Properties Applications Application directories public static IList<string> Applications { get; } Property Value IList<string> Common application directories. Remarks Windows The Programs Special Folder, the Common Programs Special Folder macOS /Applications Linux/FreeBSD $XDG_DATA_HOME/applications, $HOME/.local/share/applications, /usr/local/share/applications, /usr/share/applications Fonts Font directories public static IList<string> Fonts { get; } Property Value IList<string> Common font directories. Remarks Windows %SYSTEMROOT%\\Fonts, %LOCALAPPDATA%\\Microsoft\\Windows\\Fonts macOS $HOME/Library/Fonts, /Library/Fonts, /System/Library/Fonts, /Network/Library/Fonts Linux/FreeBSD $XDG_DATA_HOME/fonts, $HOME/.fonts, $HOME/.local/share/fonts, /usr/local/share/fonts /usr/share/fonts Home Home Directory public static string Home { get; } Property Value string The current user's home directory. Remarks Windows %USERPROFILE% Unix (macOS/Linux/FreeBSD) $HOME"
|
||||
},
|
||||
"api/Xdg.Directories.UserDirectory.html": {
|
||||
"href": "api/Xdg.Directories.UserDirectory.html",
|
||||
"title": "Class UserDirectory",
|
||||
"keywords": "Class UserDirectory Namespace Xdg.Directories Assembly Xdg.Directories.dll User directories are \"well known\" user directories, examples include the Desktop folder and the Documents folder. public static class UserDirectory Inheritance object UserDirectory Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks For all user directories, the directories are resolved as follows: The respective XDG_* enivronment variable will always be used if specified Windows Use Known Folders. macOS Not sure where this is documented by Apple but it largely follows what Linux does. Linux/FreeBSD Follow what xdg-user-dirs sets. Properties DesktopDir Desktop folder public static string DesktopDir { get; } Property Value string The user's desktop directory. Remarks If XDG_DESKTOP_DIR is set, the directory specified. Windows The Desktop Special Folder macOS $HOME/Desktop Linux/FreeBSD $HOME/Desktop DocumentsDir Document folder public static string DocumentsDir { get; } Property Value string A location to store documents files. Remarks If XDG_DOCUMENTS_DIR is set, the directory specified. Windows The Documents Special Folder macOS $HOME/Documents Linux/FreeBSD $HOME/Documents DownloadDir Download folder public static string DownloadDir { get; } Property Value string A location to store downloaded files. Remarks If XDG_DOWNLOAD_DIR is set, the directory specified. Windows null Windows does not specify the Downloads folder in its magic folder list. macOS $HOME/Downloads Linux/FreeBSD $HOME/Downloads MusicDir Music folder public static string MusicDir { get; } Property Value string A location to store music files. Remarks If XDG_MUSIC_DIR is set, the directory specified. Windows The Music Special Folder macOS $HOME/Music Linux/FreeBSD $HOME/Music PicturesDir Image folder public static string PicturesDir { get; } Property Value string A location to store image files. Remarks If XDG_PICTURES_DIR is set, the directory specified. Windows The Pictures Special Folder macOS $HOME/Pictures Linux/FreeBSD $HOME/Pictures PublicDir Public folder public static string PublicDir { get; } Property Value string A location to store public / shared files. Remarks If XDG_PUBLICSHARE_DIR is set, the directory specified. Windows %PUBLIC% macOS $HOME/Public Linux/FreeBSD $HOME/Public TemplatesDir Template folder public static string TemplatesDir { get; } Property Value string A location to store template files. Remarks If XDG_TEMPLATES_DIR is set, the directory specified. Windows The Templates Special Folder macOS $HOME/Templates Linux/FreeBSD $HOME/Templatess VideosDir Video folder public static string VideosDir { get; } Property Value string A location to store video files. Remarks If XDG_VIDEOS_DIR is set, the directory specified. Windows The Videos Special Folder macOS $HOME/Movies Linux/FreeBSD $HOME/Videos"
|
||||
},
|
||||
"api/Xdg.Directories.html": {
|
||||
"href": "api/Xdg.Directories.html",
|
||||
"title": "Namespace Xdg.Directories",
|
||||
"keywords": "Namespace Xdg.Directories Classes BaseDirectory The XDG Base Directory specification is a standard created by freedesktop.org that standardizes the location of storing application files. Other Other useful directories that aren't specified by XDG. UserDirectory User directories are \"well known\" user directories, examples include the Desktop folder and the Documents folder."
|
||||
},
|
||||
"docs/defaults.html": {
|
||||
"href": "docs/defaults.html",
|
||||
"title": "Default Locations",
|
||||
"keywords": "Default Locations If any of the respective XDG environment are specified, the variable will always be returned. Otherwise, the value depends on the operating system. Inspiration is taken from the Go implementation for Windows and MacOS directories. Base Directory Environment Variable Windows macOS Linux/FreeBSD XDG_DATA_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.local/share XDG_CONFIG_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.config XDG_STATE_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.local/state XDG_BIN_HOME null null $HOME/.local/bin XDG_DATA_DIRS %APPDATA%:%PROGRAMDATA% /Library/Application Support /usr/local/share:/usr/share XDG_CONFIG_DIRS %LOCALAPPDATA% $HOME/Library/Preferences:/Library/Application Support:/Library/Preferences /etc/xdg XDG_CACHE_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.config XDG_RUNTIME_HOME %LOCALAPPDATA% $HOME/Library/Application Support /run/user/$UID User Directory User directories on Windows use Known Folders. Environment Variable Windows macOS Linux/FreeBSD XDG_DESKTOP_DIR Desktop $HOME/Desktop $HOME/Desktop XDG_DOWNLOAD_DIR null $HOME/Downloads $HOME/Downloads XDG_DOCUMENTS_DIR My Documents $HOME/Documents $HOME/Documents XDG_MUSIC_DIR My Music $HOME/Music $HOME/Music XDG_PICTURES_DIRS My Pictures $HOME/Pictures $HOME/Pictures XDG_VIDEOS_DIR My Videos $HOME/Movies $HOME/Videos XDG_TEMPLATES_DIR Templates $HOME/Templates $HOME/Templates XDG_PUBLICSHARE_DIR %PUBLIC% $HOME/Public $HOME/Public Extra Directories Windows macOS Linux/FreeBSD Home %USERPROFILE% $HOME $HOME Applications Programs, Common Programs /Applications $XDG_DATA_HOME/applications, $HOME/.local/share/applications, /usr/local/share/applications, /usr/share/applications Fonts %SYSTEMROOT%\\Fonts, %LOCALAPPDATA%\\Microsoft\\Windows\\Fonts $HOME/Library/Fonts, /Library/Fonts, /System/Library/Fonts, /Network/Library/Fonts $XDG_DATA_HOME/fonts, $HOME/.fonts, $HOME/.local/share/fonts, /usr/local/share/fonts, /usr/share/fonts"
|
||||
},
|
||||
"docs/installation.html": {
|
||||
"href": "docs/installation.html",
|
||||
"title": "Installation",
|
||||
"keywords": "Installation Stable Releases Use NuGet to install Xdg.Directories. From the .NET CLI: dotnet add package Xdg.Directories or from Visual Studio's package manager: Install-Package Xdg.Directories Pre-releases For bleeding edge users, preview releases are available. They are uploaded to two places automatically every commit: GitHub packages - A GitHub account is needed to download. Forgejo packages - No login required. Follow the directions at the respective links to install the package."
|
||||
},
|
||||
"docs/quick-use.html": {
|
||||
"href": "docs/quick-use.html",
|
||||
"title": "TL;DR",
|
||||
"keywords": "TL;DR Add the Xdg.Directories package to your project: dotnet add package Xdg.Directories Then use the BaseDirectory and UserDirectory classes to access the XDG directories: using System; using Xdg.Directories; // Prints /home/$USER/.local/share Console.Writeline(BaseDirectory.DataHome); // Prints /home/$USER/Documents Console.Writeline(UserDirectory.DocumentsDir); For more information, see the API documentation."
|
||||
},
|
||||
"index.html": {
|
||||
"href": "index.html",
|
||||
"title": "Xdg.Directories",
|
||||
"keywords": "Xdg.Directories Want to get straight to the point? Check out the quick start guide. Xdg.Directories is a library that simplifies using the XDG Base Directory Specification and XDG user directories in .NET applications. Features Cross-platform: Supports Windows, MacOS and Linux/FreeBSD. Fast: The .dll is only 11 KB. Portable: Completely supports .NET Standard 2.0 and even NativeAOT! Simple: Easy to use API. Sane Defaults: Provides default directories for when the XDG environment variables are not set. These defaults are documented in the code itself and are also available here."
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
|
||||
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
|
||||
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
|
||||
width="38.000000pt" height="38.000000pt" viewBox="0 0 172.000000 172.000000"
|
||||
preserveAspectRatio="xMidYMid meet">
|
||||
<metadata>
|
||||
Created by Docfx
|
||||
</metadata>
|
||||
<g transform="translate(0.000000,172.000000) scale(0.100000,-0.100000)"
|
||||
fill="#dddddd" stroke="none">
|
||||
<path d="M230 1359 c0 -18 11 -30 44 -48 80 -42 81 -45 81 -441 0 -400 -1
|
||||
-404 -79 -436 -36 -15 -46 -24 -46 -43 0 -23 2 -24 61 -17 34 3 88 6 120 6
|
||||
l59 0 0 495 0 495 -82 0 c-46 0 -100 3 -120 6 -35 6 -38 5 -38 -17z"/>
|
||||
<path d="M618 1373 l-118 -4 0 -493 0 -494 154 -7 c181 -9 235 -3 313 34 68
|
||||
33 168 130 207 202 75 136 75 384 1 536 -71 145 -234 240 -399 231 -23 -1 -94
|
||||
-4 -158 -5z m287 -119 c68 -24 144 -101 176 -179 22 -54 24 -75 24 -210 0
|
||||
-141 -2 -153 -26 -206 -36 -76 -89 -132 -152 -160 -45 -21 -68 -24 -164 -24
|
||||
-71 0 -116 4 -123 11 -22 22 -31 175 -28 463 2 208 6 293 15 302 32 32 188 33
|
||||
278 3z"/>
|
||||
<path d="M1170 1228 c75 -104 110 -337 76 -508 -21 -100 -56 -178 -105 -233
|
||||
l-36 -41 34 20 c75 43 160 133 198 212 37 75 38 78 38 191 -1 129 -18 191 -75
|
||||
270 -28 38 -136 131 -153 131 -4 0 6 -19 23 -42z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |
|
|
@ -0,0 +1,158 @@
|
|||
{
|
||||
"source_base_path": "/home/runner/work/Xdg.Directories/Xdg.Directories/docs",
|
||||
"xrefmap": "xrefmap.yml",
|
||||
"files": [
|
||||
{
|
||||
"type": "Resource",
|
||||
"output": {
|
||||
"resource": {
|
||||
"relative_path": "index.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/Xdg.Directories.BaseDirectory.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/Xdg.Directories.BaseDirectory.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/Xdg.Directories.Other.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/Xdg.Directories.Other.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/Xdg.Directories.UserDirectory.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/Xdg.Directories.UserDirectory.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/Xdg.Directories.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/Xdg.Directories.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Toc",
|
||||
"source_relative_path": "api/toc.yml",
|
||||
"output": {
|
||||
".json": {
|
||||
"relative_path": "api/toc.json"
|
||||
},
|
||||
".html": {
|
||||
"relative_path": "api/toc.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "docs/defaults.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "docs/defaults.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "docs/installation.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "docs/installation.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "docs/quick-use.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "docs/quick-use.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Toc",
|
||||
"source_relative_path": "docs/toc.yml",
|
||||
"output": {
|
||||
".json": {
|
||||
"relative_path": "docs/toc.json"
|
||||
},
|
||||
".html": {
|
||||
"relative_path": "docs/toc.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Resource",
|
||||
"source_relative_path": "images/icon.png",
|
||||
"output": {
|
||||
"resource": {
|
||||
"relative_path": "images/icon.png"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Resource",
|
||||
"source_relative_path": "images/icon.svg",
|
||||
"output": {
|
||||
"resource": {
|
||||
"relative_path": "images/icon.svg"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "index.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "index.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Toc",
|
||||
"source_relative_path": "toc.yml",
|
||||
"output": {
|
||||
".json": {
|
||||
"relative_path": "toc.json"
|
||||
},
|
||||
".html": {
|
||||
"relative_path": "toc.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
}
|
||||
],
|
||||
"groups": [
|
||||
{
|
||||
"xrefmap": "xrefmap.yml"
|
||||
}
|
||||
]
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,22 @@
|
|||
import{b as k}from"./chunk-P42HNYSU.min.js";var v=k((h,j)=>{(function(e,n){typeof define=="function"&&define.amd?define(n):typeof h=="object"?j.exports=n():n()(e.lunr)})(h,function(){return function(e){if(typeof e>"u")throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(typeof e.stemmerSupport>"u")throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var n=e.version[0]=="2";e.ja=function(){this.pipeline.reset(),this.pipeline.add(e.ja.trimmer,e.ja.stopWordFilter,e.ja.stemmer),n?this.tokenizer=e.ja.tokenizer:(e.tokenizer&&(e.tokenizer=e.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.ja.tokenizer))};var F=new e.TinySegmenter;e.ja.tokenizer=function(s){var t,i,f,o,a,d,g,p,r,c;if(!arguments.length||s==null||s==null)return[];if(Array.isArray(s))return s.map(function(m){return n?new e.Token(m.toLowerCase()):m.toLowerCase()});for(i=s.toString().toLowerCase().replace(/^\s+/,""),t=i.length-1;t>=0;t--)if(/\S/.test(i.charAt(t))){i=i.substring(0,t+1);break}for(a=[],f=i.length,r=0,p=0;r<=f;r++)if(d=i.charAt(r),g=r-p,d.match(/\s/)||r==f){if(g>0)for(o=F.segment(i.slice(p,r)).filter(function(m){return!!m}),c=p,t=0;t<o.length;t++)n?a.push(new e.Token(o[t],{position:[c,o[t].length],index:a.length})):a.push(o[t]),c+=o[t].length;p=r+1}return a},e.ja.stemmer=function(){return function(s){return s}}(),e.Pipeline.registerFunction(e.ja.stemmer,"stemmer-ja"),e.ja.wordCharacters="\u4E00\u4E8C\u4E09\u56DB\u4E94\u516D\u4E03\u516B\u4E5D\u5341\u767E\u5343\u4E07\u5104\u5146\u4E00-\u9FA0\u3005\u3006\u30F5\u30F6\u3041-\u3093\u30A1-\u30F4\u30FC\uFF71-\uFF9D\uFF9Ea-zA-Z\uFF41-\uFF5A\uFF21-\uFF3A0-9\uFF10-\uFF19",e.ja.trimmer=e.trimmerSupport.generateTrimmer(e.ja.wordCharacters),e.Pipeline.registerFunction(e.ja.trimmer,"trimmer-ja"),e.ja.stopWordFilter=e.generateStopWordFilter("\u3053\u308C \u305D\u308C \u3042\u308C \u3053\u306E \u305D\u306E \u3042\u306E \u3053\u3053 \u305D\u3053 \u3042\u305D\u3053 \u3053\u3061\u3089 \u3069\u3053 \u3060\u308C \u306A\u306B \u306A\u3093 \u4F55 \u79C1 \u8CB4\u65B9 \u8CB4\u65B9\u65B9 \u6211\u3005 \u79C1\u9054 \u3042\u306E\u4EBA \u3042\u306E\u304B\u305F \u5F7C\u5973 \u5F7C \u3067\u3059 \u3042\u308A\u307E\u3059 \u304A\u308A\u307E\u3059 \u3044\u307E\u3059 \u306F \u304C \u306E \u306B \u3092 \u3067 \u3048 \u304B\u3089 \u307E\u3067 \u3088\u308A \u3082 \u3069\u306E \u3068 \u3057 \u305D\u308C\u3067 \u3057\u304B\u3057".split(" ")),e.Pipeline.registerFunction(e.ja.stopWordFilter,"stopWordFilter-ja"),e.jp=e.ja,e.Pipeline.registerFunction(e.jp.stemmer,"stemmer-jp"),e.Pipeline.registerFunction(e.jp.trimmer,"trimmer-jp"),e.Pipeline.registerFunction(e.jp.stopWordFilter,"stopWordFilter-jp")}})});export{v as a};
|
||||
/*! Bundled license information:
|
||||
|
||||
lunr-languages/lunr.ja.js:
|
||||
(*!
|
||||
* Lunr languages, `Japanese` language
|
||||
* https://github.com/MihaiValentin/lunr-languages
|
||||
*
|
||||
* Copyright 2014, Chad Liu
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
(*!
|
||||
* based on
|
||||
* Snowball JavaScript Library v0.3
|
||||
* http://code.google.com/p/urim/
|
||||
* http://snowball.tartarus.org/
|
||||
*
|
||||
* Copyright 2010, Oleg Mazko
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
*/
|
||||
//# sourceMappingURL=chunk-334IV3XH.min.js.map
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,2 @@
|
|||
import{Ha as o,c as l}from"./chunk-L5V3YLAC.min.js";import{d as c}from"./chunk-P42HNYSU.min.js";var i=c(l(),1);var x=(s,t)=>{let r=s.append("rect");if(r.attr("x",t.x),r.attr("y",t.y),r.attr("fill",t.fill),r.attr("stroke",t.stroke),r.attr("width",t.width),r.attr("height",t.height),t.rx!==void 0&&r.attr("rx",t.rx),t.ry!==void 0&&r.attr("ry",t.ry),t.attrs!==void 0)for(let e in t.attrs)r.attr(e,t.attrs[e]);return t.class!==void 0&&r.attr("class",t.class),r},h=(s,t)=>{let r={x:t.startx,y:t.starty,width:t.stopx-t.startx,height:t.stopy-t.starty,fill:t.fill,stroke:t.stroke,class:"rect"};x(s,r).lower()},y=(s,t)=>{let r=t.text.replace(o," "),e=s.append("text");e.attr("x",t.x),e.attr("y",t.y),e.attr("class","legend"),e.style("text-anchor",t.anchor),t.class!==void 0&&e.attr("class",t.class);let n=e.append("tspan");return n.attr("x",t.x+t.textMargin*2),n.text(r),e},p=(s,t,r,e)=>{let n=s.append("image");n.attr("x",t),n.attr("y",r);let a=(0,i.sanitizeUrl)(e);n.attr("xlink:href",a)},g=(s,t,r,e)=>{let n=s.append("use");n.attr("x",t),n.attr("y",r);let a=(0,i.sanitizeUrl)(e);n.attr("xlink:href",`#${a}`)},m=()=>({x:0,y:0,width:100,height:100,fill:"#EDF2AE",stroke:"#666",anchor:"start",rx:0,ry:0}),f=()=>({x:0,y:0,width:100,height:100,"text-anchor":"start",style:"#666",textMargin:0,rx:0,ry:0,tspan:!0});export{x as a,h as b,y as c,p as d,g as e,m as f,f as g};
|
||||
//# sourceMappingURL=chunk-G2NF7P7O.min.js.map
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/svgDrawCommon-0ee1b4e9.js"],
|
||||
"sourcesContent": ["import { sanitizeUrl } from \"@braintree/sanitize-url\";\nimport { G as lineBreakRegex } from \"./mermaid-0603ccf8.js\";\nconst drawRect = (element, rectData) => {\n const rectElement = element.append(\"rect\");\n rectElement.attr(\"x\", rectData.x);\n rectElement.attr(\"y\", rectData.y);\n rectElement.attr(\"fill\", rectData.fill);\n rectElement.attr(\"stroke\", rectData.stroke);\n rectElement.attr(\"width\", rectData.width);\n rectElement.attr(\"height\", rectData.height);\n rectData.rx !== void 0 && rectElement.attr(\"rx\", rectData.rx);\n rectData.ry !== void 0 && rectElement.attr(\"ry\", rectData.ry);\n if (rectData.attrs !== void 0) {\n for (const attrKey in rectData.attrs) {\n rectElement.attr(attrKey, rectData.attrs[attrKey]);\n }\n }\n rectData.class !== void 0 && rectElement.attr(\"class\", rectData.class);\n return rectElement;\n};\nconst drawBackgroundRect = (element, bounds) => {\n const rectData = {\n x: bounds.startx,\n y: bounds.starty,\n width: bounds.stopx - bounds.startx,\n height: bounds.stopy - bounds.starty,\n fill: bounds.fill,\n stroke: bounds.stroke,\n class: \"rect\"\n };\n const rectElement = drawRect(element, rectData);\n rectElement.lower();\n};\nconst drawText = (element, textData) => {\n const nText = textData.text.replace(lineBreakRegex, \" \");\n const textElem = element.append(\"text\");\n textElem.attr(\"x\", textData.x);\n textElem.attr(\"y\", textData.y);\n textElem.attr(\"class\", \"legend\");\n textElem.style(\"text-anchor\", textData.anchor);\n textData.class !== void 0 && textElem.attr(\"class\", textData.class);\n const tspan = textElem.append(\"tspan\");\n tspan.attr(\"x\", textData.x + textData.textMargin * 2);\n tspan.text(nText);\n return textElem;\n};\nconst drawImage = (elem, x, y, link) => {\n const imageElement = elem.append(\"image\");\n imageElement.attr(\"x\", x);\n imageElement.attr(\"y\", y);\n const sanitizedLink = sanitizeUrl(link);\n imageElement.attr(\"xlink:href\", sanitizedLink);\n};\nconst drawEmbeddedImage = (element, x, y, link) => {\n const imageElement = element.append(\"use\");\n imageElement.attr(\"x\", x);\n imageElement.attr(\"y\", y);\n const sanitizedLink = sanitizeUrl(link);\n imageElement.attr(\"xlink:href\", `#${sanitizedLink}`);\n};\nconst getNoteRect = () => {\n const noteRectData = {\n x: 0,\n y: 0,\n width: 100,\n height: 100,\n fill: \"#EDF2AE\",\n stroke: \"#666\",\n anchor: \"start\",\n rx: 0,\n ry: 0\n };\n return noteRectData;\n};\nconst getTextObj = () => {\n const testObject = {\n x: 0,\n y: 0,\n width: 100,\n height: 100,\n \"text-anchor\": \"start\",\n style: \"#666\",\n textMargin: 0,\n rx: 0,\n ry: 0,\n tspan: true\n };\n return testObject;\n};\nexport {\n drawBackgroundRect as a,\n drawEmbeddedImage as b,\n drawImage as c,\n drawRect as d,\n getTextObj as e,\n drawText as f,\n getNoteRect as g\n};\n"],
|
||||
"mappings": "gGAAA,IAAAA,EAA4B,SAE5B,IAAMC,EAAW,CAACC,EAASC,IAAa,CACtC,IAAMC,EAAcF,EAAQ,OAAO,MAAM,EASzC,GARAE,EAAY,KAAK,IAAKD,EAAS,CAAC,EAChCC,EAAY,KAAK,IAAKD,EAAS,CAAC,EAChCC,EAAY,KAAK,OAAQD,EAAS,IAAI,EACtCC,EAAY,KAAK,SAAUD,EAAS,MAAM,EAC1CC,EAAY,KAAK,QAASD,EAAS,KAAK,EACxCC,EAAY,KAAK,SAAUD,EAAS,MAAM,EAC1CA,EAAS,KAAO,QAAUC,EAAY,KAAK,KAAMD,EAAS,EAAE,EAC5DA,EAAS,KAAO,QAAUC,EAAY,KAAK,KAAMD,EAAS,EAAE,EACxDA,EAAS,QAAU,OACrB,QAAWE,KAAWF,EAAS,MAC7BC,EAAY,KAAKC,EAASF,EAAS,MAAME,CAAO,CAAC,EAGrD,OAAAF,EAAS,QAAU,QAAUC,EAAY,KAAK,QAASD,EAAS,KAAK,EAC9DC,CACT,EACME,EAAqB,CAACJ,EAASK,IAAW,CAC9C,IAAMJ,EAAW,CACf,EAAGI,EAAO,OACV,EAAGA,EAAO,OACV,MAAOA,EAAO,MAAQA,EAAO,OAC7B,OAAQA,EAAO,MAAQA,EAAO,OAC9B,KAAMA,EAAO,KACb,OAAQA,EAAO,OACf,MAAO,MACT,EACoBN,EAASC,EAASC,CAAQ,EAClC,MAAM,CACpB,EACMK,EAAW,CAACN,EAASO,IAAa,CACtC,IAAMC,EAAQD,EAAS,KAAK,QAAQE,EAAgB,GAAG,EACjDC,EAAWV,EAAQ,OAAO,MAAM,EACtCU,EAAS,KAAK,IAAKH,EAAS,CAAC,EAC7BG,EAAS,KAAK,IAAKH,EAAS,CAAC,EAC7BG,EAAS,KAAK,QAAS,QAAQ,EAC/BA,EAAS,MAAM,cAAeH,EAAS,MAAM,EAC7CA,EAAS,QAAU,QAAUG,EAAS,KAAK,QAASH,EAAS,KAAK,EAClE,IAAMI,EAAQD,EAAS,OAAO,OAAO,EACrC,OAAAC,EAAM,KAAK,IAAKJ,EAAS,EAAIA,EAAS,WAAa,CAAC,EACpDI,EAAM,KAAKH,CAAK,EACTE,CACT,EACME,EAAY,CAACC,EAAMC,EAAGC,EAAGC,IAAS,CACtC,IAAMC,EAAeJ,EAAK,OAAO,OAAO,EACxCI,EAAa,KAAK,IAAKH,CAAC,EACxBG,EAAa,KAAK,IAAKF,CAAC,EACxB,IAAMG,KAAgB,eAAYF,CAAI,EACtCC,EAAa,KAAK,aAAcC,CAAa,CAC/C,EACMC,EAAoB,CAACnB,EAASc,EAAGC,EAAGC,IAAS,CACjD,IAAMC,EAAejB,EAAQ,OAAO,KAAK,EACzCiB,EAAa,KAAK,IAAKH,CAAC,EACxBG,EAAa,KAAK,IAAKF,CAAC,EACxB,IAAMG,KAAgB,eAAYF,CAAI,EACtCC,EAAa,KAAK,aAAc,IAAIC,CAAa,EAAE,CACrD,EACME,EAAc,KACG,CACnB,EAAG,EACH,EAAG,EACH,MAAO,IACP,OAAQ,IACR,KAAM,UACN,OAAQ,OACR,OAAQ,QACR,GAAI,EACJ,GAAI,CACN,GAGIC,EAAa,KACE,CACjB,EAAG,EACH,EAAG,EACH,MAAO,IACP,OAAQ,IACR,cAAe,QACf,MAAO,OACP,WAAY,EACZ,GAAI,EACJ,GAAI,EACJ,MAAO,EACT",
|
||||
"names": ["import_sanitize_url", "drawRect", "element", "rectData", "rectElement", "attrKey", "drawBackgroundRect", "bounds", "drawText", "textData", "nText", "lineBreakRegex", "textElem", "tspan", "drawImage", "elem", "x", "y", "link", "imageElement", "sanitizedLink", "drawEmbeddedImage", "getNoteRect", "getTextObj"]
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,2 @@
|
|||
var g=Object.create;var e=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var i=Object.getOwnPropertyNames;var j=Object.getPrototypeOf,k=Object.prototype.hasOwnProperty;var m=(a=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(a,{get:(b,c)=>(typeof require<"u"?require:b)[c]}):a)(function(a){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+a+'" is not supported')});var n=(a,b)=>()=>(b||a((b={exports:{}}).exports,b),b.exports),o=(a,b)=>{for(var c in b)e(a,c,{get:b[c],enumerable:!0})},l=(a,b,c,f)=>{if(b&&typeof b=="object"||typeof b=="function")for(let d of i(b))!k.call(a,d)&&d!==c&&e(a,d,{get:()=>b[d],enumerable:!(f=h(b,d))||f.enumerable});return a};var p=(a,b,c)=>(c=a!=null?g(j(a)):{},l(b||!a||!a.__esModule?e(c,"default",{value:a,enumerable:!0}):c,a));export{m as a,n as b,o as c,p as d};
|
||||
//# sourceMappingURL=chunk-P42HNYSU.min.js.map
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": [],
|
||||
"sourcesContent": [],
|
||||
"mappings": "",
|
||||
"names": []
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,3 @@
|
|||
import{a as G,b as v,c as I}from"./chunk-SG2NF4QM.min.js";import{a as W}from"./chunk-ULAEXCMJ.min.js";import{A}from"./chunk-GT3P3F7J.min.js";import{G as _,Ga as y,I as C,J as R,Ka as O,Za as T,ab as P,b as J,c as Z,h as E,kb as S}from"./chunk-L5V3YLAC.min.js";import{d as N}from"./chunk-P42HNYSU.min.js";var at=N(J(),1),it=N(Z(),1),nt=N(R(),1);var X=0,F=function(i,r,t,o,p){let g=function(e){switch(e){case p.db.relationType.AGGREGATION:return"aggregation";case p.db.relationType.EXTENSION:return"extension";case p.db.relationType.COMPOSITION:return"composition";case p.db.relationType.DEPENDENCY:return"dependency";case p.db.relationType.LOLLIPOP:return"lollipop"}};r.points=r.points.filter(e=>!Number.isNaN(e.y));let s=r.points,c=_().x(function(e){return e.x}).y(function(e){return e.y}).curve(C),n=i.append("path").attr("d",c(s)).attr("id","edge"+X).attr("class","relation"),a="";o.arrowMarkerAbsolute&&(a=window.location.protocol+"//"+window.location.host+window.location.pathname+window.location.search,a=a.replace(/\(/g,"\\("),a=a.replace(/\)/g,"\\)")),t.relation.lineType==1&&n.attr("class","relation dashed-line"),t.relation.lineType==10&&n.attr("class","relation dotted-line"),t.relation.type1!=="none"&&n.attr("marker-start","url("+a+"#"+g(t.relation.type1)+"Start)"),t.relation.type2!=="none"&&n.attr("marker-end","url("+a+"#"+g(t.relation.type2)+"End)");let f,h,x=r.points.length,b=T.calcLabelPosition(r.points);f=b.x,h=b.y;let u,m,w,k;if(x%2!==0&&x>1){let e=T.calcCardinalityPosition(t.relation.type1!=="none",r.points,r.points[0]),d=T.calcCardinalityPosition(t.relation.type2!=="none",r.points,r.points[x-1]);y.debug("cardinality_1_point "+JSON.stringify(e)),y.debug("cardinality_2_point "+JSON.stringify(d)),u=e.x,m=e.y,w=d.x,k=d.y}if(t.title!==void 0){let e=i.append("g").attr("class","classLabel"),d=e.append("text").attr("class","label").attr("x",f).attr("y",h).attr("fill","red").attr("text-anchor","middle").text(t.title);window.label=d;let l=d.node().getBBox();e.insert("rect",":first-child").attr("class","box").attr("x",l.x-o.padding/2).attr("y",l.y-o.padding/2).attr("width",l.width+o.padding).attr("height",l.height+o.padding)}y.info("Rendering relation "+JSON.stringify(t)),t.relationTitle1!==void 0&&t.relationTitle1!=="none"&&i.append("g").attr("class","cardinality").append("text").attr("class","type1").attr("x",u).attr("y",m).attr("fill","black").attr("font-size","6").text(t.relationTitle1),t.relationTitle2!==void 0&&t.relationTitle2!=="none"&&i.append("g").attr("class","cardinality").append("text").attr("class","type2").attr("x",w).attr("y",k).attr("fill","black").attr("font-size","6").text(t.relationTitle2),X++},U=function(i,r,t,o){y.debug("Rendering class ",r,t);let p=r.id,g={id:p,label:r.id,width:0,height:0},s=i.append("g").attr("id",o.db.lookUpDomId(p)).attr("class","classGroup"),c;r.link?c=s.append("svg:a").attr("xlink:href",r.link).attr("target",r.linkTarget).append("text").attr("y",t.textHeight+t.padding).attr("x",0):c=s.append("text").attr("y",t.textHeight+t.padding).attr("x",0);let n=!0;r.annotations.forEach(function(d){let l=c.append("tspan").text("\xAB"+d+"\xBB");n||l.attr("dy",t.textHeight),n=!1});let a=$(r),f=c.append("tspan").text(a).attr("class","title");n||f.attr("dy",t.textHeight);let h=c.node().getBBox().height,x,b,u;if(r.members.length>0){x=s.append("line").attr("x1",0).attr("y1",t.padding+h+t.dividerMargin/2).attr("y2",t.padding+h+t.dividerMargin/2);let d=s.append("text").attr("x",t.padding).attr("y",h+t.dividerMargin+t.textHeight).attr("fill","white").attr("class","classText");n=!0,r.members.forEach(function(l){Y(d,l,n,t),n=!1}),b=d.node().getBBox()}if(r.methods.length>0){u=s.append("line").attr("x1",0).attr("y1",t.padding+h+t.dividerMargin+b.height).attr("y2",t.padding+h+t.dividerMargin+b.height);let d=s.append("text").attr("x",t.padding).attr("y",h+2*t.dividerMargin+b.height+t.textHeight).attr("fill","white").attr("class","classText");n=!0,r.methods.forEach(function(l){Y(d,l,n,t),n=!1})}let m=s.node().getBBox();var w=" ";r.cssClasses.length>0&&(w=w+r.cssClasses.join(" "));let e=s.insert("rect",":first-child").attr("x",0).attr("y",0).attr("width",m.width+2*t.padding).attr("height",m.height+t.padding+.5*t.dividerMargin).attr("class",w).node().getBBox().width;return c.node().childNodes.forEach(function(d){d.setAttribute("x",(e-d.getBBox().width)/2)}),r.tooltip&&c.insert("title").text(r.tooltip),x&&x.attr("x2",e),u&&u.attr("x2",e),g.width=e,g.height=m.height+t.padding+.5*t.dividerMargin,g},$=function(i){let r=i.id;return i.type&&(r+="<"+O(i.type)+">"),r},z=function(i,r,t,o){y.debug("Rendering note ",r,t);let p=r.id,g={id:p,text:r.text,width:0,height:0},s=i.append("g").attr("id",p).attr("class","classGroup"),c=s.append("text").attr("y",t.textHeight+t.padding).attr("x",0),n=JSON.parse(`"${r.text}"`).split(`
|
||||
`);n.forEach(function(x){y.debug(`Adding line: ${x}`),c.append("tspan").text(x).attr("class","title").attr("dy",t.textHeight)});let a=s.node().getBBox(),h=s.insert("rect",":first-child").attr("x",0).attr("y",0).attr("width",a.width+2*t.padding).attr("height",a.height+n.length*t.textHeight+t.padding+.5*t.dividerMargin).node().getBBox().width;return c.node().childNodes.forEach(function(x){x.setAttribute("x",(h-x.getBBox().width)/2)}),g.width=h,g.height=a.height+n.length*t.textHeight+t.padding+.5*t.dividerMargin,g},Y=function(i,r,t,o){let{displayText:p,cssStyle:g}=r.getDisplayDetails(),s=i.append("tspan").attr("x",o.padding).text(p);g!==""&&s.attr("style",r.cssStyle),t||s.attr("dy",o.textHeight)},H={getClassTitleString:$,drawClass:U,drawEdge:F,drawNote:z},M={},B=20,L=function(i){let r=Object.entries(M).find(t=>t[1].label===i);if(r)return r[0]},V=function(i){i.append("defs").append("marker").attr("id","extensionStart").attr("class","extension").attr("refX",0).attr("refY",7).attr("markerWidth",190).attr("markerHeight",240).attr("orient","auto").append("path").attr("d","M 1,7 L18,13 V 1 Z"),i.append("defs").append("marker").attr("id","extensionEnd").attr("refX",19).attr("refY",7).attr("markerWidth",20).attr("markerHeight",28).attr("orient","auto").append("path").attr("d","M 1,1 V 13 L18,7 Z"),i.append("defs").append("marker").attr("id","compositionStart").attr("class","extension").attr("refX",0).attr("refY",7).attr("markerWidth",190).attr("markerHeight",240).attr("orient","auto").append("path").attr("d","M 18,7 L9,13 L1,7 L9,1 Z"),i.append("defs").append("marker").attr("id","compositionEnd").attr("refX",19).attr("refY",7).attr("markerWidth",20).attr("markerHeight",28).attr("orient","auto").append("path").attr("d","M 18,7 L9,13 L1,7 L9,1 Z"),i.append("defs").append("marker").attr("id","aggregationStart").attr("class","extension").attr("refX",0).attr("refY",7).attr("markerWidth",190).attr("markerHeight",240).attr("orient","auto").append("path").attr("d","M 18,7 L9,13 L1,7 L9,1 Z"),i.append("defs").append("marker").attr("id","aggregationEnd").attr("refX",19).attr("refY",7).attr("markerWidth",20).attr("markerHeight",28).attr("orient","auto").append("path").attr("d","M 18,7 L9,13 L1,7 L9,1 Z"),i.append("defs").append("marker").attr("id","dependencyStart").attr("class","extension").attr("refX",0).attr("refY",7).attr("markerWidth",190).attr("markerHeight",240).attr("orient","auto").append("path").attr("d","M 5,7 L9,13 L1,7 L9,1 Z"),i.append("defs").append("marker").attr("id","dependencyEnd").attr("refX",19).attr("refY",7).attr("markerWidth",20).attr("markerHeight",28).attr("orient","auto").append("path").attr("d","M 18,7 L9,13 L14,7 L9,1 Z")},q=function(i,r,t,o){let p=S().class;M={},y.info("Rendering diagram "+i);let g=S().securityLevel,s;g==="sandbox"&&(s=E("#i"+r));let c=g==="sandbox"?E(s.nodes()[0].contentDocument.body):E("body"),n=c.select(`[id='${r}']`);V(n);let a=new A({multigraph:!0});a.setGraph({isMultiGraph:!0}),a.setDefaultEdgeLabel(function(){return{}});let f=o.db.getClasses(),h=Object.keys(f);for(let e of h){let d=f[e],l=H.drawClass(n,d,p,o);M[l.id]=l,a.setNode(l.id,l),y.info("Org height: "+l.height)}o.db.getRelations().forEach(function(e){y.info("tjoho"+L(e.id1)+L(e.id2)+JSON.stringify(e)),a.setEdge(L(e.id1),L(e.id2),{relation:e},e.title||"DEFAULT")}),o.db.getNotes().forEach(function(e){y.debug(`Adding note: ${JSON.stringify(e)}`);let d=H.drawNote(n,e,p,o);M[d.id]=d,a.setNode(d.id,d),e.class&&e.class in f&&a.setEdge(e.id,L(e.class),{relation:{id1:e.id,id2:e.class,relation:{type1:"none",type2:"none",lineType:10}}},"DEFAULT")}),W(a),a.nodes().forEach(function(e){e!==void 0&&a.node(e)!==void 0&&(y.debug("Node "+e+": "+JSON.stringify(a.node(e))),c.select("#"+(o.db.lookUpDomId(e)||e)).attr("transform","translate("+(a.node(e).x-a.node(e).width/2)+","+(a.node(e).y-a.node(e).height/2)+" )"))}),a.edges().forEach(function(e){e!==void 0&&a.edge(e)!==void 0&&(y.debug("Edge "+e.v+" -> "+e.w+": "+JSON.stringify(a.edge(e))),H.drawEdge(n,a.edge(e),a.edge(e).relation,p,o))});let u=n.node().getBBox(),m=u.width+B*2,w=u.height+B*2;P(n,w,m,p.useMaxWidth);let k=`${u.x-B} ${u.y-B} ${m} ${w}`;y.debug(`viewBox ${k}`),n.attr("viewBox",k)},K={draw:q},dt={parser:G,db:v,renderer:K,styles:I,init:i=>{i.class||(i.class={}),i.class.arrowMarkerAbsolute=i.arrowMarkerAbsolute,v.clear()}};export{dt as diagram};
|
||||
//# sourceMappingURL=classDiagram-35230388-N7EO2CG2.min.js.map
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,3 @@
|
|||
import{a as R,b as T,c as $}from"./chunk-SG2NF4QM.min.js";import{a as M}from"./chunk-OTWBH354.min.js";import"./chunk-A72RGWO6.min.js";import"./chunk-ICFROH4Y.min.js";import"./chunk-ULAEXCMJ.min.js";import{A as I}from"./chunk-GT3P3F7J.min.js";import{F as S,Ga as d,J as V,La as L,Qa as _,Ra as N,Za as B,b as F,bb as G,c as H,h as g,kb as i}from"./chunk-L5V3YLAC.min.js";import{d as k}from"./chunk-P42HNYSU.min.js";var ot=k(F(),1),lt=k(H(),1),st=k(V(),1);var E=s=>L.sanitizeText(s,i()),D={dividerMargin:10,padding:5,textHeight:10,curve:void 0},W=function(s,e,y,a){let t=Object.keys(s);d.info("keys:",t),d.info(s),t.forEach(function(r){var o,c;let l=s[r],p={shape:"rect",id:l.id,domId:l.domId,labelText:E(l.id),labelStyle:"",style:"fill: none; stroke: black",padding:((o=i().flowchart)==null?void 0:o.padding)??((c=i().class)==null?void 0:c.padding)};e.setNode(l.id,p),P(l.classes,e,y,a,l.id),d.info("setNode",p)})},P=function(s,e,y,a,t){let r=Object.keys(s);d.info("keys:",r),d.info(s),r.filter(o=>s[o].parent==t).forEach(function(o){var c,l;let n=s[o],p=n.cssClasses.join(" "),f=N(n.styles),m=n.label??n.id,u=0,b={labelStyle:f.labelStyle,shape:"class_box",labelText:E(m),classData:n,rx:u,ry:u,class:p,style:f.style,id:n.id,domId:n.domId,tooltip:a.db.getTooltip(n.id,t)||"",haveCallback:n.haveCallback,link:n.link,width:n.type==="group"?500:void 0,type:n.type,padding:((c=i().flowchart)==null?void 0:c.padding)??((l=i().class)==null?void 0:l.padding)};e.setNode(n.id,b),t&&e.setParent(n.id,t),d.info("setNode",b)})},J=function(s,e,y,a){d.info(s),s.forEach(function(t,r){var o,c;let l=t,n="",p={labelStyle:"",style:""},f=l.text,m=0,h={labelStyle:p.labelStyle,shape:"note",labelText:E(f),noteData:l,rx:m,ry:m,class:n,style:p.style,id:l.id,domId:l.id,tooltip:"",type:"note",padding:((o=i().flowchart)==null?void 0:o.padding)??((c=i().class)==null?void 0:c.padding)};if(e.setNode(l.id,h),d.info("setNode",h),!l.class||!(l.class in a))return;let b=y+r,x={id:`edgeNote${b}`,classes:"relation",pattern:"dotted",arrowhead:"none",startLabelRight:"",endLabelLeft:"",arrowTypeStart:"none",arrowTypeEnd:"none",style:"fill:none",labelStyle:"",curve:_(D.curve,S)};e.setEdge(l.id,l.class,x,b)})},K=function(s,e){let y=i().flowchart,a=0;s.forEach(function(t){var r;a++;let o={classes:"relation",pattern:t.relation.lineType==1?"dashed":"solid",id:`id_${t.id1}_${t.id2}_${a}`,arrowhead:t.type==="arrow_open"?"none":"normal",startLabelRight:t.relationTitle1==="none"?"":t.relationTitle1,endLabelLeft:t.relationTitle2==="none"?"":t.relationTitle2,arrowTypeStart:z(t.relation.type1),arrowTypeEnd:z(t.relation.type2),style:"fill:none",labelStyle:"",curve:_(y?.curve,S)};if(d.info(o,t),t.style!==void 0){let c=N(t.style);o.style=c.style,o.labelStyle=c.labelStyle}t.text=t.title,t.text===void 0?t.style!==void 0&&(o.arrowheadStyle="fill: #333"):(o.arrowheadStyle="fill: #333",o.labelpos="c",((r=i().flowchart)==null?void 0:r.htmlLabels)??i().htmlLabels?(o.labelType="html",o.label='<span class="edgeLabel">'+t.text+"</span>"):(o.labelType="text",o.label=t.text.replace(L.lineBreakRegex,`
|
||||
`),t.style===void 0&&(o.style=o.style||"stroke: #333; stroke-width: 1.5px;fill:none"),o.labelStyle=o.labelStyle.replace("color:","fill:"))),e.setEdge(t.id1,t.id2,o,a)})},Q=function(s){D={...D,...s}},U=async function(s,e,y,a){d.info("Drawing class - ",e);let t=i().flowchart??i().class,r=i().securityLevel;d.info("config:",t);let o=t?.nodeSpacing??50,c=t?.rankSpacing??50,l=new I({multigraph:!0,compound:!0}).setGraph({rankdir:a.db.getDirection(),nodesep:o,ranksep:c,marginx:8,marginy:8}).setDefaultEdgeLabel(function(){return{}}),n=a.db.getNamespaces(),p=a.db.getClasses(),f=a.db.getRelations(),m=a.db.getNotes();d.info(f),W(n,l,e,a),P(p,l,e,a),K(f,l),J(m,l,f.length+1,p);let u;r==="sandbox"&&(u=g("#i"+e));let h=r==="sandbox"?g(u.nodes()[0].contentDocument.body):g("body"),b=h.select(`[id="${e}"]`),x=h.select("#"+e+" g");if(await M(x,l,["aggregation","extension","composition","dependency","lollipop"],"classDiagram",e),B.insertTitle(b,"classTitleText",t?.titleTopMargin??5,a.db.getDiagramTitle()),G(l,b,t?.diagramPadding,t?.useMaxWidth),!t?.htmlLabels){let C=r==="sandbox"?u.nodes()[0].contentDocument:document,q=C.querySelectorAll('[id="'+e+'"] .edgeLabel .label');for(let w of q){let A=w.getBBox(),v=C.createElementNS("http://www.w3.org/2000/svg","rect");v.setAttribute("rx",0),v.setAttribute("ry",0),v.setAttribute("width",A.width),v.setAttribute("height",A.height),w.insertBefore(v,w.firstChild)}}};function z(s){let e;switch(s){case 0:e="aggregation";break;case 1:e="extension";break;case 2:e="composition";break;case 3:e="dependency";break;case 4:e="lollipop";break;default:e="none"}return e}var X={setConf:Q,draw:U},it={parser:R,db:T,renderer:X,styles:$,init:s=>{s.class||(s.class={}),s.class.arrowMarkerAbsolute=s.arrowMarkerAbsolute,T.clear()}};export{it as diagram};
|
||||
//# sourceMappingURL=classDiagram-v2-412acd34-BDPFKEQ2.min.js.map
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,2 @@
|
|||
import{g as i,h as p}from"./chunk-VANA6GB5.min.js";import"./chunk-OTWBH354.min.js";import{a as m,b as o}from"./chunk-5R3XQX22.min.js";import"./chunk-A72RGWO6.min.js";import"./chunk-ICFROH4Y.min.js";import"./chunk-ULAEXCMJ.min.js";import"./chunk-GT3P3F7J.min.js";import{J as l,b as a,c as s,lb as e}from"./chunk-L5V3YLAC.min.js";import{d as t}from"./chunk-P42HNYSU.min.js";var g=t(a(),1),n=t(s(),1),c=t(l(),1);var y={parser:m,db:o,renderer:i,styles:p,init:r=>{r.flowchart||(r.flowchart={}),r.flowchart.arrowMarkerAbsolute=r.arrowMarkerAbsolute,e({flowchart:{arrowMarkerAbsolute:r.arrowMarkerAbsolute}}),i.setConf(r.flowchart),o.clear(),o.setGen("gen-2")}};export{y as diagram};
|
||||
//# sourceMappingURL=flowDiagram-v2-49332944-QW7L6YPJ.min.js.map
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"version": 3,
|
||||
"sources": ["../../node_modules/mermaid/dist/flowDiagram-v2-49332944.js"],
|
||||
"sourcesContent": ["import { p as parser, f as flowDb } from \"./flowDb-d35e309a.js\";\nimport { f as flowRendererV2, a as flowStyles } from \"./styles-7383a064.js\";\nimport { p as setConfig } from \"./mermaid-0603ccf8.js\";\nimport \"d3\";\nimport \"dagre-d3-es/src/graphlib/index.js\";\nimport \"./index-8fae9850.js\";\nimport \"dagre-d3-es/src/dagre/index.js\";\nimport \"dagre-d3-es/src/graphlib/json.js\";\nimport \"./edges-d417c7a0.js\";\nimport \"./createText-423428c9.js\";\nimport \"mdast-util-from-markdown\";\nimport \"ts-dedent\";\nimport \"dagre-d3-es/src/dagre-js/label/add-html-label.js\";\nimport \"khroma\";\nimport \"dayjs\";\nimport \"@braintree/sanitize-url\";\nimport \"dompurify\";\nimport \"lodash-es/memoize.js\";\nimport \"lodash-es/merge.js\";\nimport \"stylis\";\nimport \"lodash-es/isEmpty.js\";\nconst diagram = {\n parser,\n db: flowDb,\n renderer: flowRendererV2,\n styles: flowStyles,\n init: (cnf) => {\n if (!cnf.flowchart) {\n cnf.flowchart = {};\n }\n cnf.flowchart.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute;\n setConfig({ flowchart: { arrowMarkerAbsolute: cnf.arrowMarkerAbsolute } });\n flowRendererV2.setConf(cnf.flowchart);\n flowDb.clear();\n flowDb.setGen(\"gen-2\");\n }\n};\nexport {\n diagram\n};\n"],
|
||||
"mappings": "oXAcA,IAAAA,EAAO,SACPC,EAAO,SACPC,EAAO,SAKP,IAAMC,EAAU,CACd,OAAAC,EACA,GAAIC,EACJ,SAAUC,EACV,OAAQC,EACR,KAAOC,GAAQ,CACRA,EAAI,YACPA,EAAI,UAAY,CAAC,GAEnBA,EAAI,UAAU,oBAAsBA,EAAI,oBACxCC,EAAU,CAAE,UAAW,CAAE,oBAAqBD,EAAI,mBAAoB,CAAE,CAAC,EACzEF,EAAe,QAAQE,EAAI,SAAS,EACpCH,EAAO,MAAM,EACbA,EAAO,OAAO,OAAO,CACvB,CACF",
|
||||
"names": ["import_dayjs", "import_sanitize_url", "import_dompurify", "diagram", "parser$1", "flowDb", "flowRendererV2", "flowStyles", "cnf", "setConfig"]
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,8 @@
|
|||
import{Ga as N,J as q,ab as R,b as V,c as X,ob as z}from"./chunk-L5V3YLAC.min.js";import{d as O}from"./chunk-P42HNYSU.min.js";var et=O(V(),1),it=O(X(),1);var st=O(q(),1);var P=function(){var a=function(u,t,e,i){for(e=e||{},i=u.length;i--;e[u[i]]=t);return e},f=[6,9,10],_={trace:function(){},yy:{},symbols_:{error:2,start:3,info:4,document:5,EOF:6,line:7,statement:8,NL:9,showInfo:10,$accept:0,$end:1},terminals_:{2:"error",4:"info",6:"EOF",9:"NL",10:"showInfo"},productions_:[0,[3,3],[5,0],[5,2],[7,1],[7,1],[8,1]],performAction:function(t,e,i,s,r,n,d){switch(n.length-1,r){case 1:return s;case 4:break;case 6:s.setInfo(!0);break}},table:[{3:1,4:[1,2]},{1:[3]},a(f,[2,2],{5:3}),{6:[1,4],7:5,8:6,9:[1,7],10:[1,8]},{1:[2,1]},a(f,[2,3]),a(f,[2,4]),a(f,[2,5]),a(f,[2,6])],defaultActions:{4:[2,1]},parseError:function(t,e){if(e.recoverable)this.trace(t);else{var i=new Error(t);throw i.hash=e,i}},parse:function(t){var e=this,i=[0],s=[],r=[null],n=[],d=this.table,L="",v=0,T=0,Y=2,F=1,D=n.slice.call(arguments,1),o=Object.create(this.lexer),p={yy:{}};for(var E in this.yy)Object.prototype.hasOwnProperty.call(this.yy,E)&&(p.yy[E]=this.yy[E]);o.setInput(t,p.yy),p.yy.lexer=o,p.yy.parser=this,typeof o.yylloc>"u"&&(o.yylloc={});var I=o.yylloc;n.push(I);var M=o.options&&o.options.ranges;typeof p.yy.parseError=="function"?this.parseError=p.yy.parseError:this.parseError=Object.getPrototypeOf(this).parseError;function B(){var y;return y=s.pop()||o.lex()||F,typeof y!="number"&&(y instanceof Array&&(s=y,y=s.pop()),y=e.symbols_[y]||y),y}for(var l,g,h,w,m={},b,c,j,S;;){if(g=i[i.length-1],this.defaultActions[g]?h=this.defaultActions[g]:((l===null||typeof l>"u")&&(l=B()),h=d[g]&&d[g][l]),typeof h>"u"||!h.length||!h[0]){var A="";S=[];for(b in d[g])this.terminals_[b]&&b>Y&&S.push("'"+this.terminals_[b]+"'");o.showPosition?A="Parse error on line "+(v+1)+`:
|
||||
`+o.showPosition()+`
|
||||
Expecting `+S.join(", ")+", got '"+(this.terminals_[l]||l)+"'":A="Parse error on line "+(v+1)+": Unexpected "+(l==F?"end of input":"'"+(this.terminals_[l]||l)+"'"),this.parseError(A,{text:o.match,token:this.terminals_[l]||l,line:o.yylineno,loc:I,expected:S})}if(h[0]instanceof Array&&h.length>1)throw new Error("Parse Error: multiple actions possible at state: "+g+", token: "+l);switch(h[0]){case 1:i.push(l),r.push(o.yytext),n.push(o.yylloc),i.push(h[1]),l=null,T=o.yyleng,L=o.yytext,v=o.yylineno,I=o.yylloc;break;case 2:if(c=this.productions_[h[1]][1],m.$=r[r.length-c],m._$={first_line:n[n.length-(c||1)].first_line,last_line:n[n.length-1].last_line,first_column:n[n.length-(c||1)].first_column,last_column:n[n.length-1].last_column},M&&(m._$.range=[n[n.length-(c||1)].range[0],n[n.length-1].range[1]]),w=this.performAction.apply(m,[L,T,v,p.yy,h[1],r,n].concat(D)),typeof w<"u")return w;c&&(i=i.slice(0,-1*c*2),r=r.slice(0,-1*c),n=n.slice(0,-1*c)),i.push(this.productions_[h[1]][0]),r.push(m.$),n.push(m._$),j=d[i[i.length-2]][i[i.length-1]],i.push(j);break;case 3:return!0}}return!0}},k=function(){var u={EOF:1,parseError:function(e,i){if(this.yy.parser)this.yy.parser.parseError(e,i);else throw new Error(e)},setInput:function(t,e){return this.yy=e||this.yy||{},this._input=t,this._more=this._backtrack=this.done=!1,this.yylineno=this.yyleng=0,this.yytext=this.matched=this.match="",this.conditionStack=["INITIAL"],this.yylloc={first_line:1,first_column:0,last_line:1,last_column:0},this.options.ranges&&(this.yylloc.range=[0,0]),this.offset=0,this},input:function(){var t=this._input[0];this.yytext+=t,this.yyleng++,this.offset++,this.match+=t,this.matched+=t;var e=t.match(/(?:\r\n?|\n).*/g);return e?(this.yylineno++,this.yylloc.last_line++):this.yylloc.last_column++,this.options.ranges&&this.yylloc.range[1]++,this._input=this._input.slice(1),t},unput:function(t){var e=t.length,i=t.split(/(?:\r\n?|\n)/g);this._input=t+this._input,this.yytext=this.yytext.substr(0,this.yytext.length-e),this.offset-=e;var s=this.match.split(/(?:\r\n?|\n)/g);this.match=this.match.substr(0,this.match.length-1),this.matched=this.matched.substr(0,this.matched.length-1),i.length-1&&(this.yylineno-=i.length-1);var r=this.yylloc.range;return this.yylloc={first_line:this.yylloc.first_line,last_line:this.yylineno+1,first_column:this.yylloc.first_column,last_column:i?(i.length===s.length?this.yylloc.first_column:0)+s[s.length-i.length].length-i[0].length:this.yylloc.first_column-e},this.options.ranges&&(this.yylloc.range=[r[0],r[0]+this.yyleng-e]),this.yyleng=this.yytext.length,this},more:function(){return this._more=!0,this},reject:function(){if(this.options.backtrack_lexer)this._backtrack=!0;else return this.parseError("Lexical error on line "+(this.yylineno+1)+`. You can only invoke reject() in the lexer when the lexer is of the backtracking persuasion (options.backtrack_lexer = true).
|
||||
`+this.showPosition(),{text:"",token:null,line:this.yylineno});return this},less:function(t){this.unput(this.match.slice(t))},pastInput:function(){var t=this.matched.substr(0,this.matched.length-this.match.length);return(t.length>20?"...":"")+t.substr(-20).replace(/\n/g,"")},upcomingInput:function(){var t=this.match;return t.length<20&&(t+=this._input.substr(0,20-t.length)),(t.substr(0,20)+(t.length>20?"...":"")).replace(/\n/g,"")},showPosition:function(){var t=this.pastInput(),e=new Array(t.length+1).join("-");return t+this.upcomingInput()+`
|
||||
`+e+"^"},test_match:function(t,e){var i,s,r;if(this.options.backtrack_lexer&&(r={yylineno:this.yylineno,yylloc:{first_line:this.yylloc.first_line,last_line:this.last_line,first_column:this.yylloc.first_column,last_column:this.yylloc.last_column},yytext:this.yytext,match:this.match,matches:this.matches,matched:this.matched,yyleng:this.yyleng,offset:this.offset,_more:this._more,_input:this._input,yy:this.yy,conditionStack:this.conditionStack.slice(0),done:this.done},this.options.ranges&&(r.yylloc.range=this.yylloc.range.slice(0))),s=t[0].match(/(?:\r\n?|\n).*/g),s&&(this.yylineno+=s.length),this.yylloc={first_line:this.yylloc.last_line,last_line:this.yylineno+1,first_column:this.yylloc.last_column,last_column:s?s[s.length-1].length-s[s.length-1].match(/\r?\n?/)[0].length:this.yylloc.last_column+t[0].length},this.yytext+=t[0],this.match+=t[0],this.matches=t,this.yyleng=this.yytext.length,this.options.ranges&&(this.yylloc.range=[this.offset,this.offset+=this.yyleng]),this._more=!1,this._backtrack=!1,this._input=this._input.slice(t[0].length),this.matched+=t[0],i=this.performAction.call(this,this.yy,this,e,this.conditionStack[this.conditionStack.length-1]),this.done&&this._input&&(this.done=!1),i)return i;if(this._backtrack){for(var n in r)this[n]=r[n];return!1}return!1},next:function(){if(this.done)return this.EOF;this._input||(this.done=!0);var t,e,i,s;this._more||(this.yytext="",this.match="");for(var r=this._currentRules(),n=0;n<r.length;n++)if(i=this._input.match(this.rules[r[n]]),i&&(!e||i[0].length>e[0].length)){if(e=i,s=n,this.options.backtrack_lexer){if(t=this.test_match(i,r[n]),t!==!1)return t;if(this._backtrack){e=!1;continue}else return!1}else if(!this.options.flex)break}return e?(t=this.test_match(e,r[s]),t!==!1?t:!1):this._input===""?this.EOF:this.parseError("Lexical error on line "+(this.yylineno+1)+`. Unrecognized text.
|
||||
`+this.showPosition(),{text:"",token:null,line:this.yylineno})},lex:function(){var e=this.next();return e||this.lex()},begin:function(e){this.conditionStack.push(e)},popState:function(){var e=this.conditionStack.length-1;return e>0?this.conditionStack.pop():this.conditionStack[0]},_currentRules:function(){return this.conditionStack.length&&this.conditionStack[this.conditionStack.length-1]?this.conditions[this.conditionStack[this.conditionStack.length-1]].rules:this.conditions.INITIAL.rules},topState:function(e){return e=this.conditionStack.length-1-Math.abs(e||0),e>=0?this.conditionStack[e]:"INITIAL"},pushState:function(e){this.begin(e)},stateStackSize:function(){return this.conditionStack.length},options:{"case-insensitive":!0},performAction:function(e,i,s,r){switch(s){case 0:return 4;case 1:return 9;case 2:return"space";case 3:return 10;case 4:return 6;case 5:return"TXT"}},rules:[/^(?:info\b)/i,/^(?:[\s\n\r]+)/i,/^(?:[\s]+)/i,/^(?:showInfo\b)/i,/^(?:$)/i,/^(?:.)/i],conditions:{INITIAL:{rules:[0,1,2,3,4,5],inclusive:!0}}};return u}();_.lexer=k;function x(){this.yy={}}return x.prototype=_,_.Parser=x,new x}();P.parser=P;var C=P,U={info:!1},$=U.info,G=a=>{$=a},H=()=>$,J=()=>{$=U.info},K={clear:J,setInfo:G,getInfo:H},Q=(a,f,_)=>{N.debug(`rendering info diagram
|
||||
`+a);let k=z(f);R(k,100,400,!0),k.append("g").append("text").attr("x",100).attr("y",40).attr("class","version").attr("font-size",32).style("text-anchor","middle").text(`v${_}`)},W={draw:Q},rt={parser:C,db:K,renderer:W};export{rt as diagram};
|
||||
//# sourceMappingURL=infoDiagram-db7b18fc-YOV6PY3Q.min.js.map
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,22 @@
|
|||
import{b as B}from"./chunk-P42HNYSU.min.js";var D=B((l,p)=>{(function(i,r){typeof define=="function"&&define.amd?define(r):typeof l=="object"?p.exports=r():r()(i.lunr)})(l,function(){return function(i){if(typeof i>"u")throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(typeof i.stemmerSupport>"u")throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");i.da=function(){this.pipeline.reset(),this.pipeline.add(i.da.trimmer,i.da.stopWordFilter,i.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(i.da.stemmer))},i.da.wordCharacters="A-Za-z\xAA\xBA\xC0-\xD6\xD8-\xF6\xF8-\u02B8\u02E0-\u02E4\u1D00-\u1D25\u1D2C-\u1D5C\u1D62-\u1D65\u1D6B-\u1D77\u1D79-\u1DBE\u1E00-\u1EFF\u2071\u207F\u2090-\u209C\u212A\u212B\u2132\u214E\u2160-\u2188\u2C60-\u2C7F\uA722-\uA787\uA78B-\uA7AD\uA7B0-\uA7B7\uA7F7-\uA7FF\uAB30-\uAB5A\uAB5C-\uAB64\uFB00-\uFB06\uFF21-\uFF3A\uFF41-\uFF5A",i.da.trimmer=i.trimmerSupport.generateTrimmer(i.da.wordCharacters),i.Pipeline.registerFunction(i.da.trimmer,"trimmer-da"),i.da.stemmer=function(){var r=i.stemmerSupport.Among,g=i.stemmerSupport.SnowballProgram,u=new function(){var o=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],h=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],b=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("l\xF8st",-1,2)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],v=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],c,n,m,e=new g;this.setCurrent=function(t){e.setCurrent(t)},this.getCurrent=function(){return e.getCurrent()};function k(){var t,s=e.cursor+3;if(n=e.limit,0<=s&&s<=e.limit){for(c=s;;){if(t=e.cursor,e.in_grouping(d,97,248)){e.cursor=t;break}if(e.cursor=t,t>=e.limit)return;e.cursor++}for(;!e.out_grouping(d,97,248);){if(e.cursor>=e.limit)return;e.cursor++}n=e.cursor,n<c&&(n=c)}}function F(){var t,s;if(e.cursor>=n&&(s=e.limit_backward,e.limit_backward=n,e.ket=e.cursor,t=e.find_among_b(o,32),e.limit_backward=s,t))switch(e.bra=e.cursor,t){case 1:e.slice_del();break;case 2:e.in_grouping_b(v,97,229)&&e.slice_del();break}}function w(){var t=e.limit-e.cursor,s;e.cursor>=n&&(s=e.limit_backward,e.limit_backward=n,e.ket=e.cursor,e.find_among_b(h,4)?(e.bra=e.cursor,e.limit_backward=s,e.cursor=e.limit-t,e.cursor>e.limit_backward&&(e.cursor--,e.bra=e.cursor,e.slice_del())):e.limit_backward=s)}function A(){var t,s=e.limit-e.cursor,_,f;if(e.ket=e.cursor,e.eq_s_b(2,"st")&&(e.bra=e.cursor,e.eq_s_b(2,"ig")&&e.slice_del()),e.cursor=e.limit-s,e.cursor>=n&&(_=e.limit_backward,e.limit_backward=n,e.ket=e.cursor,t=e.find_among_b(b,5),e.limit_backward=_,t))switch(e.bra=e.cursor,t){case 1:e.slice_del(),f=e.limit-e.cursor,w(),e.cursor=e.limit-f;break;case 2:e.slice_from("l\xF8s");break}}function C(){var t;e.cursor>=n&&(t=e.limit_backward,e.limit_backward=n,e.ket=e.cursor,e.out_grouping_b(d,97,248)?(e.bra=e.cursor,m=e.slice_to(m),e.limit_backward=t,e.eq_v_b(m)&&e.slice_del()):e.limit_backward=t)}this.stem=function(){var t=e.cursor;return k(),e.limit_backward=t,e.cursor=e.limit,F(),e.cursor=e.limit,w(),e.cursor=e.limit,A(),e.cursor=e.limit,C(),!0}};return function(a){return typeof a.update=="function"?a.update(function(o){return u.setCurrent(o),u.stem(),u.getCurrent()}):(u.setCurrent(a),u.stem(),u.getCurrent())}}(),i.Pipeline.registerFunction(i.da.stemmer,"stemmer-da"),i.da.stopWordFilter=i.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu n\xE5r og ogs\xE5 om op os over p\xE5 selv sig sin sine sit skal skulle som s\xE5dan thi til ud under var vi vil ville vor v\xE6re v\xE6ret".split(" ")),i.Pipeline.registerFunction(i.da.stopWordFilter,"stopWordFilter-da")}})});export default D();
|
||||
/*! Bundled license information:
|
||||
|
||||
lunr-languages/lunr.da.js:
|
||||
(*!
|
||||
* Lunr languages, `Danish` language
|
||||
* https://github.com/MihaiValentin/lunr-languages
|
||||
*
|
||||
* Copyright 2014, Mihai Valentin
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
(*!
|
||||
* based on
|
||||
* Snowball JavaScript Library v0.3
|
||||
* http://code.google.com/p/urim/
|
||||
* http://snowball.tartarus.org/
|
||||
*
|
||||
* Copyright 2010, Oleg Mazko
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
*/
|
||||
//# sourceMappingURL=lunr.da-WZCDGCDT.min.js.map
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,22 @@
|
|||
import{b as o}from"./chunk-P42HNYSU.min.js";var s=o((i,r)=>{(function(e,t){typeof define=="function"&&define.amd?define(t):typeof i=="object"?r.exports=t():t()(e.lunr)})(i,function(){return function(e){if(typeof e>"u")throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(typeof e.stemmerSupport>"u")throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.hy=function(){this.pipeline.reset(),this.pipeline.add(e.hy.trimmer,e.hy.stopWordFilter)},e.hy.wordCharacters="[A-Za-z\u0530-\u058F\uFB00-\uFB4F]",e.hy.trimmer=e.trimmerSupport.generateTrimmer(e.hy.wordCharacters),e.Pipeline.registerFunction(e.hy.trimmer,"trimmer-hy"),e.hy.stopWordFilter=e.generateStopWordFilter("\u0564\u0578\u0582 \u0587 \u0565\u0584 \u0567\u056B\u0580 \u0567\u056B\u0584 \u0570\u0565\u057F\u0578 \u0576\u0561\u0587 \u0576\u0580\u0561\u0576\u0584 \u0578\u0580\u0568 \u057E\u0580\u0561 \u0567 \u0578\u0580 \u057A\u056B\u057F\u056B \u0565\u0576 \u0561\u0575\u057D \u0574\u0565\u057B \u0576 \u056B\u0580 \u0578\u0582 \u056B \u0561\u0575\u0564 \u0578\u0580\u0578\u0576\u0584 \u0561\u0575\u0576 \u056F\u0561\u0574 \u0567\u0580 \u0574\u056B \u0565\u057D \u0570\u0561\u0574\u0561\u0580 \u0561\u0575\u056C \u056B\u057D\u056F \u0567\u056B\u0576 \u0565\u0576\u0584 \u0570\u0565\u057F \u056B\u0576 \u0569 \u0567\u056B\u0576\u0584 \u0574\u0565\u0576\u0584 \u0576\u0580\u0561 \u0576\u0561 \u0564\u0578\u0582\u0584 \u0565\u0574 \u0567\u056B \u0568\u057D\u057F \u0578\u0580\u057A\u0565\u057D \u0578\u0582\u0574".split(" ")),e.Pipeline.registerFunction(e.hy.stopWordFilter,"stopWordFilter-hy"),e.hy.stemmer=function(){return function(t){return typeof t.update=="function"?t.update(function(n){return n}):t}}(),e.Pipeline.registerFunction(e.hy.stemmer,"stemmer-hy")}})});export default s();
|
||||
/*! Bundled license information:
|
||||
|
||||
lunr-languages/lunr.hy.js:
|
||||
(*!
|
||||
* Lunr languages, `Armenian` language
|
||||
* https://github.com/turbobit/lunr-languages
|
||||
*
|
||||
* Copyright 2021, Manikandan Venkatasubban
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
(*!
|
||||
* based on
|
||||
* Snowball JavaScript Library v0.3
|
||||
* http://code.google.com/p/urim/
|
||||
* http://snowball.tartarus.org/
|
||||
*
|
||||
* Copyright 2010, Oleg Mazko
|
||||
* http://www.mozilla.org/MPL/
|
||||
*)
|
||||
*/
|
||||
//# sourceMappingURL=lunr.hy-XFQCAWFO.min.js.map
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue