Soks 0.0.7 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. data/LICENSE.txt +2 -0
  2. data/README.txt +3 -2
  3. data/TODO.txt +31 -0
  4. data/bin/soks-create-wiki.rb +0 -1
  5. data/lib/authenticators.rb +30 -4
  6. data/lib/helpers/counter-helpers.rb +132 -0
  7. data/lib/helpers/default-helpers.rb +170 -169
  8. data/lib/helpers/mail2wiki-helper.rb +18 -22
  9. data/lib/helpers/maintenance-helpers.rb +149 -0
  10. data/lib/helpers/rss2wiki-helper.rb +7 -8
  11. data/lib/soks-model.rb +82 -54
  12. data/lib/soks-servlet.rb +126 -108
  13. data/lib/soks-storage.rb +74 -11
  14. data/lib/soks-utils.rb +77 -3
  15. data/lib/soks-view.rb +169 -103
  16. data/lib/soks.rb +5 -23
  17. data/templates/default/attachment/newpage.js +4 -13
  18. data/templates/default/attachment/print_stylesheet.css +2 -7
  19. data/templates/default/caches/readme.txt +1 -0
  20. data/templates/default/content/Api%20for%20classes%20to%20modify%20the%20wiki.textile +2 -0
  21. data/templates/default/content/Author.textile +4 -1
  22. data/templates/default/content/Automatic%20Summaries.textile +16 -53
  23. data/templates/default/content/Automatic%20linking%20between%20pages.textile +3 -3
  24. data/templates/default/content/{bug%3A%20competing%20edits.textile → Bug%3A%20Competing%20edits.textile} +9 -0
  25. data/templates/default/content/Bug%3A%20Does%20not%20make%20use%20of%20if%2Dmodified%2Dsince%20r.textile +2 -0
  26. data/templates/default/content/Bug%3A%20E%2Dmail%20addresses%20with%20hyphens%20not%20recognised.textile +17 -0
  27. data/templates/default/content/Bug%3A%20Email%20adresses%20in%20page%20titles%20cause%20incorrec.textile +3 -0
  28. data/templates/default/content/Bug%3A%20GEM%20limits%20title%20lengths.textile +3 -1
  29. data/templates/default/content/Bug%3A%20Memory%20leak.textile +13 -0
  30. data/templates/default/content/Bug%3A%20Pages%20that%20link%20here%20may%20not%20appear%20on%20r.textile +13 -0
  31. data/templates/default/content/Bug%3A%20Textile%20mishandles%20paragraphs.textile +4 -0
  32. data/templates/default/content/Bug%3A%20Unanticipated%20Rollbacks.textile +2 -0
  33. data/templates/default/content/Bug%3A%20notextile%20does%20not%20prevent%20page%20inserts.textile +2 -0
  34. data/templates/default/content/Home%20Page.textile +3 -1
  35. data/templates/default/content/How%20to%20administrate%20this%20wiki.textile +23 -13
  36. data/templates/default/content/How%20to%20change%20the%20way%20this%20wiki%20looks.textile +3 -1
  37. data/templates/default/content/How%20to%20export%20a%20site%20from%20this%20wiki.textile +22 -0
  38. data/templates/default/content/How%20to%20get%20the%20latest%20Soks%20from%20cvs.textile +2 -0
  39. data/templates/default/content/How%20to%20hack%20soks.textile +2 -0
  40. data/templates/default/content/How%20to%20import%20a%20site%20from%20instiki.textile +2 -0
  41. data/templates/default/content/{How%20to%20import%20data%20to%20this%20wiki.textile → How%20to%20import%20data.textile} +3 -7
  42. data/templates/default/content/How%20to%20install%20Soks.textile +2 -0
  43. data/templates/default/content/How%20to%20password%20protect%20your%20wiki.textile +21 -11
  44. data/templates/default/content/How%20to%20report%20a%20bug.textile +2 -1
  45. data/templates/default/content/How%20to%20upgrade%20soks.textile +22 -0
  46. data/templates/default/content/How%20to%20use%20the%20keyboard%20shortcuts.textile +2 -2
  47. data/templates/default/content/How%20to%20use%20this%20wiki.textile +3 -1
  48. data/templates/default/content/List%20of%20changes.textile +84 -118
  49. data/templates/default/content/News%3A%20Version%201%2D0%2D0%20released.textile +19 -0
  50. data/templates/default/content/Pages%20to%20include%20in%20the%20distribution.textile +51 -0
  51. data/templates/default/content/Per%20Wiki%20Templates.textile +2 -0
  52. data/templates/default/content/Planned%20Features.textile +30 -9
  53. data/templates/default/content/README.textile +3 -2
  54. data/templates/default/content/RSS%20feed.textile +1 -1
  55. data/templates/default/content/Recent%20changes%20to%20this%20site.textile +283 -0
  56. data/templates/default/content/SOKS%20features.textile +3 -0
  57. data/templates/default/content/Site%20Index.textile +202 -0
  58. data/templates/default/content/Soks%20Licence.textile +2 -0
  59. data/templates/default/content/Tag%3A%20Include%20this%20page%20in%20the%20distribution.textile +6 -0
  60. data/templates/default/start.rb +67 -123
  61. data/templates/default/version.txt +1 -1
  62. data/templates/default/views/Page_edit.rhtml +7 -7
  63. data/templates/default/views/{Page_search_results.rhtml → Page_find.rhtml} +9 -3
  64. data/templates/default/views/Page_linksfromrss.rhtml +24 -0
  65. data/templates/default/views/Page_listrss.rhtml +46 -0
  66. data/templates/default/views/Page_meta.rhtml +1 -1
  67. data/templates/default/views/Page_revision.rhtml +39 -0
  68. data/templates/default/views/Page_revisions.rhtml +13 -5
  69. data/templates/default/views/Page_rss.rhtml +8 -8
  70. data/templates/default/views/Page_view.rhtml +3 -3
  71. data/templates/default/views/UploadPage_edit.rhtml +8 -8
  72. data/templates/default/views/frame.rhtml +8 -8
  73. data/templates/default/views/messages.yaml +1 -0
  74. data/test/html/2006Mar.html +66 -0
  75. data/test/html/poignant.html +36 -0
  76. data/test/html/poignant.textile +36 -0
  77. data/test/mock-objects.rb +69 -0
  78. data/test/stress_url_calls.rb +33 -0
  79. data/test/stress_urls.txt +68 -0
  80. data/test/test_counter-helper.rb +158 -0
  81. data/test/test_soks-helper-maintenance.rb +106 -0
  82. data/test/test_soks-helpers.rb +104 -0
  83. data/test/test_soks-model.rb +144 -0
  84. data/test/test_soks-servlet.rb +231 -0
  85. data/test/test_soks-storage.rb +70 -31
  86. data/test/test_soks-utils.rb +112 -13
  87. data/test/test_soks-view.rb +141 -3
  88. metadata +38 -27
  89. data/templates/default/content/A%20page%20with%20an%20umlaut%20%F6%20in%20its%20title.textile +0 -1
  90. data/templates/default/content/All%20News.textile +0 -26
  91. data/templates/default/content/Bil%20Kleb.textile +0 -1
  92. data/templates/default/content/Bil.textile +0 -1
  93. data/templates/default/content/Bill%20Wood.textile +0 -3
  94. data/templates/default/content/Bug%3A%20RSS%20feed%20does%20not%20validate.textile +0 -10
  95. data/templates/default/content/Bug%3A%20Type%20a%20title%20here.textile +0 -31
  96. data/templates/default/content/Instructions%20and%20Howtos.textile +0 -21
  97. data/templates/default/content/Latest%20News.textile +0 -26
  98. data/templates/default/content/New%20Recent%20Changes%20class.textile +0 -68
  99. data/templates/default/content/New%20page%20templates%20or%20categories%20code.textile +0 -68
  100. data/templates/default/content/News%3A%20Version%200%2E0%2E6%20Released.textile +0 -13
  101. data/templates/default/content/Recent%20Blog%20Entries.textile +0 -5
  102. data/templates/default/content/Recent%20Changes%20to%20This%20Site.textile +0 -286
  103. data/templates/default/content/Ruby.textile +0 -9
  104. data/templates/default/content/Skorgu.textile +0 -3
  105. data/templates/default/content/ctrl%2Dn.textile +0 -1
  106. data/templates/default/content/let%20me%20know.textile +0 -1
  107. data/templates/default/content/sandbox.textile +0 -20
  108. data/templates/default/content/tamc.textile +0 -1
  109. data/templates/default/content/tamc2.textile +0 -1
