added anchor links

Author: dafi

.rubocop.yml

@@ -0,0 +1,43 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+AllCops:
+    NewCops: enable
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

_includes/comparisonMethods.md

@@ -1,4 +1,4 @@
-# Comparison Method
+# [Comparison Method](#comparison_method)
 
 It is possible to choose which method to use to compare two folders.  
 The method to use is strictly related to user needs, comparing source code (files large only few kilobytes) should use a content comparison but to find which movies (files larger than a gigabytes) are not present on right side is faster compare by file size or file timestamp.  
@@ -44,4 +44,4 @@ The complete list of supported comparison methods
             </tr>
         </tbody>
     </table>
-</div>
+</div>

_includes/displayFiles.md

@@ -1,4 +1,4 @@
-# Choose Files to View according to differences found
+# [Choose Files to View according to differences found](#choose_files_to_view_according_to_differences_found)
 
 After the comparison complete you can choose which files to view  
 Definition: **Orphan** indicates a file present only on one side
@@ -38,13 +38,13 @@ The complete list of show options
     </table>
 </div>
 
-## Choose Folders to View
+## [Choose Folders to View](#choose_folders_to_view)
 
 It is possible to hide empty and orphans folders.
 Folders can be empty because they don't contains any file on disk or because all files/folders inside them are filtered.  
 Orphans folders are present only on one side (left or right)
 
-## Show Filtered Files
+## [Show Filtered Files](#show_filtered_files)
 
 When a filter founds matches the elements are not visible but in case it's necessary to shown them you can click on the `Filtered` button.  
 Default filters can be changed or totally deleted from `Session Preferences` window.  

_includes/finderMetadata.md

@@ -1,4 +1,4 @@
-# Compare Finder Metadata
+# [Compare Finder Metadata](#compare_finder_metadata)
 
 It is possible to compare OSX Finder Metadata.  
 When the metadata comparison mismatches, for example left file's label is red and right file's label is blue, the other comparison methods (size, timestamp, content) are not evaluated.
@@ -24,4 +24,4 @@ The complete list of supported metadata
             </tr>
         </tbody>
     </table>
-</div>
+</div>

_includes/foldersTraversal.md

@@ -1,4 +1,4 @@
-# Folders Traversal
+# [Folders Traversal](#folders_traversal)
 
 User can choose to not traverse special files like symbolic links and packages
 
@@ -28,4 +28,4 @@ When this option is on if the file is a resource fork its size is determined fro
 </tr>
 </tbody>
 </table>
-</div>
+</div>

_includes/scripts.html

@@ -16,7 +16,9 @@
                     {% if site.minItemsToShowToc != null %}
                     minItemsToShowToc: {{ site.minItemsToShowToc }},
                     {% endif %}
-                    renderIn: '#toc-container'
+                    renderIn: '#toc-container',
+                    formatName: 'innerText',
+                    anchorPrefix: '',
                 });
             });
         </script>

add_anchor.js

@@ -0,0 +1,32 @@
+const readline = require('readline');
+const fs = require('fs');
+
+const readInterface = readline.createInterface({
+    input: fs.createReadStream('unixshell.md'),
+    // output: process.stdout,
+    console: false
+});
+
+let prevLine = null;
+
+
+readInterface.on('line', function(line) {
+	if (line[0] === '=') {
+		if (prevLine) {
+			const anchor = prevLine.toLowerCase().replace(/[^a-z0-9]+/g, '_');
+			console.log(`[${prevLine}](#${anchor})`);
+			prevLine = null;
+		}
+		console.log(line);
+	} else {
+		if (prevLine !== null) {
+			console.log(prevLine);
+		}
+		prevLine = line;
+	}
+});
+readInterface.on('close', function(line) {
+	if (prevLine) {
+		console.log(prevLine);
+	}
+});

add_anchor.sh

