This bug lists a number of places where the documentation uses hard-coded AsciiDoc links ("link:file_name.txt[Click here]"), where it would be better to use AsciiDoc cross references ("xref:my-section-id[Click here]"). This is probably an intermediate level docs bug, since it requires finding the section-id in the published docs (look inside the section heading for the "<a id=" tag; you want the value of the id attribute). This bug also requires testing of the docs after they are built and published overnight. For more information on link syntax, see the "Linking" section of the Evergreen documentation style guide:
http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig_style_guide&#linking
Here are the bugs
-----------------
acquisitions/introduction.txt:
"(see link:../installation/edi_setup.txt[Setting Up EDI Acquisitions] under Software Installation)"
acquisitions/introduction.txt:
"(see link:../cataloging/batch_importing_MARC.txt[Batch Importing MARC Records] in Cataloging)"
acquisitions/selection_lists_po.txt:
"when you link:brief_records.txt[Add Brief Records], or...through the link:federated.txt[MARC Federated Search]"
acquisitions/selection_lists_po.txt:
"one of three ways: link:brief_records.txt[add a brief record]; upload MARC order records; add records through a link:federated.txt[federated search]; or use the link:federated.txt[View/Place Orders] menu item in the catalog."
acquisitions/selection_lists_po.txt:
"See the section on link:03~PO.txt[purchase orders] for more information."
acquisitions/selection_lists_po.txt:
"See the link:line_items.txt[section on Line Items] for more information."
acquisitions/selection_lists_po.txt:
"See the link:line_items.txt[section on Line Items] for more information."
admin/acquisitions_admin.txt:
"also the link:../installation/edi_setup.txt[EDI Installation Instructions]"
circulation/holds.txt:
"see the link:_managing_holds.html#_actions_for_selected_holds[Actions for Selected Holds] section."
(Note: With "xref" syntax, you can link directly to the section, so this will probably become "xref:_actions_for_selected_holds[Actions for Selected Holds]".)
serials/A-intro.txt:
"link:_generate_prediction.html[explained here]"
serials/B-copy_template.txt:
"see the chapter on link:_floating_groups.html[Floating Groups]."
serials/C-subscription-SCV.txt:
"see link:_creating_a_stream.html[Creating a Stream]."
serials/D-subscription-ASCV.txt:
"See link:_alternate_serial_control_view.html#_creating_a_subscription[] for more information."
Hi Josh,
I noticed you assigned yourself to this bug, but the fix was actually just pushed into the master earlier this week. Looks like we forgot to update the LP bug. I'll do so now.
Kathy