Changes between Version 4 and Version 5 of MyPagePlugin


Ignore:
Timestamp:
Oct 12, 2012 3:07:35 PM (2 years ago)
Author:
cboos
Comment:

inline README.wiki (adapt to the older syntax)

Legend:

Unmodified
Added
Removed
Modified
  • MyPagePlugin

    v4 v5  
    1010 
    1111 
     12Excerpt from the README.wiki: 
     13---- 
     14=== Introduction === 
     15 
     16Simple plugin designed to help you maintain a "journal" of your daily 
     17activities with wiki pages. The main idea is to have a main navigation 
     18link named ''`MyPage`'' which takes you to your "page of the day", in 
     19edit mode. 
     20 
     21If that page doesn't exist already, it will be filled with the content 
     22of a !PageTemplates, but with a twist: some tokens will be 
     23automatically replaced, in particular for giving you the possibility 
     24to include or refer to the previous page of the day... 
     25 
     26The intended use is to have a quick but effective way to track the 
     27ongoing activities of the day in the form of free wiki markup, and to 
     28easily keep a continuity with the activity that occurred the days 
     29before. 
     30 
     31Works best with the TH:WikiExtrasPlugin and its !WikiPhrases... 
     32 
     33=== Detailed mode of operation === 
     34 
     35When clicking on a ''`MyPage`'' top-level navigation link, one will 
     36return to the edit preview mode of the "page of the day", which is a 
     37normal wiki page of the form `/wiki/<userid>/<iso8601-date>`. If that 
     38page doesn't yet exist, it will be created, eventually using an 
     39appropriate page template (`PageTemplates/MyPage/<userid>` or 
     40`PageTemplates/MyPage` - see !PageTemplates). 
     41 
     42(Technically, this is achieved by redirecting the `/mypage` URL to the 
     43actual page of the day with `?action=edit`) 
     44 
     45Moreover those templates can contain some special markup which will 
     46get replaced by dynamic content when inserted as the initial content 
     47of the page of the day. The macro `[[MyPageHelp]]` lists the available 
     48tokens: ![[MyPageHelp]] 
     49 
     50This replacement will only happen when creating the ''page of the 
     51day''. If one wants to create such pages as normal wiki pages, retro- 
     52or pro-actively, the page will start empty or using the normal 
     53!PageTemplates filling mechanism, i.e. no expansion of these tokens 
     54will take place. 
     55 
     56---- 
    1257 
    1358== Bugs/Feature Requests ==  
     
    3479 
    3580The page `PageTemplates/MyPage` would typically contain something like this: 
     81 
    3682{{{ 
    3783= $MYPAGE_USER: $MYPAGE_DATE ($MYPAGE_ISODATE)