@@ -2,7 +2,8 @@ h1. How to report a bug
2
2
 
3
3
  I really appreciate bug reports.
4
4
 
5
- Please go to http://www.soks.org and create a new page whose title starts with bug:, e.g. @bug: does not make tea@.
5
+ Please click [[ here => http://www.soks.org/edit/BugTypeATitleHere ]] or go to http://www.soks.org and create a new page whose title starts with bug:, e.g. @bug: does not make tea@.
6
6
 
7
7
  In that page, please give as much information as you can and leave some contact details.
8
8
 
9
+ Tag: Include this page in the distribution
@@ -0,0 +1,22 @@
1
+ h1. How to upgrade
2
+
3
+ First download the latest release of soks:
4
+
5
+ Preferably:
6
+ # Install rubygems from http://rubyforge.org/projects/rubygems/
7
+ # @gem update Soks@ (you may need to be root first)
8
+
9
+ Alternatively
10
+ # Download the tar or zip file from http://rubyforge.org/projects/soks/
11
+ # Unzip or untar it
12
+ # Change into the soks directory
13
+
14
+ Then execute the command.
15
+
16
+ # @soks-create-wiki.rb --destination-dir=path/to/your/wiki@ and it will guide you through the upgrade.
17
+
18
+ If you haven't touched your start.rb file, then you are good to go. Otherwise you will need to edit the new start.rb file in your wiki to your tastes, the way this is set up changed substantially in v1-0-0, but it should be clear enough.
19
+
20
+ Should anything go wrong, or you need to revert, a pristine copy of your wiki is created in YourWikiName-bak-0.
21
+
22
+ Tag: Include this page in the distribution
@@ -9,9 +9,9 @@ Soks has a number of keyboard short cuts. Depending on your browser, only some
9
9
  ** ctrl-u undos the previous edit
10
10
  ** ctrl-a shows all the previous changes
11
11
  * ctrl-h: Home page
12
- * ctrl-i: Site Index
13
- * ctrl-r: Recent changes to this site
14
12
 
15
13
  *Note:* On Linux/Firefox and WindowsXP/IE6.0, substitute "meta" or "alt" for "ctrl". And for WindowsXP/IE6.0, these will only move you to the link on the page -- you then have to hit enter to proceed.
16
14
 
17
15
  fn1. Does not work on Linux/Firefox1.0 or WindowsXP/IE6.0
16
+
17
+ Tag: Include this page in the distribution
@@ -25,4 +25,6 @@ h2. Editing Pages
25
25
 
26
26
  h2. Searching
27
27
 
28
- The search box on the right takes a single regexp.
28
+ The search box on the right takes a single regular expression.
29
+
30
+ Tag: Include this page in the distribution
@@ -1,20 +1,95 @@
1
1
  h1. List of changes
2
2
 
3
- h2. Between v0-0-8 and v0-0-7
3
+ h2. Since v1-0-0
4
4
 
5
5
  *NOTE*: This has not been released yet, although anything listed here will be in the cvs (see how to get the latest Soks from cvs)
6
6
 
7
- h3. Features
8
-
9
- * None yet.
7
+ No changes yet.
8
+
9
+ h2. Between v1-0-0 and v0-0-7
10
+
11
+ h3. User Features
12
+
13
+ * Page titles can now have any punctuation, and the wiki urls look slightly prettier.
14
+ ** The url for a page now excludes punctuation, so 'Bug: is this a bug?' has the url /view/BugIsThisABug
15
+ ** Old urls still work (e.g. /view/home%20page )
16
+ ** Pages that differ only in punctuation are permitted, and are given unique urls (e.g. 'A&B' and 'A+B' become 'AB' and 'AB-2'). Unfortunately I haven't figured out a way of ensuring that these urls are consistent across wiki restarts, which means that bookmarks of pages that differ only in punctuation may not always serve the expected page.
17
+ ** If you have any authenticators that match specific pages, these will need to be changed to match the unpunctuated, WikiWord style page name.
18
+ * Recent Changes now has a 'changes' link that shows just the changes made by that revision. I'd appreciate feedback on how best to lay this out.
19
+ * Revisions pages now show only 10 revisions at a time (Should make things faster).
20
+ * Two new RSS feeds, accessed by /listrrss/pagename or /linksfromrss/pagename
21
+ ** listrss is aimed at the Recent Changes page and creates a feed that includes the edits made to each page
22
+ ** linksfromrss is aimed at Known Bugs and other similar pages, and creates an RSS feed that includes the content of each page referred to by the original page.
23
+ * Some basic page view counters
24
+ ** ViewCountHelper maintains a page called 'Popular Pages' that has a ranked list of the number of times a page has been viewed.
25
+ ** ViewerCountHelper can be configured to maintain pages like 'Prolific Viewers' or 'Prolific Editors' that provide a ranked list of the IPs (or usernames if they have given them) of those who visit or edit the wiki most often.
26
+ ** AuthorCountHelper can be configured to maintain a page with a ranked list of the n people who have made the most revisions to the wiki
27
+ * Can now save cache of page data and views when the wiki is shutdown. This makes starting the wiki again much faster.
28
+
29
+ h3. Adminstrative Features
30
+
31
+ * The way that all the settings are made has completely changed. See the template/default/start.rb class for details
32
+ * The api for the AutomaticSummary class has changed. See the templates/default/start.rb file for example use.
33
+ ** e.g. @AutomaticList.new( wiki, 'Instructions and Howtos' ) { |page| page.name =~ /^How to /i }@
34
+ * Some maintenance helpers, that periodically slim the wiki (these are not enabled by default)
35
+ ** DeleteOldPagesHelper operates (by default) once a day and wipes from disk any deleted pages that were deleted more than (by default) 100 days ago.
36
+ ** DeleteOldRevisionsHelper operates (by default) once a day and deletes any revisions that are (by default) more than 365 days old and where (by default) there are more than 20 revisions for the page.
37
+ ** MergeOldRevisionsHelper opeates (by default) each hour and merges all revisions more than (by default) 24 hours old, by the same author, and that are created (by default) within an hour of each other. Note this is pretty processesor intensive, so you may not wish to use it yet, but it should result in a significant reduction in the size of revision files.
38
+ * Can now include several static file handlers by specifying them in a servlet.static_file_directories hash, e.g. @{ 'Attachment' => 'attachment', 'www' => '/var/www' }@
39
+ * Of interest only to people delving under the hood:
40
+ ** The contents of the url's query are now available in the templates
41
+ ** Content-type for a particular view is now a setting (default is for text/html, RSS is application/xml, set in soks.rb)
42
+ ** The wiki now notify's listeners of time passing using :year,:month,:hour and :minute events. Helper classes can use these if they need to make periodic changes to the wiki.
43
+ ** The wiki now notify's listeners of a page view using a :page_viewed event. Helper classes can use this to track what pages people look at.
44
+ ** The Wiki class now has a wipe_from_disk method to erase a deleted page
10
45
 
11
46
  h3. Refactoring
12
47
 
13
- * None yet.
48
+ * The way settings are handled has been completely re-organised, removing the $SETTINGS global.
49
+ * Moved the changes_from method from the Page class to the String class
50
+ * Moved page delete method to Wiki class from View class
51
+ * Moved the add_to_index call from save method to mutate method in Wiki class
52
+ * Took out the test mock objects and put them in a separate file
53
+ * Refactored the find method out of the View class into the search results erb. (Why? Because it seems to me that it is more like a different view of the wiki, rather than something special, and this simplifies the View class).
54
+ * Refactored to remove the dedicated RSS method in the servlet class. Content-type is now set according to the name of the view.
55
+ * Refactored to replace all the extra threads that I was using to count days with listeners that wait for the periodic events (year,month,day,hour,min) sent out by the wiki. (in the calendar helper classes, and in the disk checking classes). This should increase the gracefulness of shutdowns and make sure that serving the user pages always takes priority.
56
+ * Refactored some common code from Tests to a module in mock objects
57
+ * Refactored the BruteMatch class to cache the title regexps. May be a little faster.
58
+ * Added some tests for the soks-servlet.rb class in preparation for some refactoring.
59
+ * Refactored all the mutating methods (revise,rollback,delete,move etc) out of the View class into the Wiki and Servlet classes so that View is strictly View only
14
60
 
15
61
  h3. Bugfixes
16
62
 
17
- * None yet.
63
+ * Added test for, and fixed bug: AutomaticPageMover still apears in RecentChanges
64
+ * Added test for, and fixed bug: Template pages should not be moved. Now any page with 'type a title here' in its title cannot be moved.
65
+ * Added test for, and partially fixed bug: Cannot change capitalization of a page title in that changes to the page title now work. However, they cannot be undone, and don't trigger recent changes or any automatic summaries to update.
66
+ * Fixed bug: Print stylesheet does not hide menu or commands (thanks to Pavel Sykora)
67
+ * Fixed bug: Recent changes today can be yesterday
68
+ * Fixed bug in the Calendar automatic helper where the months wouldn't link to each other.
69
+ * Fixed bug where refering to pages [ [ /edit/page name?something=somethingelse ]] would not correctly discern whether page name existed and colour the link accordingly.
70
+ * Added test for and fixed Bug: automatic linking does not work with trailing punctuation
71
+ * Added test and fixed Bug: pages names with single quotes
72
+ * Added test and fixed bug: calendar does not appear
73
+ * Fixed bug: viewing revisions requires authentification
74
+ * Added test and fixed Bug: automatic linking does not work with trailing punctuation
75
+ * Fixed Bug: RSS feed does not validate - Hopefully all fixed now. Usernames are now turned into (by default dummy) email addresses in order for the feed to officially validate, and the new page url system means the urls are more likely to be accepted as valid.
76
+
77
+ h3. Bugs Remaining
78
+
79
+ These bugs definitely remain:
80
+ * Bug: Does not make use of if-modified-since request headers
81
+ * Bug: GEM limits title lengths - This is a limit of file names on Windows OSs?
82
+ * Bug: notextile does not prevent page inserts
83
+ * Bug: Textile mishandles paragraphs
84
+ * Bug: E-mail addresses with hyphens not recognised
85
+ * Bug: Email adresses in page titles cause incorrect links
86
+ * Bug: Memory leak
87
+ * Bug: Pages that link here may not appear on restart
88
+
89
+ These bugs are partially fixed / tricky to replicate
90
+ * Bug: Unanticipated Rollbacks - Not yet been replicated
91
+ * bug: competing edits - Does what I expect (last person to save, wins) so not a bug for me, but clearly not ideal so will work on something better.
92
+
18
93
 
19
94
  h2. Between v0-0-7 and v0-0-6
20
95
 
@@ -43,117 +118,8 @@ h3. Bugfixes
43
118
  * Fixed Bug: Internet Exploror 6.0 incompatibilities during page edits
44
119
  * Fixed Bug: LinuxFirefox1.0 scroll reset after cursor move
45
120
 
46
- h2. Between v-0-0-6 and v-0-0-5
47
-
48
- h3. Features
49
-
50
- * The default template now includes a 'sidebar page' that can be edited inside the wiki. (Thanks to Bil Kleb).
51
- * Changed the way the soks libraries are required to hopefully allow a wiki to be more easily moved between machines (Thanks to Giovanni Ferro).
52
- * Some new settings:
53
- ** Setting @:server_type => WEBrick::Daemon@ in start.rb causes Soks to try and fork into a separate process. By default this is off. (Thanks to Remy Drouilhet)
54
- ** The name of the home page is now a setting in start.rb (@:home_page => "home page"@).
55
- ** Setting @:redcloth_hard_breaks => true@ in start.rb causes Redcloth to revert to the 2.x approach of turning every newline to a @<br />@. This is off by default (i.e. the default works like Redcloth 3.x). (Thanks to Seb Clediere.)
56
- * Roughed up a wiki2html helper that maintains a static html copy of the site in sync with the dynamic copy.
57
- * Toned down the colors and tweaked the layout of the default wiki look.
58
- * Removed the 'instiki' and the 'rails' templates from the distribution, because I haven't kept them up to date.
59
-
60
- h3. Refactoring
61
-
62
- * Filehandler servlet now incorporated into the WikiServlet.
63
- * General cleanup in WikiServlet
64
- * Rewrote the RollingMatch class (in soks-view, deals with automatic linking) to be less complex and a little bit faster.
65
-
66
- h3. Bugfixes
67
-
68
- * Fixed Bug: Time per change on meta page view incorrect
69
- * Fixed Bug: Punctuation in page titles still problematic by adding two validations. The first is a piece of javascript that warns the user from using problematic punctuation, the second is in the servlet and removes all problematic punctuation. As a side effect, this has fixed Bug: ampersand in page name creates missing links that work .
70
- * Fixed Bug: Search textarea and button rendered without vertical separation by removing the search button. It wasn't needed, and IMO looked clunky.
71
- * Fixed Bug: Certain text crashes yaml revision loading
72
- * Fixed Bug: Do not save and delete links confusing on edit page by replacing the links with form buttons.
73
- * Shutting down Soks with ctrl-c (which is trapped by the TERM signal - does this work on Windows? non OSX unix?) now waits until all the running helpers have finished making their changes to the wiki. This should have fixed bug: Halting can corrupt revisions and may help with Bug: Unanticipated Rollbacks if graceless shutdown is the cause.
74
- * Fixed Bug: Update frequency rounds inappropriately in meta view using Bil Kleb's extension to the Numeric class.
75
- * Fixed Bug: AutomaticRecentChanges ignores changes parameter
76
- * Fixed Bug: Uploads are not password protected
77
- * Fixed Bug: Pictures and Attachments linked to site root
78
- * Partially fixed Bug: RSS feed does not validate, in that I changed the encoding given in the xml so that umlauts work.
79
- * Partially fixed Bug: Upload filenames needlessly mangled, in that it now only removes spaces from filename (which is unfortunately required for RedCloth to be able to make links to the file).
80
- * Robots.txt in the default template dissalows the 'meta' page view
81
-
82
- h3. Bugs remaining
83
-
84
- Seems like I've accumulated enough changes above to start thinking about another release. This means that some bugs are not going to be fixed for this release. If you strongly object, please let me know.
85
- * Bug: Does not make use of if-modified-since request headers
86
- * Bug: GEM limits title lengths
87
- * Bug: notextile does not prevent page inserts
88
- * Bug: Textile mishandles paragraphs
89
- * Bug: competing edits
90
-
91
- The following bugs have only been partially fixed, so some problems may remain
92
- * Bug: RSS feed does not validate
93
- * Bug: Unanticipated Rollbacks
94
-
95
- h2. Between v-0-0-5 and v-0-0-4
96
-
97
- h3. Features
98
-
99
- * Now uses Redcloth v3, and therefore can have some markdown styles as well as textile on the same page
100
- * Roughed up two more automatic helpers: rss2wiki that writes the content of a rss feed to a wiki page, and mail2wiki that watches an imap mailbox and adds any messages in it to the wiki. Both work, but are probably not ready for prime time.
101
- * Note I have removed the feature in v-0-0-4 that would merge any changes by the same author within 5 minutes, as it seemed to cause some confusion with end users.
102
-
103
- h3. Refactoring
104
-
105
- * Helpers have been moved to a separate sub directory
106
- * A module in soks-view that can be used by the erb template. Has functions for creating urls for pages. The default template has been updated to use this, but not the other templates.
107
-
108
- h3. Bug fixes
109
-
110
- * Fatal bug when renaming picture or attachment pages fixed.
111
- * References to urls no longer include trailing punctuation
112
- * Authenticators no longer call depreciated base64 method
113
- * Now has (partial) support for robots.txt and favicon.ico
114
- * Search box no longer treats leading and trailling spaces as significant
115
- * Returns a page not found rather than an exception if an unknown view type is requested
116
-
117
- h3. Bugs remaining
118
-
119
- * No authentication on pictures and attachments
120
- * Punctuation in page titles problematic. ? <> and [] cause problems. : and / are ok.
121
- * Insert page commands are not inhibited by notextile, pre or code tags
122
-
123
- h2. Between v-0-0-4 and v-0-0-3
124
-
125
- This was a bugfix release on v-0-0-3. Principally by adding locking code so two pages can't update the same page at the same time.
126
-
127
- h2. Between v-0-0-3 and v-0-0-2
128
-
129
- h3. Features
130
-
131
- * File format for revisions changed from marshalled array of revisions to a yaml'd array of strings and times. This should allow easier import/export.
132
- * Changes to the files on disk appear in the wiki (by default checks for changes on disk every 60 seconds) to allow external editing of the wiki.
133
- * New way of making new pages: highlight the text you wish to link and press crtl-n. This only works on some browsers.
134
- * RSS feed for changes made to any page (use the RSS feed on Recent Changes to be notified of all changes to the site, use the RSS feed on Site Index to be notified of new pages).
135
- * Added a WikiWord link for those that don't like to give out links with %20's in them. e.g. http://yoursite.com/wiki/HomePage redirects to http://yoursite.com/view/Home%20Page.
136
- * The automatic summary class has been extended to allow summary based on the page title, page author, or page content.
137
- * Different parts of the wiki, and different commands, can be authenticated differently based on regexps.
138
- * Kill list of words that will not be automatically linked (default set is the 30 most common English language words).
139
- * The soks-create-wiki command can now be interactive (or can use command line options including --help and --no-interaction). It also manages upgrades from the previous version of Soks.
140
- * There are some demo templates: default is the standard, rails looks a bit like www.rubyonrails.com and instiki which looks a bit like www.instiki.org.
141
- * A meta data view of a page. Clicking on the page's title on the top left of the screen brings up a list of the links from and too that page, and a list of the people who have contributed to the page.
142
-
143
- h3. Refactorings
144
-
145
- * The recent changes and site index helpers now use the automatic summary class.
146
- * The Wiki class now notifies other classes of changes to the site, including the View class.
147
- * The storage methods are now a module which is mixed into the wiki class.
148
-
149
- h3. Bug Fixes
150
-
151
- * Bug in uploads on windows fixed (thanks to Sebastien Clediere).
152
- * Bugs in accepting titles with punctuation fixed.
153
- * Bug in automatic summary fixed.
154
- * Logo changed from png to tif so that it is transparent on a wider selection of browsers.
121
+ h2. Before v0-0-6
155
122
 
156
- h3. Bugs remaining
123
+ See list of changes for older versions
157
124
 
158
- * No authentication on pictures and attachments
159
- * Lots of little faults with the textile to html conversion. Some due to the use of Redcloth v 2.0.11 (looking forward to a stable v3!) and some due to my inept subclassing.
125
+ Tag: Include this page in the distribution
@@ -0,0 +1,19 @@
1
+ h1. Version 1-0-0 released
2
+
3
+ It gives me great pleasure to announce the sixth public release of Soks as v1-0-0. There have been a lot of changes, and much of Soks has now stabalised so I've decided to call it a beta rather than an alpha. When I iron out a few more bugs I might even be confident in calling it stable.
4
+
5
+ See how to install soks, or how to upgrade soks for instructions. There is a full list of list of changes and some known bugs, but in brief:
6
+
7
+ * Page titles can now have any punctuation, and the wiki urls look slightly prettier.
8
+ * Two new RSS feeds, one of which contains all the pages linked to from a particular page, the other that includes edits made to the contents of linked pages. These are both useful in conjunction with the automatic summary classes.
9
+ * Some popular pages, authors, visitors counters (not enabled by default)
10
+ * The wiki can now save cache of page data and views when the wiki is shutdown. This makes starting the wiki again much faster.
11
+ * The way that all the settings are made has completely changed, hopefully to make it clearer, and to enable several wiki's to be mounted on the same Webrick server.
12
+ * Some maintenance helpers, that can periodically slim the wiki (these are not enabled by default)
13
+ * Can now include several static file handlers
14
+
15
+ There has also been quite a lot of refactoring and bug fixing, all though some (not critical) bugs remain. With the shift in version numbering, I plan to offer a 1-0-x series of releases as soon as I fix bugs until this release is thoroughly stable. I will add features to a 1-1-0 release.
16
+
17
+
18
+
19
+ Tag: Include this page in the distribution
@@ -0,0 +1,51 @@
1
+ h2. Pages to include in the distribution
2
+
3
+ This is a list of pages that will be included in the default soks distribution. It is created automatically from pages that contain "Tag: Include this page in the distribution". If you think a page should be included, just write Tag: Include this page in the distribution somewhere on the page.
4
+
5
+ <automaticsummary warning='DO NOT EDIT between these automatic summary tags, anything you write may be overwritten without warning'>
6
+
7
+ * [[ Author ]]
8
+ * [[ Automatic Summaries ]]
9
+ * [[ Automatic linking between pages ]]
10
+ * [[ Bug: Does not make use of if-modified-since request headers ]]
11
+ * [[ Distribution Home Page ]]
12
+ * [[ How to administrate this wiki ]]
13
+ * [[ How to change the way this wiki looks ]]
14
+ * [[ How to export a site from this wiki ]]
15
+ * [[ How to hack soks ]]
16
+ * [[ How to import a site from instiki ]]
17
+ * [[ How to install Soks ]]
18
+ * [[ How to use the keyboard shortcuts ]]
19
+ * [[ How to use this wiki ]]
20
+ * [[ List of changes ]]
21
+ * [[ README ]]
22
+ * [[ Recent changes to this site ]]
23
+ * [[ Site Index ]]
24
+ * [[ Soks Licence ]]
25
+ * [[ Latest News ]]
26
+ * [[ All News ]]
27
+ * [[ RSS feed ]]
28
+ * [[ Bug: GEM limits title lengths ]]
29
+ * [[ Planned Features ]]
30
+ * [[ Bug: notextile does not prevent page inserts ]]
31
+ * [[ How to report a bug ]]
32
+ * [[ How to get the latest Soks from cvs ]]
33
+ * [[ Api for classes to modify the wiki ]]
34
+ * [[ Bug: Unanticipated Rollbacks ]]
35
+ * [[ Per Wiki Templates ]]
36
+ * [[ How to password protect your wiki ]]
37
+ * [[ Bug: Textile mishandles paragraphs ]]
38
+ * [[ Bug: Competing edits ]]
39
+ * [[ Bug: E-mail addresses with hyphens not recognised ]]
40
+ * [[ Bug: Email adresses in page titles cause incorrect links ]]
41
+ * [[ Bug: Memory leak ]]
42
+ * [[ News: Next release due, so this site is being edited ]]
43
+ * [[ Tag: Include this page in the distribution ]]
44
+ * [[ Pages to include in the distribution ]]
45
+ * [[ How to import data ]]
46
+ * [[ Bug: Pages that link here may not appear on restart ]]
47
+ * [[ News: Version 1-0-0 released ]]
48
+ * [[ How to upgrade soks ]]
49
+
50
+
51
+ </automaticsummary>
@@ -33,3 +33,5 @@ For you? Probably nothing! They just show how can have a different look and fe
33
33
  * Rails has a big logo bar at the top, the content on the right, and the links etc on the left. Looks a lot like http://wiki.rubyonrails.com
34
34
 
35
35
  fn1. I've only been updating the default template recently.
36
+
37
+ Tag: Include this page in the distribution
@@ -1,27 +1,26 @@
1
1
  h1. Planned Features
2
2
 
3
- In the long term I'm hoping to spend some time working on the instiki project to incorporate some of the features of Soks into instiki, but not until I've got soks stable and smooth.
3
+ For features that are planned for the next release or two, see the to do list.
4
4
 
5
- h2. v0-0-8:
5
+ h2. Features in v1.1.0
6
6
 
7
- _I'm about to release v-0-0-7 earlier than I had planned, in order to fix the critical Bug: Internet Exploror 6.0 incompatibilities during page edits. Therefore these features have been pushed back to v-0-0-8._
7
+ * A way of storing and using meta-data about each page
8
8
 
9
- * Sort out a decent site wide RSS feed
10
- * Take a look at any scale / speed limits and see if they can be reduced
11
- ** May need a housekeeping routine that could periodically prune large revision files, and perhaps permanently remove deleted pages after a while.
9
+ h2. Features in v1.2.0
10
+
11
+ * A way of editing by paragraph as well as page
12
12
 
13
13
  h1. Desired Features
14
14
 
15
15
  Let me know if there is anything that you would like to see, or add it here:
16
16
 
17
17
  * Flesh out the RSS feed:
18
- ** Have the item content render the most recent change information like that shown at the bottom of an edit page. (Remove the logo and search box?)
19
- ** Have the source link be the "view" view and not the "rss" view.
18
+ ** (Remove the logo and search box?)
20
19
  ** Replace the <notextile>* [[ page title ]]</notextile> asterisk and brackets with quotation marks? --Bil
21
20
  * Fast CGI or the like as an alternative to Webrick
22
21
  * Give each automaticsummary a unique name so several can update the same page
23
22
  * Some form of tag to automatically create automatic summaries.
24
- * Make the wiki fork, and give commands to gracefully start and stop it.
23
+ * Give commands to gracefully start and stop it.
25
24
  * I was going to make a suggestion, then I noticed that something like it had been added and deleted. Perhaps some explanitory text explaining what has already been suggested or what is or is not acceptable would be a good idea? - Sorry. A mistake on my part. Please do make your suggestion again, and I won't delete any in future - tamc2
26
25
  ** I think a generalized way of extending soks to be very much more dynamic would be allowing dirt-simple extensions. One way would be to put a @scripts@ directory in parallel with @attachment@ and extend @insert@ to then include the output of the script. So something like @[ [insert script helloworld blah ] ]@ would run helloworld.rb with the argument blah and the output would get pasted right into the wiki page. What do people think? --Skorgu
27
26
  ** Interesting, what types of script did you have in mind? The only challenge I can see is deciding how frequently to call the script to update the page, every time the page is viewed? or every time it is editted? or somewhere in between? what do you think? -- tamc
@@ -35,7 +34,29 @@ Let me know if there is anything that you would like to see, or add it here:
35
34
  * Perhaps the default layout should have a little table of contents menu like wikipedia pages, e.g., the thing labeled 'contents' at http://en.wikipedia.org/wiki/Wiki. If you create a long page with several headings, it creates a little table of contents at the top so you can leap down the page quickly.
36
35
  * The following came from one our site's users. It would seem contrary to the basic architecture of this wiki engine. However, it would be nice to be notified somehow of how many or which pages were going to have their links deactivated or altered... --Bil
37
36
  ** It would be nice if I changed the name of a page that had other pages linked to it, that I could have the option of changing all of the linked pages to it automatically. --Bil
37
+ * Add a facility to use trackbacks on wiki pages so that can see other sites that link to that page. http://www.sixapart.com/movabletype/docs/mtmanual_trackback.html --tamc2
38
+ * I think this http://tool-man.org/examples/edit-in-place.html would be great. Double click on a paragraph and edit it in place! Unfortunately his code only works on some browsers... --tamc2
39
+ ** That demo is absolutely gorgeous. It would be obscenely cool to implement soks as an AJAX or whatever we're calling it today frontend a la gmail/google maps etc. It seems that some work is being done to integrate that into rails, so maybe they could both be integrated at once? Another benefit to rails-izing is moving away from WEBRick as the only frontend. "lighttpd":http://bigbold.com/snippets/posts/show/175 apparently plays well with rails --Skorgu
40
+ * Victor Ng-Thow-Hing asked by email about adding rich media (e.g. movies, svg etc) to the wiki. Can currently upload them as files and link to them, but I'll have a think about how to extend textile to allow movies etc to be embedded. --tamc2
41
+
42
+ Suggestions in an email from Seb Clediere copied here
43
+ * Multi-wiki. Have you thought about several wikis? Like instiki where you can setup several wikis? -- See also [[ kleb's email => [soks] Sub wikis ]].
44
+ * Flat hierarchy. With the wiki content growing in size, I am wondering about having a directory hierarchy in the wiki, rather than a flat one. And perhaps there would be not need for a separate attachement and content. (Hieraki are doing something along a hierarchical wiki http://demo.hieraki.org)
45
+ * I had a brief look at a new comer: MiniRubyWiki. I don't like it at all, but the guy add a very good idea: integrate graphziz/dot to it, so it is easy to add somes graphs to the text. Very good.
46
+ ** I'll have to take a look. I am curious whether Graphviz/dot was used for displaying (and navigating) the meta-page link connections like "TheBrain":http://www.thebrain.com or something else? --Bil
38
47
 
39
48
  Also considering these bigger changes (interested in your thoughts):
40
49
  * Making the automatic linking ignore punctuation. Only the words in page titles would be significant, so "Bug: A bug" would be treated the same as "Bug- A bug" -- tamc
41
50
  * Making the automatic linking link to 'similarly' title pages. e.g: If you have a page called "Page One" and another called "Page Two" all instances of the word "One" in "Page Two" would link to "Page One". Would add a lot of processing, but might allow distinct namespaces. -- tamc
51
+
52
+ h2. Adopted features
53
+
54
+ These are suggestions that were above and have been implemented (at least in the CVS version) or are on the to do list.
55
+
56
+ * Flesh out the RSS feed
57
+ ** Have the item content render the most recent change information like that shown at the bottom of an edit page
58
+ ** Have the source link be the "view" view and not the "rss" view.
59
+ * Make the wiki fork (possible by changing a setting in the start.rb file)
60
+ * There was a guy on comp.lang.ruby wanted to do a link in instiki to a file, exactly what I have done in soks with the few lines of code I sent you a while ago in fact. (My mistake in not including this code sooner, I will put it in the next release, sorry! -- tamc2)
61
+
62
+ Tag: Include this page in the distribution
@@ -63,15 +63,16 @@ I suspect there are many, as befits its version number. In particular it has:
63
63
  * Insert page commands are not inhibited by notextile, pre or code tags
64
64
  * Does not permit browsers to cache pages
65
65
  * Not user friendly in the way it handles simultaneous edits of a page (last person to save wins)
66
- * Some bugs in layout and formatting of text.
67
- * RSS feed does not completely validate
68
66
 
69
67
  See http://www.soks.org/wiki/KnownBugs for details.
70
68
 
71
69
  h2. RELEASES
72
70
 
71
+ # 2005 July 24 - soks-1.0.0 - Sixth public release (beta)
73
72
  # 2005 Mar 21 - soks-0.0.7 - Fifth public release (alpha)
74
73
  # 2005 Mar 15 - soks-0.0.6 - Fourth public release (alpha)
75
74
  # 2005 Feb 12 - soks-0.0.5 - Third public release (alpha)
76
75
  # 2005 Jan 24 - soks-0.0.4 - Second public release (alpha)
77
76
  # 2005 Jan 11 - soks-0.0.2 - First public release (alpha)
77
+
78
+ Tag: Include this page in the distribution
@@ -6,4 +6,4 @@ The rss currently only shows:
6
6
  * Changes to the textile (not html)
7
7
  * Added lines
8
8
 
9
- Note there is a bug: RSS feed does not validate
9
+ Tag: Include this page in the distribution