Skip to main content
A report says that default interest is 2 percent above the normal rate, and gives a link to a credit agreement of 96 pages. The reader who wants to check the sentence has to find the clause. A citation should end the search, not start it. Every passage that getclean returns has a place that stays the same, so a sentence of your report can lead straight to the words it rests on.

Take the place with the passage

Every way of reading a record returns the place of what it returns. A highlight has it, a filled field has it, and each block of the content has it. A place is not a count of characters. A count changes with every format, and a block does not.

Write the citation

Store with each sentence of the report what a reader needs to open it. A citation of the sentence about default interest can look like this.
A citation in your report
The first line is for a person. It comes from the section’s title and the printed page, which the place gives you. The rest is for a program.

Open a citation

To show the passage, read the block by its id from the stored record. The read costs nothing.
Replace CONTENTS_ID with the id of the record and BLOCK_ID with the id of the block, both from the citation. To show the passage in its surroundings, read its section with the highlight marks. For the request, see Highlight the evidence for each question.

Check a citation after the record is gone

A record is stored for 48 hours after its last use, and for at most 30 days. A report is read for years. The citation written in the form shown on this page still works, in 2 steps.
  1. Fetch the source again, and compare the new record’s fingerprint with the one in the citation. If the 2 are equal, the source has the same text as on the day of the report. Fingerprints can be compared only under the same version of getclean and its configuration, so send the citation’s version as pinned_version while that version is served.
  2. If the fingerprints differ, send the citation’s words to the new record as a highlight, with deterministic_only set to true. A highlight whose basis is exact or near says the passage is still there, and where it is now. The notice highlight_not_found says the source no longer has those words.
A reader then knows one of 3 things about a sentence of an old report: the source is unchanged, the passage is still there in a changed source, or the passage is gone. None of the 3 is a guess, and none needs a model. The step with baseline_fingerprint that saves the text of an unchanged page works only while the earlier record is stored. For that step, see Find the one cell that changed. For a source that must be shown as it was on the day of the report, ask for that day. See Time machine: read a page as it was on a past day.