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

Missing anchor in docs for _status_data? #1957

Closed
jimklimov opened this issue Jun 5, 2023 · 5 comments · Fixed by #1959
Closed

Missing anchor in docs for _status_data? #1957

jimklimov opened this issue Jun 5, 2023 · 5 comments · Fixed by #1959
Labels
documentation Low-hanging fruit A proposal or issue that is good for newcomers to codebase or otherwise a quick win
Milestone

Comments

@jimklimov
Copy link
Member

jimklimov commented Jun 5, 2023

docs/nut-names.txt refers from ups.status entry to _status_data anchor, I think, but I did not find such tag elsewhere in the sources. I believe it should be in new-drivers.txt description of working with statuses.

Need to cross-check with rendered docs on site, and maybe add the anchor to that chapter.

Per original question on IRC, this info also needs to be referenced from upslog documentation as a legend to states that can be seen in the log.

@jimklimov jimklimov added documentation Low-hanging fruit A proposal or issue that is good for newcomers to codebase or otherwise a quick win labels Jun 5, 2023
@jimklimov jimklimov added this to the 2.8.1 milestone Jun 5, 2023
@jimklimov
Copy link
Member Author

Confirmed, currently published https://networkupstools.org/docs/developer-guide.chunked/apas02.html and https://networkupstools.org/docs/developer-guide.pdf include the table "A.2.2 ups: General unit information" with a rendered link from "ups.status ... OL" example, which leads nowhere.

@jimklimov
Copy link
Member Author

That's odd: the anchor _status_data should get generated implicitly with presence of a header named Status Data in the document, to the extent that adding one explicitly does break the ASCIIDOC XML validation step.

In fact, the proper URL is present in single-HTML build of developer guide - but absent/dysfunctional in the single-PDF and chunked-HTML renditions.

I can define and explicitly add a [[status-data]] anchor and refer to it from docs/nut-names.txt instead of the original underscored anchor:

| ups.status            | UPS status                   | linkdoc:developer-guide[OL,status-data]  

...but the results behave the same (single-HTML link changes and works; two others remain invalid).

@jimklimov jimklimov changed the title Missing anchor in docs for _status_data Missing anchor in docs for _status_data? Jun 5, 2023
@jimklimov
Copy link
Member Author

However changing the link markup from the custom linkdoc macro to angle brackets "just works" for all three rendered documents. @aquette : can you weigh in with any insight on this, please?

-| ups.status            | UPS status                   | linkdoc:developer-guide[OL,_status_data]
+| ups.status            | UPS status                   | <<_status_data,OL>>

@arnaudquette-eaton
Copy link
Contributor

@arnaudquette-eaton
Copy link
Contributor

and you're hitting the limit I've been hitting. No basic solution on my side, apart from a variable linkdoc macro that get the right page+anchor in chunked format

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Low-hanging fruit A proposal or issue that is good for newcomers to codebase or otherwise a quick win
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants