From 1859c26bd91dab06d496783a4e33aa0ec431f75f Mon Sep 17 00:00:00 2001 From: Miguel de Benito Date: Sun, 31 Mar 2013 14:01:22 +0000 Subject: [PATCH] Some partial documentation for urls --- devel/scheme/api/api.en.tm | 4 +- devel/scheme/api/link.en.tm | 41 -------------- devel/scheme/api/url.en.tm | 103 ++++++++++++++++++++++++++++++++++++ 3 files changed, 105 insertions(+), 43 deletions(-) delete mode 100644 devel/scheme/api/link.en.tm create mode 100644 devel/scheme/api/url.en.tm diff --git a/devel/scheme/api/api.en.tm b/devel/scheme/api/api.en.tm index 28ed813..c5650ae 100644 --- a/devel/scheme/api/api.en.tm +++ b/devel/scheme/api/api.en.tm @@ -16,7 +16,7 @@ <\traverse> : the file system.|tmfs/tmfs.en.tm> - + team> @@ -27,4 +27,4 @@ Foundation; with no Invariant\nSections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of\nthe license is included in the section entitled "GNU Free Documentation License".> - \ No newline at end of file + diff --git a/devel/scheme/api/link.en.tm b/devel/scheme/api/link.en.tm deleted file mode 100644 index 9d86ee8..0000000 --- a/devel/scheme/api/link.en.tm +++ /dev/null @@ -1,41 +0,0 @@ - - - - -<\body> - - - There is currently no comprehensive documentation for the link system. In - the meantime, we'll collect here documentation for procedures related to - it. - - <\explain> - . )> - <|explain> - Opens a new buffer with the contents of the resource at . This - can be either a full or a file path, absolute or relative to - the current . Both types of argument accept - parameters. The second, optional argument, is an optional path for the - cursor history. - - You can pass paramenters in in two ways: appending a hash - and some text, like in will open - the file and jump to the first label of name found, if any. The - other possibility is the usual way in the web: append a question mark - followed by pairs . Currently the parameters - and are supported by default for any file of format - (see ). - - - \; - - team.> - - - \ No newline at end of file diff --git a/devel/scheme/api/url.en.tm b/devel/scheme/api/url.en.tm new file mode 100644 index 0000000..5e7663b --- /dev/null +++ b/devel/scheme/api/url.en.tm @@ -0,0 +1,103 @@ + + + + +<\body> + + + There is currently no comprehensive documentation for the url system. In + the meantime, we'll collect here documentation for procedures related to + it. + + + + <\explain> + . )> + <|explain> + Opens a new buffer with the contents of the resource at . This + can be either a full or a file path, absolute or relative to + the current . Both types of argument accept + parameters. The second, optional argument, is an optional path for the + cursor history. + + You can pass paramenters in in two ways: appending a hash + and some text, like in will open + the file and jump to the first label of name found, if any. The + other possibility is the usual way in the web: append a question mark + followed by pairs . Currently the parameters + , and , which respectively jump to the + chosen location and select the given text at that line, are supported by + default for any file of format . (see + ). + + + + + <\explain> + )> + <|explain> + \; + + + <\explain> + )> + <|explain> + \; + + + <\explain> + )> + <|explain> + Return if the url is absolute. Absolute urls may be for instance + full paths in the file system or internet s starting with a + protocol specification like or . The urls are + also understood to be rooted. See also , + and . + + + <\explain> + )> + <|explain> + \; + + + <\explain> + )> + <|explain> + Applies only to filesystem urls. Returns if the url is a regular + file, otherwise. See also and + . + + + <\explain> + )> + <|explain> + Applies only to filesystem urls. Returns if the url is a + directory, otherwise. + + + <\explain> + )> + <|explain> + Applies only to filesystem urls. Returns if the url is a + symbolic link, otherwise. + + + team.> + + + + + +> \ No newline at end of file