1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-16 10:29:54 +00:00

added documentation

temporary documentation demo:
http://goto.bplaced.net/tw5/5.1.7.html#ResolvePath
This commit is contained in:
Tobias Beer 2015-02-03 15:18:38 +01:00
parent 4a05bd10e9
commit e4bd0c8633
2 changed files with 25 additions and 2 deletions

View File

@ -1,5 +1,5 @@
/*\
title: $:/core/modules/macros/resolvePath.js
title: $:/core/modules/macros/resolvepath.js
type: application/javascript
module-type: macro
@ -12,7 +12,7 @@ Resolves a relative path for an absolute rootpath.
/*global $tw: false */
"use strict";
exports.name = "resolvePath";
exports.name = "resolvepath";
exports.params = [
{name: "source"},

View File

@ -0,0 +1,23 @@
created: 20150203152000000
modified: 20150203152000000
title: ResolvePath
type: text/vnd.tiddlywiki
caption: resolvepath
The ''resolvepath'' macro constructs a url for a relative source path with respect to an absolute root path, trailing filenames being cut-off.
! Parameters
|!Position |!Name |!Description |!Default |
|1st |source |the relative path to be appended| |
|2nd |root |the absolute path to be appended to | |
! Examples
A trivial example to show how the macro works:
```
<<resolvepath "./backup" "http://mysite.com/store.php">>
```
<<resolvepath "./backup" "http://mysite.com/store.php">>