CaseLeaf

Handbook / The `share` command

The share command

The client should see your questions and none of your working notes.

Writes a copy carrying only the marks that were put up for discussion. It is what talk is for: a review has working notes and questions for other people, and only the second kind should leave. Use it instead of sending the document and asking people to ignore half of it.

How you run it

caseleaf share report.pdf --to copy.pdf

caseleaf share report.pdf --to copy.pdf --as Reviewer

What each part means

In full, every part it will take:

caseleaf share <file> --to <copy.pdf> [--as <name>]
part what it is for
<file> The PDF to work on, as a path: report.pdf beside you, or the full path to it. The copy goes to --to, but this is the one command with a --to that can still write to the document you named: a thread the copy has to refer to must be named at both ends, so any name minted here is written back. The answer says how many, so it is never silent about it.
--to Where to write the result, as a path. The shape above shows which format this command writes. This command needs it, and writes only there: the document you named is left exactly as it was.
--as Whose name the mark is made in, as in --as Reviewer. Left out, whoever this machine belongs to, unless writing names has been turned off in Settings, and then the mark carries none.

What comes back

Asked of a short sample document, it answers as below. The sample has eight sheets, a highlight and a note left by a reviewer, a web link, a small table, two pictures and one form field already filled in.

{
  "keptBack" : 2,
  "namedInSource" : 0,
  "shared" : 0,
  "wrote" : "copy.pdf"
}

The same thing from AppleScript

Everything above can be asked for from a script instead. There is one AppleScript command, perform: on names the document, and options takes the rest exactly as you would type it.

tell application "CaseLeaf"
    perform "share" on "/path/to/report.pdf" ¬
        options "--to copy.pdf"
end tell

tell application "CaseLeaf"
    perform "share" on "/path/to/report.pdf" ¬
        options "--to copy.pdf --as Reviewer"
end tell

All the commands · Asking from a script · Contents