Skip to content

Commit

Permalink
ADD: directoryhotlist.html: Ampersand in a name. (doublecmd#57)
Browse files Browse the repository at this point in the history
ADD: multirename.html: Insert opening/closing square bracket as is; note about character case.
ADD: regexp.html: Modifiers: Default states.
ADD: variables.html: Pseudo environment variables; note about character case in the variables names.
ADD: viewer.html: 'Quick view' and related changes.
CHG: findfiles.html: Small improvements.
UPD/CHG/FIX: Screenshots.
UPD/CHG: lua.html: Some details about text encoding; a note about CONTENT_DELAYIFSLOW. Cosmetic.
UPD: configuration.html: DC tooltips.
UPD: directoryhotlist.html: Special folders.
UPD: help.html: 'Current directory bar', 'Command line'.
UPD: multiarc.html: Open in associated app.
UPD: toolbar.html: Drag-and-drop buttons, some additiomal getails.
Other small fixes/changes.
  • Loading branch information
Skif-off authored Feb 6, 2024
1 parent c31bddb commit 05b8a85
Show file tree
Hide file tree
Showing 48 changed files with 500 additions and 414 deletions.
10 changes: 5 additions & 5 deletions doc/en/cmds.html
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ <h2><a name="catactivepanel">2.1. Active Panel</a></h2>
<td class="cmdcell"><img class="IntCmdImage" title="cm_QuickView" alt="cm_QuickView" src="../../pixmaps/dctheme/32x32/actions/cm_quickview.png">
<div class="cmdname"><a name="cm_QuickView">cm_QuickView</a></div>
<div class="shrtctkey">Ctrl+Q</div></td>
<td class="cmdhintcell">Content of selected item shown in opposite panel (instead of a separate window).<br>As we navigate to next items, displayed content is updated.</td>
<td class="cmdhintcell">Content of selected item shown in opposite panel (instead of a separate window).<br>See details <a href="viewer.html">here</a>.</td>
</tr>
<tr>
<td class="cmdcell"><img class="IntCmdImage" title="cm_SortByName" alt="cm_SortByName" src="../../pixmaps/dctheme/32x32/actions/cm_sortbyname.png">
Expand Down Expand Up @@ -338,7 +338,7 @@ <h2><a name="catactivepanel">2.1. Active Panel</a></h2>
</tr>
<tr>
<td class="innerdescvaluecell"><i>(absent)</i></td>
<td class="innerdescdesccell">will sort with descending order</td>
<td class="innerdescdesccell">will sort with ascending order</td>
</tr>
<tr>
<td colspan="3">Note: If any of these three parameters are not defined or are defined incorrectly; the default values for these parameters will be: panel=active, column=name and order=ascending.</td>
Expand Down Expand Up @@ -1134,7 +1134,7 @@ <h2><a name="catmiscellaneous">2.7. Miscellaneous</a></h2>
<tr>
<td class="cmdcell"><img class="IntCmdImage" title="cm_LoadList" alt="cm_LoadList" src="../../pixmaps/dctheme/32x32/actions/cm_loadlist.png">
<div class="cmdname"><a name="cm_LoadList">cm_LoadList</a><span class="versionref"><sup>(Beta version)</sup></span></div></td>
<td class="cmdhintcell">Load list of files/folders from the specified text file (plain text file containing full file names, one per line).<br>
<td class="cmdhintcell">Load list of files/folders from the specified text file (plain text file containing full file names, one per line). Use UTF-8 without BOM.<br>
<br>
<table class="innercmddesc">
<tr class="rowinnerdesc">
Expand Down Expand Up @@ -1281,7 +1281,7 @@ <h2><a name="catmark">2.8. Mark</a></h2>
<b>Note3:</b> When specifying the "mask" parameter, please note you may also use predefined selection type simply by preceding the name of it with symbol "&gt;" like "<i>mask=&gt;Pascal files</i>".<br>
<b>Note4:</b> When using filtering parameter "<i>ignoreaccents=TRUE</i>", the ligatured characters like "<i>&oelig;</i>" for example will be evaluated as the sequence "<i>oe</i>". So for example "<i>c&oelig;ur</i>" will match "<i>coeur</i>".<br>
<b>Note5:</b> The fact to use parameters like "casesensitive" for example will not affect the subsequent usage the cm_MarkPlus with no parameters which will use the default same parameters of last time it was prompting the user.<br>
<b>Note6:</b> Regarding the "attr" possible parameter values, see the "The <a href="findfiles.html#attributes">Searching for files with specific attributes</a>." section in the "Find files" help file. The way to specify the filter regarding the attributes is the same.<br>
<b>Note6:</b> Regarding the "attr" possible parameter values, see the "<a href="findfiles.html#attributes">Searching for files with specific attributes</a>." section in the "Find files" help file. The way to specify the filter regarding the attributes is the same.<br>
<b>Example1:</b> "cm_MarkPlus mask=*.pas;*.dfm;*.dpr;*.inc casesensitive=false" This will select all the files matching the given filter mask (which is basically common Delphi source file extensions) and ignoring the case of the letters.<br>
<b>Example2:</b> "cm_MarkPlus mask=*ecole*.docx ignoreaccents=true" This will select all the files matching the given filter mask (which is basically Microsoft Word document with the word "ecole" in them) ignoring the accents. This means it will select file with "école" and "ecole" in them since accent are ignored.
</td>
Expand Down Expand Up @@ -1652,7 +1652,7 @@ <h2><a name="catnavigation">2.10. Navigation</a></h2>
<td class="cmdcell"><img class="IntCmdImage" title="cm_TargetEqualSource" alt="cm_TargetEqualSource" src="../../pixmaps/dctheme/32x32/actions/cm_targetequalsource.png">
<div class="cmdname"><a name="cm_TargetEqualSource">cm_TargetEqualSource</a></div>
<div class="shrtctkey">Alt+Z</div></td>
<td class="cmdhintcell">Show same directory in opposite panel.</td>
<td class="cmdhintcell">Open the directory of the active panel in the opposite panel.</td>
</tr>
<tr>
<td class="cmdcell"><img class="IntCmdImage" title="cm_TransferLeft" alt="cm_TransferLeft" src="../../pixmaps/dctheme/32x32/actions/cm_transferleft.png">
Expand Down
22 changes: 11 additions & 11 deletions doc/en/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -325,10 +325,10 @@ <h2><a name="settings">2. Configuration</a></h2>
<table>
<tr class="rowcategorytitle"><th colspan="2">Attributes in Unix/Linux (File Types)</th></tr>
<tr class="rowsubtitle"><th class="namecolumn">File Types letters</th><th class="categorydesccolumn">What it stands for</th></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">b</div></td><td class="hintcell">block</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">c</div></td><td class="hintcell">character</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">b</div></td><td class="hintcell">block device</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">c</div></td><td class="hintcell">character device</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">d</div></td><td class="hintcell">directory</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">f</div></td><td class="hintcell">fifo</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">f</div></td><td class="hintcell">named pipe (FIFO)</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">l</div></td><td class="hintcell">symlink</td></tr>
<tr><td class="varcell"><div class="firstcolumnaleft">s</div></td><td class="hintcell">socket</td></tr>
</table>
Expand All @@ -337,12 +337,12 @@ <h2><a name="settings">2. Configuration</a></h2>
<p>If attribute should not be set, it must be replaced with the "-" symbol, unnecessary attributes should be hidden: symbol "*" means match any number of characters, symbol "?" means any one character. For example, <code>?r*</code> (Windows) or <code>?r-*</code> (Linux) will find all read-only files and folders.</p>
<p>You can use a color from the list or specify yours using the "&gt;&gt;" button.</p>
<p>Do not forget to click "Apply" button after customization.</p>
<p>Rules are applied strictly in reverse order: a rule higher in the list will overlap any rule below.</p>
<p>Double Commander checks the list from top to bottom until the first match: a rule higher in the list will overlap any rule below.</p>
<br>

<p><span class="bold"><a name="ConfigKeys">2.6. Keys</a></span></p>
<p class="figure"><img class="largeimage" title="Keys" alt="Keys" src="images/imgDC/pic60.png" width="578" height="168"></p>
<p>Here you can set the action on pressing some keys in the active file panel: <span class="italic">Letters</span>, <span class="italic">Alt+Letters</span>, <span class="italic">Ctrl+Alt+Letters</span>. You can choose one of the following actions: do nothing, set focus to command line and enter command, run quick search or quick filter.</p>
<p>Here you can set the action on pressing some keys in the active file panel: <span class="italic">Letters</span>, <span class="italic">Alt+Letters</span>, <span class="italic">Ctrl+Alt+Letters</span>. You can choose one of the following actions: do nothing, set focus to command line and enter command, run <p><a href="help.html#cm_QuickSearch">quick search or quick filter</a>.</p>
<p><span class="italic">Left, Right arrows change directory (Lynx-like movement)</span>&nbsp;&ndash; <kbd>right arrow</kbd> opens directory or runs a program under cursor, <kbd>left arrow</kbd> opens parent directory.</p>
<br>

Expand Down Expand Up @@ -469,7 +469,7 @@ <h2><a name="settings">2. Configuration</a></h2>

<p>The first parameter in the <span class="italic">Formatting</span> group is <span class="italic"><a name="dt_format">Date and time format</a></span>. You can choose one of the existing templates from the drop-down list or set your own using date and time formatting characters.</p>
<p>Formatting characters are presented below (based on <a title="Free Pascal: Date and time format" href="https://www.freepascal.org/docs-html/rtl/sysutils/formatchars.html" target="_blank">Free Pascal documentation</a>). Some values depends on your regional settings!</p>
<p>As example we will use 2021.01.24 09:06:02 (i.e. <tt>yyyy.mm.dd hh:mm:ss</tt>) and the USA region.</p>
<p>As example we will use 2021.01.24 09:06:02 (i.e. <code>yyyy.mm.dd hh:mm:ss</code>) and the USA region.</p>
<table>
<tr class="rowcategorytitle"><th colspan="3">Possible characters</th></tr>
<tr class="rowsubtitle"><th class="smallname">Characters</th><th class="categorydesccolumn">Description</th><th class="categorynamecolumn">Example</th></tr>
Expand Down Expand Up @@ -641,15 +641,15 @@ <h2><a name="settings">2. Configuration</a></h2>
<p>Content plugins are designed to get properties of a file or information about its content (for example, EXIF or ID3 tags). You can use this data in the file search or multi-rename tool, column set, tooltips.<br>
Also Double Commander supports content plugins written in the Lua language (scripts are added in the same way as ordinary plugins). Examples can be found in the program folder (<tt>plugins/wdx/scripts</tt>).</p>
<p><span class="italic">3. File system plugins (WFX)</span></p>
<p>File system plugins uses their own file systems or provides access to other file systems and devices (local or remote). For example, FTP servers, Samba,mobile devises. Also it can be lists of files, running processes and services, or the Windows registry.</p>
<p>File system plugins uses their own file systems or provides access to other file systems and devices (local or remote). For example, FTP servers, network directories, mobile devises. Also it can be lists of files, running processes and services, or the Windows registry.</p>
<p><span class="italic">4. Lister plugins (WLX)</span></p>
<p>The built-in viewer displays plain text files, some image formats and console commands output, plugins allow to expand this list: electronic documents and databases, audio and video files, font files, content of archives, detailed information about some files, source code files with syntax highlighting.<br>
Order matters: when choosing an appropriate plugin, Double Commander starts checking from top to bottom.</p>
<p><span class="italic">5. Search plugin (DSX)</span></p>
<p>Search plugins are Double Commander's own plugin type, these plugins use console programs to find files (for example, Locate, Everything or Recoll). The DSX plugins interface allows to send them <a href="findfiles.html">search parameter values</a> from the "Standard" and "Advanced" tabs. </p>
<p>Buttons:</p>
<ul>
<li><p><span class="italic">Add</span>&nbsp;&ndash; opens the file selection dialog. Alternatively, you can use the internal <a href="cmds.html#cm_AddPlugin">cm_AddPlugin</a> command.</p></li>
<li><p><span class="italic">Add</span>&nbsp;&ndash; opens the file selection dialog. Alternatively, you can use the internal command <a href="cmds.html#cm_AddPlugin">cm_AddPlugin</a>.</p></li>
<li><p><span class="italic">Disable</span>&nbsp;&ndash; allows to temporarily disable the selected plugin.</p></li>
<li><p><span class="italic">Remove</span>&nbsp;&ndash; removes the selected plugin from the list (but not plugin file!).</p></li>
<li><p>
Expand Down Expand Up @@ -769,7 +769,6 @@ <h2><a name="settings">2. Configuration</a></h2>
<br>

<p><span class="bold"><a name="ConfigFavoriteTabs">2.13.1. Folder tabs&nbsp;&gt; Favorite Tabs</a></span></p>
<p>Favorite Tabs are saved sets of tabs that grouped according to criteria convenient for you (work, projects, hobbies, and so on), they allow to open all the necessary directories in tabs at once.</p>
<p>The list of saved tab sets is available in the <a href="help.html#mnu_fav">"Favorites"</a> menu and in the popup menu called by the <a href="cmds.html#cm_LoadFavoriteTabs">cm_LoadFavoriteTabs</a> command.</p>
<p>In this section you can manage them: change order, names, delete unnecessary, sort or group in a submenu.</p>
<p class="figure"><img class="largeimage" title="Favorite Tabs" alt="Favorite Tabs" src="images/imgDC/pic73.png" width="578" height="440"></p>
Expand Down Expand Up @@ -934,7 +933,7 @@ <h2><a name="settings">2. Configuration</a></h2>
<p>This section contains the settings for tooltips when the mouse cursor is hovering over a file.</p>
<p class="figure"><img class="largeimage" title="Tooltips" alt="Tooltips" src="images/imgDC/pic47.png" width="726" height="416"></p>
<p><span class="italic">Show tooltip for files in the file panel</span>&nbsp;&ndash; enables the ability to use tooltips.</p>
<p><span class="italic">File types</span>&nbsp;&ndash; contains a list of file groups.</p>
<p><span class="italic">File types</span>&nbsp;&ndash; contains a list of file groups. Double Commander checks the list from top to bottom until the first match: a file group higher in the list will overlap any file group below.</p>
<p>Buttons:</p>
<ul>
<li><p><span class="italic">Apply</span>&nbsp;&ndash; will save the settings for the selected file type.</p></li>
Expand All @@ -961,11 +960,12 @@ <h2><a name="settings">2. Configuration</a></h2>
<li><p>Show DC tooltip only.</p></li>
<li><p>Show system tooltip only.</p></li>
</ul>
<p>If you have not added your own tooltips for the specified file types, then the DC tooltip will contain only the file name. The content of the system tooltip depends on the operating system:</p>
<p>The content of the system tooltip depends on the operating system:</p>
<ul>
<li><p>Windows: File name and the same as in Windows Explorer. If it was not possible to obtain information, then Double Commander will show the same as in Linux and other Unix-like systems.</p></li>
<li><p>Linux and other Unix-like systems: File name, modification date and size.</p></li>
</ul>
<p>The first line of the tooltip always contains the file name, and if you did not specify anything in the <span class="italic">Category hint</span> field, then the DC tooltip will contain only the file name.</p>
<p><span class="italic">Tooltip hiding delay</span>&nbsp;&ndash; sets the duration of displaying the tooltip: system default, 1 sec, 2 sec, 3 sec, 5 sec, 10 sec, 30 sec, 1 min and never hide (the tooltip will be hidden when you move the mouse cursor to another file or outside the file panel).</p>
<p>In the screenshot at the beginning of the section description, you can see an example of a tooltip with the <tt>textline.wdx</tt> plugin that shows the contents of the selected lines of a text file (in this case, the first, second and third lines), the <span class="italic">Combine DC and system tooltip, system first</span> mode is selected.</p>
<br>
Expand Down
6 changes: 4 additions & 2 deletions doc/en/directoryhotlist.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ <h2><a name="personalize">2.6. Personalize the new added entry in the Directory
<p>In this example, the folder name is "doc" but the name given to the entry is "Documentation"</p>
<p>This is also how you will see it in the Directory Hotlist popup menu.</p>
<p class="figure"><img class="largeimage" title="Customization" alt="Customization" src="images/imgDC/dirhotpersonalize.png" width="764" height="464"></p>
<p>The ampersand character "&amp;" in a name has a special meaning, we can use it to quickly select a directory in the menu using the keyboard, just add an ampersand in front of one of the letters. To use this symbol as is, we must double it ("&amp;&amp;").</p>
<p class="navback"><a href="#topofpage">(back to top)</a></p>
</div>

Expand Down Expand Up @@ -195,8 +196,9 @@ <h2><a name="helperpath">2.9. Helper with path and target definition</a></h2>
<p>Here is a complete summary of what you'll find there:</p>
<ul>
<li><b>Use Double Commander special path</b>&nbsp;&ndash; To point directly to the executable path, the configuration path, etc.</li>
<li><b>Use Windows special folder (TC)</b>&nbsp;&ndash; For Microsoft Windows flavor, will allow to point windows-related path, compatible with TC variable name.</li>
<li><b>Use other Windows special folder</b>&nbsp;&ndash; Same as above but new one, not present in TC.</li>
<li><b>Use Windows special folder (TC)</b>&nbsp;&ndash; Windows only: contains a list of <a href="variables.html#envvariables">pseudo environment variables</a>.<br>
Note: This list corresponds to the list of variables supported in Total Commander and is also used for import from Total Commander and export Directory Hotlist (see <a href="#exportimporttc">below</a>) and <a href="toolbar.html">toolbar</a>.</li>
<li><b>Use other Windows special folder</b>&nbsp;&ndash; Additional pseudo environment variables.</li>
<li><b>Use environment variable</b>&nbsp;&ndash; Certainly some values are not really valid and useful there but for the ones that might be, let's use them!</li>
<li><b>Use hotdir path</b>&nbsp;&ndash; This is pure versatility: you may add a Directory Hotlist... from the Directory Hotlist!</li>
<li><b>Make relative to...</b>&nbsp;&ndash; Same thing for each of the above BUT instead of straight ADDING the path, it will make the current written one relative to the one you select.</li>
Expand Down
Loading

0 comments on commit 05b8a85

Please sign in to comment.