feat: better display of not exist embed

Author: Mara-Li

README.md

@@ -36,7 +36,11 @@ Intended to be used by obsidian user.
 The plugin will create :
 - A link to the original file, with the form of : `<a href="original link" class="link_citation"><i class='fas fa-link'></i></a>`
 - A div with the founded content : `<div class="citation">content founded</div>`
-- In case of the link / contents is not found : `<div class="not_found">filename#part</div>`
+- In case of the link / contents is not found the following block is created instead :
+   ```html
+   <div class='citation'><a class='link_citation'><i class='fas fa-link'></i></a><p style="text-align: center; display: block"><i class="not_found"> link_alt </i> {a configured message}</p></div>
+   ```      
+  The message for the not found file can be customized in `mkdocs.yml`. The default message is `file not exists`.
 
 You can add a css in your `docs/assets/css` (or whatever the path is), and add it to your `mkdocs.yml` :
 ```yml 
@@ -65,6 +69,7 @@ plugins:
    - embed_file:
         callouts: true
         custom-attribute: 'assets/css/custom_attributes.css' //need to be the same as in the config!
+        language_message: 'file not exists.'
 ```
 
 # Limitation

mkdocs_embed_file_plugins/plugin.py

@@ -106,7 +106,7 @@ def strip_comments(markdown):
     markdown = re.sub(r'%%(.*)%%', '', markdown, flags=re.DOTALL)
     return markdown
 
-def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr) -> BeautifulSoup:
+def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr, msg) -> BeautifulSoup:
     """Append the content of the founded file to the original file.
 
     Args:
@@ -138,8 +138,11 @@ def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr)
     contents = frontmatter.loads(text).content
     quote = search_in_file(citation_part, contents)
     tooltip_template = (
-            "<div class='not_found'>" +
-            str(unquote(link['alt'].replace('/', ''))) + '</div>'
+            "<div class='citation'> <a href='"
+            + str(link['src'])
+            + "' class='link_citation'><i class='fas fa-link'></i> </a>"
+            + str(link['alt']) + ' not exists.'
+            + '</div>'
     )
     if len(quote) > 0:
         if callouts:
@@ -178,20 +181,19 @@ def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr)
                 )
                 + '</div>'
             )
+            new_soup = str(soup).replace(str(link), str(tooltip_template))
+            soup = BeautifulSoup(new_soup, 'html.parser')
+            return soup
     else:
         print('**** Citation not found **** : ' + unquote(citation_part), 'for : ', str(md_link_path), ' with link: ' + str(link) + ' and new_uri: ' + str(new_uri), ' and quote: ' + str(quote))
-        tooltip_template = (
-            "<div class='not_found'>" +
-            str(unquote(link['alt'].replace('/', ''))) + '</div>'
-        )
-    new_soup = str(soup).replace(str(link), str(tooltip_template))
-    soup = BeautifulSoup(new_soup, 'html.parser')
-    return soup
+        return tooltip_not_found(link, soup, msg)
+
 
-def tooltip_not_found(link, soup) -> BeautifulSoup:
+def tooltip_not_found(link, soup, msg) -> BeautifulSoup:
     tooltip_template = (
-            "<div class='not_found'>" +
-            str(unquote(link['alt'].replace('/', ''))) + '</div>'
+            "<div class='citation'> <a class='link_citation'><i class='fas fa-link'></i> </a>"
+            + '<p style="text-align: center; display: block"><i class="not_found">' + str(link['alt']) + f'</i> {msg}</p>'
+            + '</div>'
     )
     new_soup = str(soup).replace(str(link), str(tooltip_template))
     soup = BeautifulSoup(new_soup, 'html.parser')
@@ -215,7 +217,8 @@ def search_file_in_documentation(link: Union[Path,str], config_dir: Path) -> Uni
 class EmbedFile(BasePlugin):
     config_scheme = (
         ('callouts', config_options.Type(bool, default=False)),
-        ('custom-attributes', config_options.Type(str, default=''))
+        ('custom-attributes', config_options.Type(str, default='')),
+        ('language_message', config_options.Type(str, default='file not exists')),
     )
 
     def __init__(self):
@@ -227,6 +230,7 @@ def on_post_page(self, output_content, page, config) -> str:
         docs = Path(config['docs_dir'])
         md_link_path = ''
         callout = self.config['callouts']
+        language_message = self.config['language_message']
         for link in soup.findAll(
                 'img',
                 src=lambda src: src is not None 
@@ -270,7 +274,7 @@ def on_post_page(self, output_content, page, config) -> str:
                 )
                 md_link_path = Path(unquote(md_link_path)).resolve()
             if (md_link_path == 0):
-                soup = tooltip_not_found(link, soup)
+                soup = tooltip_not_found(link, soup, language_message)
             if  (md_link_path != '' or md_link_path == 0) and len(link['src']) > 0:
                 if '#' in link.get('alt', ''):
                     # heading
@@ -284,10 +288,10 @@ def on_post_page(self, output_content, page, config) -> str:
 
                     if os.path.isfile(md_link_path):
                         soup = cite(md_link_path, link, soup,
-                                    citation_part, config, callout, self.config['custom-attributes'])
+                                    citation_part, config, callout, self.config['custom-attributes'], language_message)
                     else:
                         link_found=search_file_in_documentation(md_link_path, docs)
                         if link_found != 0:
                             soup = cite(link_found, link, soup,
-                                        citation_part, config, callout, self.config['custom-attributes'])
+                                        citation_part, config, callout, self.config['custom-attributes'], language_message)
         return str(soup)