Update documentation - increase Doxygen usage
[geeqie.git] / web / help / GuideImageManagementRename.html
diff --git a/web/help/GuideImageManagementRename.html b/web/help/GuideImageManagementRename.html
deleted file mode 100644 (file)
index 855263f..0000000
+++ /dev/null
@@ -1,554 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Rename</title>
-<link rel="previous" href="GuideImageManagementCopyMove.html" title="Copy and Move">
-<link rel="next" href="GuideImageManagementDelete.html" title="Delete">
-<link rel="top" href="GuideIndex.html" title="The Geeqie User Manual">
-<style type="text/css">
-
-html { height: 100%; }
-body {
-  margin: 0px; padding: 12px;
-  background-color: #f9f9f6;
-  min-height: 100%;
-  direction: ltr;
-}
-div, p, pre, blockquote { margin: 0; padding: 0; }
-p img { vertical-align: middle; }
-sub { font-size: 0.83em; }
-sub sub { font-size: 1em; }
-sup { font-size: 0.83em; }
-sup sup { font-size: 1em; }
-table { border-collapse: collapse; }
-table.table-pgwide { width: 100%; }
-td { vertical-align: top; }
-td { padding: 0.2em 0.83em 0.2em 0.83em; }
-th { padding: 0 0.83em 0 0.83em; }
-tr.tr-shade {
-  background-color: #f9f9f6;
-}
-td.td-colsep { border-right: solid 1px; }
-td.td-rowsep { border-bottom: solid 1px; }
-thead { border-top: solid 2px; border-bottom: solid 2px; }
-tfoot { border-top: solid 2px; border-bottom: solid 2px; }
-div.body {
-  padding: 1em;
-  max-width: 60em;
-  background-color: #ffffff;
-  border: solid 1px #e0e0df;
-}
-div.body-sidebar {
-  margin-right: 13em;
-}
-div.division div.division { margin-top: 1.72em; }
-div.division div.division div.division { margin-top: 1.44em; }
-div.header {
-  margin: 0;
-  color: #3f3f3f;
-  border-bottom: solid 1px #e0e0df;
-}
-h1, h2, h3, h4, h5, h6, h7 {
-  margin: 0; padding: 0;
-  color: #3f3f3f;
-}
-h1.title { font-size: 1.72em; }
-h2.title { font-size: 1.44em; }
-h3.title { font-size: 1.2em; }
-h4.title, h5.title, h6.title, h7.title { font-size: 1em; }
-.block { margin-top: 1em; }
-.block .block-first { margin-top: 0; }
-.block-indent {
-  margin-left left: 1.72em;
-  margin-: 1em;
-}
-.block-indent .block-indent { margin-left: 0em; margin-right: 0em; }
-td .block-indent  { margin-left: 0em; margin-right: 0em; }
-dd .block-indent  { margin-left: 0em; margin-right: 0em; }
-.block-verbatim { white-space: pre; }
-div.title {
-  margin-bottom: 0.2em;
-  font-weight: bold;
-  color: #3f3f3f;
-}
-div.title-formal { padding-left: 0.2em; padding-right: 0.2em; }
-div.title-formal .label { font-weight: normal; }
-a {
-  color: #1f609f;
-  text-decoration: none;
-}
-a:hover { text-decoration: underline; }
-a:visited { color: #9f1f6f; }
-ul, ol, dl { margin: 0; padding: 0; }
-li {
-  margin-top: 1em;
-  margin-left: 2.4em;
-  padding: 0;
-}
-li.li-first { margin-top: 0; }
-dt { margin: 1em 0 0 0; }
-dt.dt-first { margin: 0; }
-dd {
-  margin-left: 1.72em;
-  margin-top: 0.5em;
-}
-dl.dl-compact dt { margin-top: 0; }
-dl.dl-compact dd { margin-top: 0; margin-bottom: 0; }
-
-
-ul.linktrail {
-  display: block;
-  margin: 0.2em 0 0 0;
-  text-align: right;
-}
-li.linktrail { display: inline; margin: 0; padding: 0; }
-
-li.linktrail::before {
-  content: '  /  ';
-  color: #3f3f3f;
-}
-
-li.linktrail-first::before, li.linktrail-only::before { content: ''; }
-
-
-div.navbar {
-  padding: 0.5em 1em 0.5em 1em;
-  max-width: 60em;
-  background-color: #ffffff;
-  border: solid 1px #e0e0df;
-}
-div.navbar-top { margin-bottom: 1em; }
-div.navbar-bottom { margin-top: 1em; clear: both; }
-div.navbar img { border: 0; vertical-align: -0.4em; }
-table.navbar { width: 100%; margin: 0; border: none; }
-table.navbar td { padding: 0; border: none; }
-td.navbar-next {
-  text-align: right;
-}
-a.navbar-prev::before {
-  
-  content: '◀  ';
-  color: #3f3f3f;
-}
-a.navbar-next::after {
-  
-  content: '  ▶';
-  color: #3f3f3f;
-}
-
-
-div.sidebar {
-  float: right;
-  padding: 0; margin: 0; width: 12em;
-}
-div.sidenav {
-  padding: 0.5em 1em 0 1em;
-  background-color: #ffffff;
-  border: solid 1px #e0e0df;
-}
-div.sidenav div.autotoc {
-  background-color: #ffffff;
-  border: none; padding: 0; margin: 0;
-}
-div.sidenav div.autotoc div.autotoc { margin-top: 0.5em; }
-div.sidenav div.autotoc li { margin-bottom: 0.5em; }
-div.sidenav div.autotoc div.autotoc div.autotoc {
-  margin-left: 1em;
-  margin-top: 0;
-}
-div.sidenav div.autotoc div.autotoc div.autotoc li { margin-bottom: 0; }
-
-
-div.autotoc {
-  
-  display: table;
-  margin-top: 1em;
-  margin-left: 1.72em;
-  padding: 0.5em 1em 0.5em 1em;
-  background-color: #f0f9ff;
-  border: solid 1px #c0c9ff;
-}
-div.autotoc ul { margin: 0; padding: 0; }
-div.autotoc li { list-style-type: none; margin: 0; }
-div.autotoc div.autotoc-title { margin-bottom: 0.5em; }
-div.autotoc div.autotoc { border: none; padding: 0; margin-top: 0; margin-bottom: 0.5em; }
-div.autotoc div.autotoc div.autotoc { margin-bottom: 0; }
-
-
-span.bibliolabel {
-  color: #3f3f3f;
-}
-
-
-div.admonition {
-  padding: 0.5em 6px 0.5em 6px;
-  border: solid 1px #e0e0df;
-  background-color: #fffff0;
-}
-div.caution-inner, div.important-inner, div.note-inner, div.tip-inner, div.warning-inner {
-  padding-left: 60px;
-  background-position: left top;
-  background-repeat: no-repeat;
-  min-height: 48px;
-}
-div.caution-inner { background-image: url("admon-caution.png"); }
-div.important-inner { background-image: url("admon-important.png"); }
-div.note-inner { background-image: url("admon-note.png"); }
-div.note-bug div.note-inner { background-image: url("admon-bug.png"); }
-div.tip-inner { background-image: url("admon-tip.png"); }
-div.warning-inner { background-image: url("admon-warning.png"); }
-div.blockquote {
-  
-  background-image: url('watermark-blockquote-201C.png');
-  background-repeat: no-repeat;
-  background-position: top left;
-  padding: 0.5em;
-  padding-left: 4em;
-}
-div.attribution {
-  margin-top: 0.5em;
-  color: #3f3f3f;
-}
-div.attribution::before {
-  
-  content: '― ';
-}
-div.epigraph {
-  text-align: right;
-  margin-left: 20%;
-  margin-right: 0;
-  color: #3f3f3f;
-}
-div.figure, div.informalfigure {
-  
-  display: table;
-  padding: 0.5em;
-  background-color: #f9f9f6;
-  border: solid 1px #e0e0df;
-}
-div.figure-inner, div.informalfigure-inner {
-  padding: 0.5em;
-  background-color: #ffffff;
-  border: solid 1px #e0e0df;
-}
-div.caption { margin-top: 0.5em; }
-div.programlisting {
-  padding: 0.5em;
-  
-  background-color: #f9f9f6;
-  border: solid 1px #e0e0df;
-}
-div.screen {
-  padding: 0.5em;
-  
-  background-color: #f9f9f6;
-  border: solid 1px #e0e0df;
-}
-div.screen .prompt {
-  color: #3f3f3f;
-}
-div.screen .userinput {
-  font-weight: bold;
-  color: #3f3f3f;
-}
-div.programlisting .userinput {
-  font-weight: bold;
-  color: #3f3f3f;
-}
-pre.linenumbering {
-  color: #3f3f3f;
-  margin: 0;
-  padding-right: 1em;
-  float: left;
-  text-align: right;
-}
-
-
-
-dl.index dt { margin-top: 0; }
-dl.index dd { margin-top: 0; margin-bottom: 0; }
-dl.indexdiv dt { margin-top: 0; }
-dl.indexdiv dd { margin-top: 0; margin-bottom: 0; }
-dl.setindex dt { margin-top: 0; }
-dl.setindex dd { margin-top: 0; margin-bottom: 0; }
-div.list div.title-formal span.title {
-  border-bottom: solid 1px #e0e0df;
-}
-div.simplelist {
-  margin-left: 1.72em;
-}
-div.simplelist table { margin-left: 0; border: none; }
-div.simplelist td {
-  padding: 0.5em;
-  border-left: solid 1px #e0e0df;
-}
-div.simplelist td.td-first {
-  padding-left: 0;
-  border-left: 0;
-}
-div.synopsis {
-  padding: 0.5em;
-  
-  background-color: #f9f9f6;
-  border-top: solid 2px #c0c9ff;
-  border-bottom: solid 2px #c0c9ff;
-}
-div.synopsis div.synopsis {
-  padding: 0;
-  border: none;
-}
-div.synopsis div.block { margin-top: 0.2em; }
-div.synopsis div.block-first { margin-top: 0; }
-div.cmdsynopsis { font-family: monospace; }
-
-span.accel { text-decoration: underline; }
-span.acronym { font-family: sans-serif; }
-span.application { font-style: italic; }
-span.classname, span.exceptionname, span.interfacename { font-family: monospace; }
-span.code {
-  font-family: monospace;
-  border: solid 1px #e0e0df;
-  padding-left: 0.2em;
-  padding-right: 0.2em;
-}
-pre span.code { border: none; padding: 0; }
-span.command {
-  font-family: monospace;
-  border: solid 1px #e0e0df;
-  padding-left: 0.2em;
-  padding-right: 0.2em;
-}
-pre span.command { border: none; padding: 0; }
-span.computeroutput { font-family: monospace; }
-
-span.constant { font-family: monospace; }
-span.database { font-family: monospace; }
-span.email { font-family: monospace; }
-span.emphasis { font-style: italic; }
-span.emphasis-bold { font-style: normal; font-weight: bold; }
-span.envar { font-family: monospace; }
-
-span.filename { font-family: monospace; }
-span.firstterm { font-style: italic; }
-span.foreignphrase { font-style: italic; }
-span.function { font-family: monospace; }
-
-dt.glossterm span.glossterm { font-style: normal; }
-
-
-span.glossterm { font-style: italic; }
-
-span.guibutton, span.guilabel, span.guimenu, span.guimenuitem, span.guisubmenu, span.interface {
-  font-weight: bold;
-  color: #3f3f3f;
-}
-span.keycap {
-  font-weight: bold;
-  color: #3f3f3f;
-}
-span.lineannotation { font-style: italic; }
-span.literal { font-family: monospace; }
-span.markup  { font-family: monospace; }
-span.medialabel { font-style: italic; }
-span.methodname { font-family: monospace; }
-span.ooclass, span.ooexception, span.oointerface { font-family: monospace; }
-span.option { font-family: monospace; }
-span.parameter { font-family: monospace; }
-span.paramdef span.parameter { font-style: italic; }
-span.prompt { font-family: monospace; }
-span.property { font-family: monospace; }
-span.replaceable  { font-style: italic; }
-span.returnvalue { font-family: monospace; }
-span.sgmltag { font-family: monospace; }
-span.structfield, span.structname { font-family: monospace; }
-span.symbol { font-family: monospace; }
-span.systemitem { font-family: monospace; }
-span.token { font-family: monospace; }
-span.type { font-family: monospace; }
-span.uri { font-family: monospace; }
-span.userinput { font-family: monospace; }
-span.varname { font-family: monospace; }
-span.wordasword { font-style: italic; }
-
-
-
-div.footnotes { font-style: italic; font-size: 0.8em; }
-div.footnote { margin-top: 1.44em; }
-span.footnote-number { display: inline; padding-right: 0.83em; }
-span.footnote-number + p { display: inline; }
-a.footnote { text-decoration: none; font-size: 0.8em; }
-a.footnote-ref { text-decoration: none; }
-
-span.co {
-  margin-left: 0.2em; margin-right: 0.2em;
-  padding-left: 0.4em; padding-right: 0.4em;
-  border: solid 1px #000000;
-  -moz-border-radius: 8px;
-  background-color: #000000;
-  color: #FFFFFF;
-  font-size: 8px;
-}
-span.co:hover {
-  border-color: #333333;
-  background-color: #333333;
-  color: #FFFFFF;
-}
-span.co a { text-decoration: none; }
-span.co a:hover { text-decoration: none; }
-
-dt.question { margin-left: 0em; }
-dt.question div.label { float: left; }
-dd + dt.question { margin-top: 1em; }
-dd.answer {
-  margin-top: 1em;
-  margin-left: 2em;
-  margin-right: 1em;
-}
-dd.answer div.label { float: left; }
-</style>
-</head>
-<body>
-<div class="navbar navbar-top"><table class="navbar"><tr>
-<td class="navbar-prev"><a class="navbar-prev" href="GuideImageManagementCopyMove.html" title="Copy and Move">Copy and Move</a></td>
-<td class="navbar-next"><a class="navbar-next" href="GuideImageManagementDelete.html" title="Delete">Delete</a></td>
-</tr></table></div>
-<div class="sidebar"><div class="sidenav"><div class="autotoc"><ul>
-<li><a href="GuideIndex-info.html" title="About This Document">About This Document</a></li>
-<li>
-<a class="xref" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a><div class="autotoc"><ul>
-<li><a class="xref" href="GuideIntroduction.html" title="Introduction">Introduction</a></li>
-<li><a class="xref" href="GuideMainWindow.html" title="Main Window">Main Window</a></li>
-<li><a class="xref" href="GuideSidebars.html" title="Sidebars">Sidebars</a></li>
-<li><a class="xref" href="GuideOtherWindows.html" title="Stand-alone Windows">Stand-alone Windows</a></li>
-<li><a class="xref" href="GuideImageSearch.html" title="Search and Select">Search and Select</a></li>
-<li><a class="xref" href="GuideImageManagementPlugins.html" title="Plugins">Plugins</a></li>
-<li>
-<a class="xref" href="GuideImageManagement.html" title="File Management">File Management</a><div class="autotoc"><ul>
-<li><a class="xref" href="GuideImageManagementCopyMove.html" title="Copy and Move">Copy and Move</a></li>
-<li>Rename</li>
-<li><a class="xref" href="GuideImageManagementDelete.html" title="Delete">Delete</a></li>
-<li><a class="xref" href="GuideReferenceManagement.html" title="Cache and Data Maintenance">Cache and Data Maintenance</a></li>
-</ul></div>
-</li>
-<li><a class="xref" href="GuideColorManagement.html" title="Color Management">Color Management</a></li>
-<li><a class="xref" href="GuideImagePresentation.html" title="Image Presentation">Image Presentation</a></li>
-<li><a class="xref" href="GuidePrinting.html" title="Printing">Printing</a></li>
-<li><a class="xref" href="GuideOptionsMain.html" title="Preferences">Preferences</a></li>
-<li><a class="xref" href="GuideOptionsAdditional.html" title="Additional Preferences">Additional Preferences</a></li>
-<li><a class="xref" href="GuideReference.html" title="Reference">Reference</a></li>
-<li><a class="xref" href="GuideFaq.html" title="Frequently Asked Questions">Frequently Asked Questions</a></li>
-<li><a class="xref" href="GuideLicence.html" title="Licence">Licence</a></li>
-<li><a class="xref" href="GuideCredits.html" title="Credits">Credits</a></li>
-<li><a class="xref" href="GuideGnuFdl.html" title="GNU Free Documentation License">GNU Free Documentation License</a></li>
-</ul></div>
-</li>
-</ul></div></div></div>
-<div class="body body-sidebar"><div class="division section">
-<a name="GuideImageManagementRename"></a><div class="header"><h1 class="section title"><span class="title"><a name="titleGuideImageManagementRename"></a>Rename</span></h1></div>
-<ul class="linktrail">
-<li class="linktrail linktrail-first"><a class="linktrail" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a></li>
-<li class="linktrail linktrail-last"><a class="linktrail" href="GuideImageManagement.html" title="File Management">File Management</a></li>
-</ul>
-<p class="para block block-first">
-    To rename a file in Geeqie select
-    <span class="menuchoice"><span class="guimenu">File</span> ▸ <span class="guimenuitem">Rename</span> <span class="shortcut">(
-        <span class="keycombo"><span class="keycap">Ctrl</span>+<span class="keycap">R</span></span>
-      )</span></span>
-    . Rename is also available in the context menu of all images and files.
-  </p>
-<p class="para block">When renaming a file, a dialog will display allowing entry of the new name for the file. The dialog will be different depending on the number of files selected to be renamed. A simple dialog will appear when renaming a single file, however when renaming multiple files the dialog will include a list of the file to be renamed and additional options.</p>
-<p class="para block"></p>
-<div class="autotoc"><ul>
-<li>
-<span class="label">7.2.1. </span><a class="xref" href="GuideImageManagementRename.html#Renamesinglefiledialog" title="Rename single file dialog">Rename single file dialog</a>
-</li>
-<li>
-<span class="label">7.2.2. </span><a class="xref" href="GuideImageManagementRename.html#Renamemultiplefilesdialog" title="Rename multiple files dialog">Rename multiple files dialog</a>
-</li>
-</ul></div>
-<div class="division section">
-<a name="Renamesinglefiledialog"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">7.2.1. </span>Rename single file dialog</span></h2></div>
-<p class="para block block-first">
-      The dialog that appears when renaming a single file includes an image of the file, an entry to type the new name of the file, a Rename button, and a Cancel button. Type the new name into the text entry and press
-      <span class="keycap">Enter</span>
-      or activate the Rename button to rename the file. Press
-      <span class="keycap">Escape</span>
-      or activate the Cancel button to close the dialog and abort renaming the file.
-    </p>
-<p class="para block">
-      When renaming a file and the new name already exists on the file system a dialog will appear showing the renamed and existing files. To overwrite the existing file press
-      <span class="keycap">Enter</span>
-      or activate the Overwrite button. Press
-      <span class="keycap">Escape</span>
-      or activate the Cancel button to close the dialog abort renaming the file.
-    </p>
-<p class="para block"></p>
-</div>
-<div class="division section">
-<a name="Renamemultiplefilesdialog"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">7.2.2. </span>Rename multiple files dialog</span></h2></div>
-<p class="para block block-first">The dialog that appears when renaming multiple files includes the list of files to be renamed, a preview image of the active file, an entry to enter the new file name, an auto rename check box, a Rename button, and a Cancel button.</p>
-<div class="block list variablelist"><dl class="variablelist">
-<dt class="term dt-first">
-          <span class="guilabel">Manually enter new file names</span>
-        </dt>
-<dd>
-          <p class="para block block-first">
-            To manually enter the new name of each file, the active file will be displayed in the image preview and it's original name will be displayed above the text entry. To rename the file type the new name and press
-            <span class="keycap">Enter</span>
-            or activate the Rename button. When a file is successfully renamed it will be removed from the list and the next one will become the active file. After all files have been renamed, the dialog will close.
-          </p>
-          <p class="para block">Files do not have to be renamed in the order that they appear in the list, highlighting a name in the list will make it become the active file.</p>
-          <p class="para block">
-            When renaming a file and the new name already exists on the file system a dialog will appear showing the renamed and existing files. To overwrite the existing file press
-            <span class="keycap">Enter</span>
-            or activate the Overwrite button. Press
-            <span class="keycap">Escape</span>
-            or activate the Cancel button to return to the original rename dialog, the file that prompted the overwrite dialog will remain active.
-          </p>
-        </dd>
-<dt class="term">
-          <span class="guilabel">Automatic renaming of multiple files</span>
-        </dt>
-<dd>
-          <p class="para block block-first">To automatically rename the files in the list, enable the Auto rename check box. The dialog will change to batch mode for numerical naming of files.</p>
-          <p class="para block">The file name list will change to include a preview column that will show the resulting name of each file. The text entry will change to three entries; the first represents the text that appears in the new names before the number, the second will be the start number to use when incrementing the file number, and the third represents the text to append to the name after the number. The end text should include the file name extension, therefore batch renaming multiple types of files (those with different extensions) all at once is not recommended.</p>
-          <p class="para block">The padding number can be used to change the minimum length of characters to use for the number portion of the new name. When the file number results in fewer characters than the padding size, the result will be padded with leading zeros to fill the remaining space. For example if padding size is 3, a file with the number 24 will appear in the file name as “024”.</p>
-          <p class="para block">The order of the file list can be changed by dragging a name to the desired location within the list. The preview column will update to reflect the new order.</p>
-          <p class="para block">
-            When the preview of new names is satisfactory, press
-            <span class="keycap">Enter</span>
-            or activate the Rename button to rename the files to match the name in the preview column. Press
-            <span class="keycap">Escape</span>
-            or activate the Cancel button to close the dialog and abort the rename operation.
-          </p>
-          <p class="para block">If the resulting new names match any existing files, a warning dialog will notify you. The rename dialog will remain so that you can select a different set of names.</p>
-          <p class="para block"></p>
-        </dd>
-<dt class="term">
-          <span class="guilabel">Formatted renaming of multiple files</span>
-        </dt>
-<dd>
-          <p class="para block block-first">Formatted rename permits file to be renamed in a pre-determined way whilst still including the original file name.</p>
-          <p class="para block">
-            In the Format box any alpha-numerics can be entered, but the special character
-            <span class="keycap">*</span>
-            will be replaced by the current filename. One or more
-            <span class="keycap">#</span>
-            characters can be included, and will be replaced by an incrementing number.
-          </p>
-          <p class="para block">The current file extension is automatically appended to new new file name.</p>
-          <p class="para block">The order of the file list can be changed by dragging a name to the desired location within the list. The preview column will update to reflect the new order.</p>
-          <p class="para block">When the preview of new names is satisfactory, press Enter or activate the Rename button to rename the files to match the name in the preview column. Press Escape or activate the Cancel button to close the dialog and abort the rename operation.</p>
-          <p class="para block">If the resulting new names match any existing files, a warning dialog will notify you. The rename dialog will remain so that you can select a different set of names.</p>
-          <p class="para block"></p>
-        </dd>
-</dl></div>
-</div>
-</div></div>
-<div class="navbar navbar-bottom"><table class="navbar"><tr>
-<td class="navbar-prev"><a class="navbar-prev" href="GuideImageManagementCopyMove.html" title="Copy and Move">Copy and Move</a></td>
-<td class="navbar-next"><a class="navbar-next" href="GuideImageManagementDelete.html" title="Delete">Delete</a></td>
-</tr></table></div>
-</body>
-</html>