@@ -0,0 +1,79 @@
+#!/usr/bin/env bash
+# Add Markdown anchors to all Heading elements (only level 1 and level 2)
+# The "Heading Alternate Syntax" must have at least 4 = or - characters otherwise the anchor is not added
+
+if [ $# -eq 0 ]
+then
+	echo Missing file parameter
+	exit 1
+fi
+
+gawk '
+func toAnchor(str) {
+	// is already link
+	if (str ~ /^\s?\[/) {
+		return str;
+	}
+	anchor = tolower(str);
+	gsub(/[^a-z0-9]/, "_", anchor);
+	gsub(/_+$/, "", anchor);
+
+	return "[" str "](#" anchor ")";
+}
+
+func flush_buffer() {
+	# --line_index;
+	# line = lines[line_index];
+	# delete lines[line_index];
+	for (i = 0; i < line_index; i++) {
+		print lines[i];
+	}
+	line_index = 0;
+}
+
+func isHeaderAlreadySkipped(line) {
+	if (header_read) {
+		return 0;
+	}
+	print line;
+	if (line == "---") {
+		if (inside_header) {
+			header_read=1;
+		} else {
+			inside_header = 1;
+		}
+	}
+	return 1;
+}
+
+BEGIN { 
+	header_read = 0;
+	inside_header = 0;
+	line_index = 0;
+} 
+END { 
+	flush_buffer();
+}
+
+/^(##?)/ { 
+	if (!inside_header) {
+		flush_buffer();
+		line=$0;
+		gsub(/^#+/, "", line);
+		print toAnchor(line);
+	}
+} 
+/^(====+)|(----+)/ { 
+	--line_index;
+	last = lines[line_index];
+	delete lines[line_index];
+	flush_buffer();
+	print toAnchor(last);
+} 
+{
+	if (!isHeaderAlreadySkipped($0)) {
+		lines[line_index++] = $0;
+	}
+}' \
+$1 >$1.bak
+mv $1.bak $1

add_anchors.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# Add Markdown anchors to Heading elements (only levels 1 and 2)
+# The "Heading Alternate Syntax" must have at least four '=' or '-' characters otherwise the anchor is not added
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'fileutils'
+
+# rubocop:disable Metrics/MethodLength
+def read_header(source_file, dest_file)
+  line = source_file.gets
+
+  return line unless line && line.chomp == '---'
+
+  found_header_start = false
+  loop do
+    line.chomp!
+    dest_file.puts line
+    if line == '---'
+      return if found_header_start
+
+      found_header_start = true
+    end
+    break unless (line = source_file.gets)
+  end
+end
+# rubocop:enable Metrics/MethodLength
+
+def contain_link?(str)
+  str =~ /\[.*?\]\(.*?\)/
+end
+
+def to_anchor(str)
+  return str if contain_link?(str)
+
+  anchor = str.downcase
+              .gsub(/[^a-z0-9]+/, '_')
+              .gsub(/_+$/, '')
+
+  "[#{str}](##{anchor})"
+end
+
+def flush_buffer(buffer, dest_file)
+  buffer.each { |l| dest_file.puts l }
+  buffer.clear
+end
+
+def heading_hash_syntax(line, buffer, dest_file)
+  return false unless /^(====+)|(----+)/.match?(line)
+
+  last_line = buffer.pop
+  flush_buffer(buffer, dest_file)
+  dest_file.puts to_anchor(last_line)
+  dest_file.puts line
+  true
+end
+
+def heading_alternate_syntax(line, buffer, dest_file)
+  return false unless (m = line.match(/(^##?[^#])(.*)/))
+
+  flush_buffer(buffer, dest_file)
+  dest_file.puts "#{m[1]}#{to_anchor(m[2])}"
+  true
+end
+
+def markdown_headings(line, buffer, dest_file)
+  heading_hash_syntax(line, buffer, dest_file) || heading_alternate_syntax(line, buffer, dest_file)
+end
+
+def process_file(source_file, dest_file)
+  buffer = []
+
+  line = read_header(source_file, dest_file)
+  # check the first line after the header is a markdown heading
+  markdown_headings(line.chomp, buffer, dest_file) if line
+
+  while (line = source_file.gets)
+    line.chomp!
+
+    buffer << line unless markdown_headings(line, buffer, dest_file)
+  end
+
+  flush_buffer(buffer, dest_file)
+end
+
+if ARGV.empty?
+  puts 'Specify file'
+  exit 1
+end
+
+file = File.open(ARGV[0], 'r')
+temp_file = Tempfile.new('anchors')
+
+process_file(file, temp_file)
+
+file.close
+temp_file.close
+
+FileUtils.cp(temp_file.path, ARGV[0])
+temp_file.unlink

alignRules.md

@@ -10,7 +10,7 @@ subtitle: Change the default file names alignment method
 
 Before being compared two files they must be aligned, the alignment rule can be configured
 
-# Align by Name Case Sensitivity
+# [Align by Name Case Sensitivity](#align_by_name_case_sensitivity)
 
 The default alignment method compares file name strings, if they are match case then they will be aligned.  
 Suppose you have the scenario shown below
@@ -65,7 +65,7 @@ This can be achieved selecting 'Ignore File Name Case' from popup menu.</p>
     </table>
 </div>
 
-# Align by HFS+ Filesystem Case
+# [Align by HFS+ Filesystem Case](#align_by_hfs_filesystem_case)
 
 Normally the <acronym title="Hierarchical File System">HFS+</acronym> disks are formatted ignoring the file name case, so if we have winter.jpg and WINTER.JPG they cannot be created on same directory (because they have the same name).
 
@@ -79,7 +79,7 @@ It is possible to let VisualDiffer determine the file name alignment case algori
 
 If the last scenario is true, the alignment will try to be smart, first it searches if a match case is available (winter.jpg with winter.jpg) then it tries to align with the most similar name.
 
-# Align by User Defined Rules (required OSX Lion or above)
+# [Align by User Defined Rules (required OSX Lion or above)](#align_by_user_defined_rules_required_osx_lion_or_above)
 
 There are scenarios where it is necessary to align files having different names.  
 The most simple scenario has files with same name but different extension as shown below
@@ -138,15 +138,15 @@ Suppose you want to align ignoring the file extension to produce the result show
 
 This can be achieved using VisualDiffer 'user defined alignment rules'.
 
-## Managing Alignment Rules
+## [Managing Alignment Rules](#managing_alignment_rules)
 
 You can create, edit or delete rules from Session Preferences Dialog
 
 ![image]({{ site.prefixDir }}img/ternaryop/vd/screenshots/wiki/sessionPrefAlignment.png)
 
 More rules can be assigned to a VisualDiffer session comparison, they are evaluated from top to bottom.
 
-## Creating a Rule
+## [Creating a Rule](#creating_a_rule)
 
 When you add a new rule (or edit an existing one) you access to the dialog shown below
 
@@ -159,11 +159,11 @@ A rule has
 
 _If you are not familiar with regular expressions please refer to [ICU](http://userguide.icu-project.org/strings/regexp) documentation._
 
-## Left Regular Expression
+## [Left Regular Expression](#left_regular_expression)
 
 The left regexp is used to match a filename on the left side of VisualDiffer Folder View, we want to find all jpg files so we create a group `(.*)` followed by `.jpg` extension.
 
-## Right Pattern Expression
+## [Right Pattern Expression](#right_pattern_expression)
 
 Notice the right expression **isn't** a regular expression, it should contain some special patterns used to access to regular expression groups (if any).
 
@@ -201,6 +201,6 @@ But `002.jpg` and `002.RAW` files are not aligned because `002.RAW` extension is
 
 ![image]({{ site.prefixDir }}img/ternaryop/vd/screenshots/wiki/alignRuleIgnoreCase.png)
 
-## Test Rule
+## [Test Rule](#test_rule)
 
-It is possible to verify immediately if the expressions work as expected using the 'Test Rule', just type a file name and the 'Result' field will be filled accordingly.
+It is possible to verify immediately if the expressions work as expected using the 'Test Rule', just type a file name and the 'Result' field will be filled accordingly.