<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>I have a dream and wrote it down as spec:<br>
</p>
<p><a class="moz-txt-link-freetext" href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md">https://github.com/guettli/directory-index-file-spec/blob/master/README.md</a></p>
<p><br>
</p>
<p>Feedback is welcome<br>
</p>
<h1><br>
</h1>
<h1>directory-index-file-spec</h1>
<h2><a id="user-content-intro" class="anchor"
href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md#intro"><svg
class="octicon octicon-link" viewBox="0 0 16 16" width="16"
height="16"></svg></a></h2>
<h2>Intro</h2>
<p>This spec describes a simple way to give a directory an index
file. This index file can be used to create a preview of this
directory.</p>
<p>It can be used for a preview if you use a cloud storage like
nextcloud or seafile. Or it can be used as preview on the desktop.</p>
<h2><a id="user-content-supported-formats" class="anchor"
href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md#supported-formats"><svg
class="octicon octicon-link" viewBox="0 0 16 16" width="16"
height="16"></svg></a></h2>
<h2>Supported formats</h2>
<p>The index file can have one of these names:</p>
<ul>
<li>index.html</li>
<li>index.txt</li>
<li>index.md</li>
</ul>
<p>The file ending has this meaning:</p>
<ul>
<li>html: HTML file</li>
<li>txt: utf8 text file</li>
<li>md: Markdown markup language</li>
</ul>
<h2><a id="user-content-support-in-full-text-search" class="anchor"
href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md#support-in-full-text-search"><svg
class="octicon octicon-link" viewBox="0 0 16 16" width="16"
height="16"></svg></a></h2>
<h2>Support in full text search</h2>
<p>If the system which contains a directory "foo-dir" with an
index-file "index.X" (X can be one of the supported endings) does
provide a full text search, then the text in the index file should
be indexed. If a search term matches a term in the index-file,
then the match should mean 'you have found directory "foo-dir"'
and not "you have found the file index.X".</p>
<p>The content of the index file should be rendered above the other
files in this directory.</p>
<h2><a id="user-content-hashtag-support" class="anchor"
href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md#hashtag-support"><svg
class="octicon octicon-link" viewBox="0 0 16 16" width="16"
height="16"></svg></a></h2>
<h2>#hashtag support</h2>
<p>Words in this file which start with the hashtag sign (#) should
be treated like hashtags.</p>
<p>Hashtags should be rendered and act like hyperlinks. If a user
clicks on a hashtag, the user should be able to see the other
index files which have this hashtag.</p>
<h2><a id="user-content-example-usecase" class="anchor"
href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md#example-usecase"><svg
class="octicon octicon-link" viewBox="0 0 16 16" width="16"
height="16"></svg></a></h2>
<h2>Example usecase</h2>
<p>UseCase: A user stores his images in a directory tree according
to this format: YYYY/YYYY-MM/YYYY-MM-DD/ (Y means year, M means
month, D means day)</p>
<p>A concrete index file could be: 2018/2018-12/2018-12-31/index.txt</p>
<p>The content of this could could be:</p>
<pre><code>Celebrating new year with #Peter and #Mary.
</code></pre>
<p>There is an other index file like this:
2019/2019-02/2019-02-03/index.txt with this content:</p>
<pre><code>Cooking with #Peter
</code></pre>
<p>The user interface should provide a simple way to navigate
through the files which have the same hashtag.</p>
<p>In this example both files have the hashtag #Peter.</p>
<h2><a id="user-content-where-i-would-like-to-see-this-implemented"
class="anchor"
href="https://github.com/guettli/directory-index-file-spec/blob/master/README.md#where-i-would-like-to-see-this-implemented"><svg
class="octicon octicon-link" viewBox="0 0 16 16" width="16"
height="16"></svg></a></h2>
<h2>Where I would like to see this implemented</h2>
<p>I would like to see this implemented in my favorite tools:</p>
<ul>
<li>GNOME Desktop Environment</li>
<li>Nextcloud: open file hosting</li>
</ul>
<p><br>
</p>
<pre class="moz-signature" cols="72">--
Thomas Guettler <a class="moz-txt-link-freetext" href="http://www.thomas-guettler.de/">http://www.thomas-guettler.de/</a>
I am looking for feedback: <a class="moz-txt-link-freetext" href="https://github.com/guettli/programming-guidelines">https://github.com/guettli/programming-guidelines</a></pre>
</body>
</html>