Tor Manual:Add TOC and Cross-Reference links

• Add a TOC to the HTML Tor Manual page
• Add links to existing cross-refs.

Trac:
Username: swati

changed milestone to %Tor: 0.4.4.x-final

added component::core tor/tor documentation gsod manpage milestone::Tor: 0.4.4.x-final priority::medium reporter::swati resolution::implemented reviewer::catalyst reviewer::nickm severity::normal status::closed tor-client type::task labels

Trac:
Username: swati
Keywords: N/A deleted, tor-client, documentation, manpage added

Please review PR: https://github.com/torproject/tor/pull/1759

• Added a TOC for easy scrolling on the HTML page.
• Standardized the cross-reference format.
• Added hyperlinks to all cross-refs within the doc.

Trac:
Username: swati
Status: new to needs_review

Trac:
Username: swati
Reviewer: N/A to catalyst, nickm

It looks like asciidoc on travis is giving these errors:

asciidoc: ERROR: tor.1.txt: line 14: name section expected
asciidoc: FAILED: tor.1.txt: line 14: section title expected

Anything we can do about that?

Replying to nickm:

It looks like asciidoc on travis is giving these errors: {{{ asciidoc: ERROR: tor.1.txt: line 14: name section expected asciidoc: FAILED: tor.1.txt: line 14: section title expected }}}

Anything we can do about that?

It looks like asciidoc wants a blank line before the == NAME section header. I can make that change along with adding a changes file.

Replying to catalyst:

Replying to nickm:

It looks like asciidoc on travis is giving these errors: {{{ asciidoc: ERROR: tor.1.txt: line 14: name section expected asciidoc: FAILED: tor.1.txt: line 14: section title expected }}}

Anything we can do about that?

It looks like asciidoc wants a blank line before the == NAME section header. I can make that change along with adding a changes file.

Thanks for doing this, catalyst.

Trac:
Username: swati

Updated pull request at https://github.com/torproject/tor/pull/1761

Please merge that one.

Trac:
Status: needs_review to merge_ready

Merged!

Trac:
Resolution: N/A to implemented
Status: merge_ready to closed

Trac:
Milestone: N/A to Tor: 0.4.4.x-final

Trac:
Component: Core Tor to Core Tor/Tor

Trac:
Keywords: N/A deleted, gsod added

closed

moved to tpo/core/tor#33369 (closed)