Updated documentation
[meviz.git] / doc / index.html
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 <head>
6 <!-- 2022-03-29 Tue 18:11 -->
7 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 <title>MeWiz - Media Wizard</title>
10 <meta name="generator" content="Org mode" />
11 <meta name="author" content="Svjatoslav Agejenko" />
12 <style type="text/css">
13  <!--/*--><![CDATA[/*><!--*/
14   .title  { text-align: center;
15              margin-bottom: .2em; }
16   .subtitle { text-align: center;
17               font-size: medium;
18               font-weight: bold;
19               margin-top:0; }
20   .todo   { font-family: monospace; color: red; }
21   .done   { font-family: monospace; color: green; }
22   .priority { font-family: monospace; color: orange; }
23   .tag    { background-color: #eee; font-family: monospace;
24             padding: 2px; font-size: 80%; font-weight: normal; }
25   .timestamp { color: #bebebe; }
26   .timestamp-kwd { color: #5f9ea0; }
27   .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
28   .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
29   .org-center { margin-left: auto; margin-right: auto; text-align: center; }
30   .underline { text-decoration: underline; }
31   #postamble p, #preamble p { font-size: 90%; margin: .2em; }
32   p.verse { margin-left: 3%; }
33   pre {
34     border: 1px solid #ccc;
35     box-shadow: 3px 3px 3px #eee;
36     padding: 8pt;
37     font-family: monospace;
38     overflow: auto;
39     margin: 1.2em;
40   }
41   pre.src {
42     position: relative;
43     overflow: auto;
44     padding-top: 1.2em;
45   }
46   pre.src:before {
47     display: none;
48     position: absolute;
49     background-color: white;
50     top: -10px;
51     right: 10px;
52     padding: 3px;
53     border: 1px solid black;
54   }
55   pre.src:hover:before { display: inline; margin-top: 14px;}
56   /* Languages per Org manual */
57   pre.src-asymptote:before { content: 'Asymptote'; }
58   pre.src-awk:before { content: 'Awk'; }
59   pre.src-C:before { content: 'C'; }
60   /* pre.src-C++ doesn't work in CSS */
61   pre.src-clojure:before { content: 'Clojure'; }
62   pre.src-css:before { content: 'CSS'; }
63   pre.src-D:before { content: 'D'; }
64   pre.src-ditaa:before { content: 'ditaa'; }
65   pre.src-dot:before { content: 'Graphviz'; }
66   pre.src-calc:before { content: 'Emacs Calc'; }
67   pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
68   pre.src-fortran:before { content: 'Fortran'; }
69   pre.src-gnuplot:before { content: 'gnuplot'; }
70   pre.src-haskell:before { content: 'Haskell'; }
71   pre.src-hledger:before { content: 'hledger'; }
72   pre.src-java:before { content: 'Java'; }
73   pre.src-js:before { content: 'Javascript'; }
74   pre.src-latex:before { content: 'LaTeX'; }
75   pre.src-ledger:before { content: 'Ledger'; }
76   pre.src-lisp:before { content: 'Lisp'; }
77   pre.src-lilypond:before { content: 'Lilypond'; }
78   pre.src-lua:before { content: 'Lua'; }
79   pre.src-matlab:before { content: 'MATLAB'; }
80   pre.src-mscgen:before { content: 'Mscgen'; }
81   pre.src-ocaml:before { content: 'Objective Caml'; }
82   pre.src-octave:before { content: 'Octave'; }
83   pre.src-org:before { content: 'Org mode'; }
84   pre.src-oz:before { content: 'OZ'; }
85   pre.src-plantuml:before { content: 'Plantuml'; }
86   pre.src-processing:before { content: 'Processing.js'; }
87   pre.src-python:before { content: 'Python'; }
88   pre.src-R:before { content: 'R'; }
89   pre.src-ruby:before { content: 'Ruby'; }
90   pre.src-sass:before { content: 'Sass'; }
91   pre.src-scheme:before { content: 'Scheme'; }
92   pre.src-screen:before { content: 'Gnu Screen'; }
93   pre.src-sed:before { content: 'Sed'; }
94   pre.src-sh:before { content: 'shell'; }
95   pre.src-sql:before { content: 'SQL'; }
96   pre.src-sqlite:before { content: 'SQLite'; }
97   /* additional languages in org.el's org-babel-load-languages alist */
98   pre.src-forth:before { content: 'Forth'; }
99   pre.src-io:before { content: 'IO'; }
100   pre.src-J:before { content: 'J'; }
101   pre.src-makefile:before { content: 'Makefile'; }
102   pre.src-maxima:before { content: 'Maxima'; }
103   pre.src-perl:before { content: 'Perl'; }
104   pre.src-picolisp:before { content: 'Pico Lisp'; }
105   pre.src-scala:before { content: 'Scala'; }
106   pre.src-shell:before { content: 'Shell Script'; }
107   pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
108   /* additional language identifiers per "defun org-babel-execute"
109        in ob-*.el */
110   pre.src-cpp:before  { content: 'C++'; }
111   pre.src-abc:before  { content: 'ABC'; }
112   pre.src-coq:before  { content: 'Coq'; }
113   pre.src-groovy:before  { content: 'Groovy'; }
114   /* additional language identifiers from org-babel-shell-names in
115      ob-shell.el: ob-shell is the only babel language using a lambda to put
116      the execution function name together. */
117   pre.src-bash:before  { content: 'bash'; }
118   pre.src-csh:before  { content: 'csh'; }
119   pre.src-ash:before  { content: 'ash'; }
120   pre.src-dash:before  { content: 'dash'; }
121   pre.src-ksh:before  { content: 'ksh'; }
122   pre.src-mksh:before  { content: 'mksh'; }
123   pre.src-posh:before  { content: 'posh'; }
124   /* Additional Emacs modes also supported by the LaTeX listings package */
125   pre.src-ada:before { content: 'Ada'; }
126   pre.src-asm:before { content: 'Assembler'; }
127   pre.src-caml:before { content: 'Caml'; }
128   pre.src-delphi:before { content: 'Delphi'; }
129   pre.src-html:before { content: 'HTML'; }
130   pre.src-idl:before { content: 'IDL'; }
131   pre.src-mercury:before { content: 'Mercury'; }
132   pre.src-metapost:before { content: 'MetaPost'; }
133   pre.src-modula-2:before { content: 'Modula-2'; }
134   pre.src-pascal:before { content: 'Pascal'; }
135   pre.src-ps:before { content: 'PostScript'; }
136   pre.src-prolog:before { content: 'Prolog'; }
137   pre.src-simula:before { content: 'Simula'; }
138   pre.src-tcl:before { content: 'tcl'; }
139   pre.src-tex:before { content: 'TeX'; }
140   pre.src-plain-tex:before { content: 'Plain TeX'; }
141   pre.src-verilog:before { content: 'Verilog'; }
142   pre.src-vhdl:before { content: 'VHDL'; }
143   pre.src-xml:before { content: 'XML'; }
144   pre.src-nxml:before { content: 'XML'; }
145   /* add a generic configuration mode; LaTeX export needs an additional
146      (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
147   pre.src-conf:before { content: 'Configuration File'; }
148
149   table { border-collapse:collapse; }
150   caption.t-above { caption-side: top; }
151   caption.t-bottom { caption-side: bottom; }
152   td, th { vertical-align:top;  }
153   th.org-right  { text-align: center;  }
154   th.org-left   { text-align: center;   }
155   th.org-center { text-align: center; }
156   td.org-right  { text-align: right;  }
157   td.org-left   { text-align: left;   }
158   td.org-center { text-align: center; }
159   dt { font-weight: bold; }
160   .footpara { display: inline; }
161   .footdef  { margin-bottom: 1em; }
162   .figure { padding: 1em; }
163   .figure p { text-align: center; }
164   .equation-container {
165     display: table;
166     text-align: center;
167     width: 100%;
168   }
169   .equation {
170     vertical-align: middle;
171   }
172   .equation-label {
173     display: table-cell;
174     text-align: right;
175     vertical-align: middle;
176   }
177   .inlinetask {
178     padding: 10px;
179     border: 2px solid gray;
180     margin: 10px;
181     background: #ffffcc;
182   }
183   #org-div-home-and-up
184    { text-align: right; font-size: 70%; white-space: nowrap; }
185   textarea { overflow-x: auto; }
186   .linenr { font-size: smaller }
187   .code-highlighted { background-color: #ffff00; }
188   .org-info-js_info-navigation { border-style: none; }
189   #org-info-js_console-label
190     { font-size: 10px; font-weight: bold; white-space: nowrap; }
191   .org-info-js_search-highlight
192     { background-color: #ffff00; color: #000000; font-weight: bold; }
193   .org-svg { width: 90%; }
194   /*]]>*/-->
195 </style>
196 <link rel="stylesheet" type="text/css" href="https://thomasf.github.io/solarized-css/solarized-dark.min.css" />
197 <script type="text/javascript">
198 // @license magnet:?xt=urn:btih:e95b018ef3580986a04669f1b5879592219e2a7a&dn=public-domain.txt Public Domain
199 <!--/*--><![CDATA[/*><!--*/
200      function CodeHighlightOn(elem, id)
201      {
202        var target = document.getElementById(id);
203        if(null != target) {
204          elem.classList.add("code-highlighted");
205          target.classList.add("code-highlighted");
206        }
207      }
208      function CodeHighlightOff(elem, id)
209      {
210        var target = document.getElementById(id);
211        if(null != target) {
212          elem.classList.remove("code-highlighted");
213          target.classList.remove("code-highlighted");
214        }
215      }
216     /*]]>*///-->
217 // @license-end
218 </script>
219 </head>
220 <body>
221 <div id="content">
222 <h1 class="title">MeWiz - Media Wizard</h1>
223 <div id="table-of-contents">
224 <h2>Table of Contents</h2>
225 <div id="text-table-of-contents">
226 <ul>
227 <li><a href="#org8fef3f6">1. General</a>
228 <ul>
229 <li><a href="#orgdb7f89c">1.1. Source code</a></li>
230 </ul>
231 </li>
232 <li><a href="#org1fdf04d">2. Introduction</a></li>
233 <li><a href="#org0a08853">3. Installation</a></li>
234 <li><a href="#orgf555c42">4. Usage</a>
235 <ul>
236 <li><a href="#orge5a4f8a">4.1. To generate or update existing image gallery</a></li>
237 </ul>
238 </li>
239 </ul>
240 </div>
241 </div>
242
243 <div id="outline-container-org8fef3f6" class="outline-2">
244 <h2 id="org8fef3f6"><span class="section-number-2">1</span> General</h2>
245 <div class="outline-text-2" id="text-1">
246 <ul class="org-ul">
247 <li>This program is free software: released under Creative Commons Zero
248 (CC0) license</li>
249
250 <li>Program author:
251 <ul class="org-ul">
252 <li>Svjatoslav Agejenko</li>
253 <li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a></li>
254 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a></li>
255 </ul></li>
256
257 <li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a></li>
258 </ul>
259 </div>
260
261 <div id="outline-container-orgdb7f89c" class="outline-3">
262 <h3 id="orgdb7f89c"><span class="section-number-3">1.1</span> Source code</h3>
263 <div class="outline-text-3" id="text-1-1">
264 <ul class="org-ul">
265 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
266 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=summary">Browse Git repository online</a></li>
267
268 <li><p>
269 Clone Git repository using command:
270 </p>
271 <pre class="example">
272 git clone https://www2.svjatoslav.eu/git/meviz.git
273 </pre></li>
274 </ul>
275 </div>
276 </div>
277 </div>
278
279 <div id="outline-container-org1fdf04d" class="outline-2">
280 <h2 id="org1fdf04d"><span class="section-number-2">2</span> Introduction</h2>
281 <div class="outline-text-2" id="text-2">
282 <p>
283 The idea is to have something like a Swiss army knife of various tools
284 for audio, video, photo editing/conversion.
285 </p>
286
287
288 <p>
289 Current functionality:
290 </p>
291
292 <ul class="org-ul">
293 <li>Acts as unified frontend for linux commandline tools for audio,
294 video and photo conversion.</li>
295
296 <li>Generates HTML listing for directory content with image thumbnails
297 and embedded video player.</li>
298
299 <li>Batch file rename.</li>
300 </ul>
301 </div>
302 </div>
303
304
305 <div id="outline-container-org0a08853" class="outline-2">
306 <h2 id="org0a08853"><span class="section-number-2">3</span> Installation</h2>
307 <div class="outline-text-2" id="text-3">
308 <p>
309 Study and run installer script:
310 </p>
311 <pre class="example">
312 install
313 </pre>
314 </div>
315 </div>
316
317
318 <div id="outline-container-orgf555c42" class="outline-2">
319 <h2 id="orgf555c42"><span class="section-number-2">4</span> Usage</h2>
320 <div class="outline-text-2" id="text-4">
321 </div>
322 <div id="outline-container-orge5a4f8a" class="outline-3">
323 <h3 id="orge5a4f8a"><span class="section-number-3">4.1</span> To generate or update existing image gallery</h3>
324 <div class="outline-text-3" id="text-4-1">
325 <ol class="org-ol">
326 <li>Using terminal, navigate to desired destination directory.</li>
327 <li><p>
328 Issue command:
329 </p>
330 <pre class="example">
331 meviz index
332 </pre></li>
333 </ol>
334
335 <p>
336 If there is existing image gallery, then <b>meviz</b> only generates
337 thumbnails for new images if needed. Old thumbnails that are no longer
338 needed are removed automatically. Idea is that it must be
339 computationally cheap to update gallery incrementally.
340 </p>
341 </div>
342 </div>
343 </div>
344 </div>
345 <div id="postamble" class="status">
346 <p class="author">Author: Svjatoslav Agejenko</p>
347 <p class="date">Created: 2022-03-29 Tue 18:11</p>
348 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
349 </div>
350 </body>
351 </html>