doclicense: provide URL to legalcode

[cdlm]

The URL in \doclicenseURL points to the online human-readable description of the license.

It would be nice to provide a similar macro that points to the online full text of the license (ending in /legalcode instead of e.g. /deed.en).

[ypid]

Could be done with an optional parameter I guess. \doclicenseURL would default to the overview page and \doclicenseURL[full-license] could expand to the full license text. Want to give it a try?

[cdlm]

Sure 👍
Not before later this week, though, so feel free to go forward if you get the time before me.

[sammaddens]

One possibility is to define two new commands \doclicenseURLS (deed = Short) and \doclicenseURLL (legalcode = Long). The original \doclicenseURL gives the one from the package settings. Change the code as follows.

• Add the option urlform with deed as default.

  \DeclareStringOption[deed]{urlform}

• Change the code of doclicense@UrlLangPart for setting up the correct URL path.

      \ifcsdef{doclicense@UrlLangPart}{}{%
      \ifthenelse{\equal{\doclicense@lang@lic@CC@code}{}}{%
        \edef\doclicense@UrlLangPart{}
      }{%
        \edef\doclicense@UrlLangPart{/\doclicense@urlformUsed.\doclicense@lang@lic@CC@code}%COMMENT Replaced "deed" by "\doclicense@urlformUsed"
      }

• Replace \doclicense@set with the code below to define all the URL commands.

  \newcommand{\doclicenseUrlform@set}{%
    \let\doclicenseURL\undefined%
    \let\doclicense@UrlLangPart\undefined%
    \edef\doclicense@urlformUsed{deed}%
    \doclicense@set%
    \edef\doclicenseURLS{\doclicenseURL}%
    %
    \let\doclicenseURL\undefined%
    \let\doclicense@UrlLangPart\undefined%
    \edef\doclicense@urlformUsed{legalcode}%
    \doclicense@set%
    \edef\doclicenseURLL{\doclicenseURL}%
    %
    \let\doclicenseURL\undefined%
    \let\doclicense@UrlLangPart\undefined%
    \edef\doclicense@urlformUsed{\doclicense@urlform}%
    \doclicense@set%
    %
    \ifthenelse{\equal{\doclicense@urlform}{deed}}{}{%
      \ifthenelse{\equal{\doclicense@urlform}{legalcode}}{}{%
        \PackageWarningNoLine{doclicense}{"\doclicense@urlform" is not a supported urlform. Please use "deed" or "legalcode"}%
      }%
    }%
  }
  
  \doclicenseUrlform@set%

[ypid]

One possibility is to define two new commands \doclicenseURLS (deed = Short) and \doclicenseURLL (legalcode = Long). The original \doclicenseURL gives the one from the package settings. Change the code as follows.

I am not sure about this. I would rather prefer \doclicenseURL[legalcode] and \doclicenseURL[deed] as I suggested above. This should help keep doclicense generic. Maybe there will be a third URL variant. Maybe other license types (like the GPL) do this differently. Feel free to work on this and open a pull request.