add documentation for the URL array
authorChris Sharp <csharp@georgialibraries.org>
Wed, 5 Sep 2018 11:55:43 +0000 (07:55 -0400)
committerChris Sharp <csharp@georgialibraries.org>
Wed, 5 Sep 2018 11:55:43 +0000 (07:55 -0400)
pines-finder/report_owner_from_url.pl

index 3cee7d4..5bc35bc 100755 (executable)
@@ -56,6 +56,14 @@ my $query = qq/ select r.name as report_name,
 my @path_array = $url->path_components;
 
 # example URL: https://gapines.org/reporter//58631/126950/876937/report-data.html
+# breakdown for the array:
+# https://gapines.org = 0 - base URL
+# /reporter = 1  - directory path
+# / = (possibly not present) = 2 - extra dir added by clark_kent.pl (possibly a bug to file?)
+# /58631 = 3 (or 2) - template ID
+# /126950 = 4 (or 3) - report ID
+# /876937 = 5 (or 4) - output ID
+
 
 my $report;
 # it's possible that the URL has an extra empty