Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Special Characters and Broken Links #1

Merged
merged 1 commit into from
Jul 8, 2023
Merged

Conversation

jhauga
Copy link
Owner

@jhauga jhauga commented Jul 8, 2023

Pull Summary

Special Characters and Links: 2 scripts added, and Makefile edited.

This pull request contains "jhauga-resolveOptionLinks" branch with:

  1. Two supporting script files added that edit .dump file after nroff build.
  2. Makefile edited to run two supporting scripts after build.
  3. Example folder with proof of concept of support scripts used in Makefile.

Branch Summary - jhauga-resolveOptionLinks

Files added/edited:

  1. Makefile
    • Line 28 - @./fixSpecialCharacters.sh
    • Line 29 - @./fixBrokenLinks.sh
  2. fixSpecialCharacters.sh
    • Prompts for input, asking if ther are options with special characters.
    • If so will run several "sed" statements to replace accordingly.
    • Provides additional variable (commented out) for custom generation.
  3. fixBrokenLinks.sh
    • fixes encoded html characters rendered by noffit that cause broken links.
    • Voids (javascript:coid(0)) unwanted links.
  4. examples_DELETE_ME
    • Example folder with proof of concept of supporting scripts used in Makefile.
    • For more details see "README.md" included in folder.

Resolves

This pull request will resolve:

  1. roffit issue #36
  2. curl issue #11381

# Pull Summary
Special Characters and Links: 2 scripts added, and Makefile edited.

This pull request contains **"jhauga-resolveOptionLinks"** branch with:
1. Two supporting script files added that edit .dump file after 
nroff build. 
2. Makefile edited to run two supporting scripts after build. 
3. Example folder with proof of concept of support scripts used 
in Makefile.

## Branch Summary - jhauga-resolveOptionLinks
Files added/edited:
1. Makefile
   - Line 28 - \@.\/fixSpecialCharacters.sh
   - Line 29 - \@.\/fixBrokenLinks.sh
2. fixSpecialCharacters.sh
   - Prompts for input, asking if ther are options with special characters.
   - If so will run several "sed" statements to replace accordingly.
   - Provides additional variable (*commented out*) for custom generation.
3. fixBrokenLinks.sh
   - fixes encoded html characters rendered by noffit that cause broken links.
   - Voids (*javascript:coid(0)*) unwanted links.
4. examples_DELETE_ME
   - Example folder with proof of concept of supporting scripts used in Makefile.
   - For more details see **"README.md"** included in folder.

## Resolves
This pull request will resolve:
1. [roffit issue bagder#36](bagder#36)
2. [curl issue #11381](curl/curl#11381)
@jhauga jhauga merged commit 6cf7c2e into master Jul 8, 2023
@jhauga jhauga deleted the jhauga-resolveOptionLinks branch July 12, 2023 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant