link_gen: added priority field to link data that can control link order of similar link/title data

Signed-off-by: Hofi <hofione@gmail.com>

Author: HofiOne

_plugins/generate_links.rb

@@ -21,6 +21,7 @@ def write_yaml_file(file_path, data)
           file.write("id: " + data["id"] + "\n")
           file.write("url: " + data["url"] + "\n")
           file.write("title: " + data["title"] + "\n")
+          file.write("pri: " + data["pri"].to_s + "\n")
         end
         #puts file_path
       end
@@ -88,6 +89,7 @@ def generate_links(page, ids, titles)
                 "id" => page_id + "##{heading_id}",
                 "url" => page_url + "##{heading_id}",
                 "title" => '"' + render_title(page, heading.text) + '"',
+                "pri" => 50,
               }
               #register_id(page, link_data["id"], link_data["title"], ids, titles)
 
@@ -111,6 +113,7 @@ def generate_links(page, ids, titles)
               "id" => anchor_id,
               "url" => page_url + "##{anchor_name}",
               "title" => '"' + (anchor_text.empty? ? anchor_id : render_title(page, anchor_text)) + '"',
+              "pri" => 50,
             }
             #register_id(page, link_data["id"], link_data["title"], ids, titles)
 
@@ -125,11 +128,29 @@ def generate_links(page, ids, titles)
             "id" => page_id,
             "url" => page_url,
             "title" => '"' + page_title + '"',
+            "pri" => 50,
           }
           register_id(page, page_link_data["id"], page_link_data["title"], ids, titles)
 
           # Write data to separate YAML file for each page
-          page_file_path = "#{page_id}.#{link_ext}"
+          page_file_path = "#{page_link_data["id"]}.#{link_ext}"
+          page_file_path = "_data/links/" + page_file_path.gsub(/\/|:|\s/, "-").downcase
+          write_yaml_file(page_file_path, page_link_data)
+
+          # Create links data for the page short_title too
+          page_short_title = page.data["short_title"]
+          if page_short_title and not page_short_title.empty?
+            page_link_data = {
+              "id" => page_id + "_short_title",
+              "url" => page_url,
+              "title" => '"' + page_short_title + '()"',
+              "pri" => 100,
+            }
+            register_id(page, page_link_data["id"], page_link_data["title"], ids, titles)
+          end
+
+          # Write data to separate YAML file for each page short_title
+          page_file_path = "#{page_link_data["id"]}.#{link_ext}"
           page_file_path = "_data/links/" + page_file_path.gsub(/\/|:|\s/, "-").downcase
           write_yaml_file(page_file_path, page_link_data)
 

_plugins/generate_tooltips.rb

@@ -308,6 +308,7 @@ def filtered_page_ids_sorted_by_title_len(page_links)
         page_links.each do |page_id, page_data|
           #puts "page_id: #{page_id}, page_data: #{page_data}"
           titles = page_data["title"]
+          pri = page_data["pri"]
 
           titles.each do |title|
             # Skip excluded titles
@@ -316,15 +317,16 @@ def filtered_page_ids_sorted_by_title_len(page_links)
             sorted_arr << page_link_data = {
               "id" => page_id,
               "title" => title,
+              "pri" => pri,
             }
           end
         end
 
-        # With this reversed length sort order we try to guarantie that
+        # With this reversed length sort order we try to guarantee that
         # the autolink/tooltip title pattern matching finds titles like
         # 'Soft macros' before 'macros'
         # In most of the cases matching the longer titles first will eliminate such issues
-        sorted_arr.sort_by { |page| page["title"].length }.reverse
+        sorted_arr.sort_by { |page| [page["title"].length, page["pri"].to_i] }.reverse
 
         # Just for debugging
         # sorted_arr.each do |data|
@@ -348,6 +350,7 @@ def gen_page_link_data(links_dir, link_files_pattern)
           page_url = yaml_content['url']
           page_title = yaml_content['title']
           open_in_blank = yaml_content['open_in_blank']
+          page_pri = yaml_content['pri']
           chars_to_remove = %{"'}
           page_title = page_title.gsub(/\A[#{Regexp.escape(chars_to_remove)}]+|[#{Regexp.escape(chars_to_remove)}]+\z/, '')
           #puts "page_title: " + page_title
@@ -360,6 +363,7 @@ def gen_page_link_data(links_dir, link_files_pattern)
           page_link_data = {
             "id" => page_id,
             "url" => page_url,
+            "pri" => (page_pri ? page_pri : 50),
             "title" => [ page_title ],
             "open_in_blank" => open_in_blank,
           }