HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

changed the file from url-checker to title-checker since it checks titles, not urls.

Browse Source
This commit is contained in:
Tom Johnson
2015-09-13 19:54:14 -07:00
parent b728e31805
commit 7e1c0479db
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc_link_validation.md
View File

@ -13,13 +13,13 @@ Additionally, technical writers frequently manage large numbers of topics, and a
During this time, if you have inline links that point to specific pages, how do you avoid broken links in your output?
## Use the URL checker
## Use the title checker
The theme has a file called url-checker.html. This file will iterate through all the pages listed in the sidebar navigation and top navigation, and compare the navigation titles against the page titles based on matching URLs. If there are inconsistencies in the titles, they get noted on the url-checker.html page.
The theme has a file called title-checker.html. This file will iterate through all the pages listed in the sidebar navigation and top navigation, and compare the navigation titles against the page titles based on matching URLs. If there are inconsistencies in the titles, they get noted on the title-checker.html page.
To run the link checker, just build or serve your project, and go to url-checker.html in your browser (such as Chrome). If there are inconsistencies, they will be noted on the page.
To run the link checker, just build or serve your project, and go to title-checker.html in your browser (such as Chrome). If there are inconsistencies, they will be noted on the page.
Note that in order for the URL checker to run correctly, it has to detect a match between the URL listed in the sidebar or top navigation with the URL for the page (based on the file name). If you have the wrong URL, it won't tell you if the page titles match. Therefore you should always click through all the topics in your navigation to make sure the URLs are accurate.
Note that in order for the title-checker file to run correctly, it has to detect a match between the URL listed in the sidebar or top navigation with the URL for the page (based on the file name). If you have the wrong URL, it won't tell you if the page titles match. Therefore you should always click through all the topics in your navigation to make sure the URLs are accurate.
## Generate a PDF

4
url-checker.html → title-checker.html
View File

@ -4,10 +4,10 @@ search: exclude
---
<html>
<head>
<title>URL checker</title>
<title>Page checker</title>
</head>
<body>
<h2>URL Checker Report</h2>
<h2>Page Checker Report</h2>
{% include custom/conditions.html %}
{% for entry in sidebar %}