diff --git a/RELEASE_NOTES.txt b/RELEASE_NOTES.txt index 923817a..2d9306a 100644 --- a/RELEASE_NOTES.txt +++ b/RELEASE_NOTES.txt @@ -1,16 +1,25 @@ -Release 0.7 Notes +# Release 0.7.0 Notes -Breaking Changes +## Breaking Changes -* index.html template for exporter, and main.css should now be placed in system/export_resources/ (where "system" is the system directory) +index.html template for exporter, and main.css should now be placed in system/export_resources/ (where "system" is the system directory) +If you started with a previous version of Cardigan Bay and customized your index.html template and main.css for exporting, make sure you have copied both into system/export_resources/ -Non-breaking Changes +If you want to be able to export functioning :workspaces then make sure you have added the Scittle dependency in the latest index.html template to your custom template. -* Reordering cards no longer reloads page -* Moving cards from one page to another no longer reloads page, and therefore preserves back button behaviour -* Bug with quote marks in search terms now fixed -* Text search now returns number of results -* Now added a Patterning card type with code from Patterning library +## Non-breaking Changes + +Reordering cards no longer reloads page. + +Moving cards from one page to another no longer reloads page, and therefore preserves back button behaviour + +Bug with quote marks in search terms now fixed + +Text search now returns number of results + +Now added a :patterning card type with code from Patterning library. (See the PatterningExamples page for more information) + +Now added Scittle (https://github.com/babashka/scittle) as a dependency of our exported pages. This means :workspace code now runs in our exports. (See WorkspaceExample page for more details) diff --git a/bedrock/EvalExamples.md b/bedrock/EvalExamples.md index d17d441..8cc9b6a 100644 --- a/bedrock/EvalExamples.md +++ b/bedrock/EvalExamples.md @@ -8,7 +8,7 @@ There are two ways to embed Clojure code in your wiki. * evaluation on the client * evaluation on the server -In both cases, the code be correct (without bugs or causing exceptions). And not try to use external resources or include libraries etc. +In both cases, the code needs to be correct (without bugs or causing exceptions). And can't use external resources or include libraries etc. For more on running ClojureScript in the client / browser, see [[WorkspaceExample]] diff --git a/bedrock/ExportTime.md b/bedrock/ExportTime.md new file mode 100644 index 0000000..0c3a68a --- /dev/null +++ b/bedrock/ExportTime.md @@ -0,0 +1,10 @@ +[[CardiganBay]] is intended to be used as a personal wiki tool, running on your local machine. When you want to make your work public, you export either individual pages or the whole wiki as flat HTML files (which don't need any server support) and copy them to any public-facing server you have access to. + + +Some pages in your wiki will contain "dynamic" data. That is, they show you things that are imported from elsewhere, or recalculated, whenever the user navigates to a page. + +This includes RSS Feeds (see [[SocialEmbedding]]), Patterns (see [[PatterningExamples]]), embedded searches ([[ASearchExample]]), Clojure scripts that run on the server and some system queries. + +When you export static HTML pages, all this dynamic data is recalculated, at this time, and what is written to the exported pages is normal HTML. There is no dynamic server behind an exported site. + +The time this happens is called *export time*. diff --git a/bedrock/HelloWorld.md b/bedrock/HelloWorld.md index 189e1a4..d1be86f 100644 --- a/bedrock/HelloWorld.md +++ b/bedrock/HelloWorld.md @@ -4,6 +4,7 @@ This is your default local wiki (affectionately known as Bedrock). And you are on the initial page which is called HelloWorld. +If you have just installed a new copy of Cardigan Bay see [[ReleaseNotes]] ---- diff --git a/bedrock/ReleaseNotes.md b/bedrock/ReleaseNotes.md new file mode 100644 index 0000000..b822812 --- /dev/null +++ b/bedrock/ReleaseNotes.md @@ -0,0 +1,24 @@ +This is [[CardiganBay]] *0.7.0* + +### Breaking Changes + +index.html template for exporter, and main.css should now be placed in system/export_resources/ (where "system" is the system directory) + +If you started with a previous version of Cardigan Bay and customized your index.html template and main.css for exporting, make sure you have copied both into system/export_resources/ + +If you want to be able to export functioning :workspaces then make sure you have added the Scittle dependency in the latest index.html template to your custom template. + + +### Non-breaking Changes + +Reordering cards no longer reloads page. + +Moving cards from one page to another no longer reloads page, and therefore preserves back button behaviour + +Bug with quote marks in search terms now fixed + +Text search now returns number of results + +Now added a :patterning card type with code from Patterning library. (See the [[PatterningExamples]] page for more information) + +Now added Scittle (https://github.com/babashka/scittle) as a dependency of our exported pages. This means :workspace code now runs in our exports. (See [[WorkspaceExample]] page for more details) \ No newline at end of file diff --git a/bedrock/WorkspaceExample.md b/bedrock/WorkspaceExample.md index 18bd476..d0cc22c 100644 --- a/bedrock/WorkspaceExample.md +++ b/bedrock/WorkspaceExample.md @@ -6,10 +6,9 @@ Note that the output of the code is expected to be either a string or [hiccup](h ;; Write some code [:div -[:ol -(map (fn [x] [:li x]) (range 20)) +[:ul +(map (fn [x] [:li (str x ", " (reduce + (range x)))]) (range 20)) ]] - ---- diff --git a/bedrock/exported/api/rc-rss.xml b/bedrock/exported/api/rc-rss.xml index 9d65423..0aca1a3 100644 --- a/bedrock/exported/api/rc-rss.xml +++ b/bedrock/exported/api/rc-rss.xml @@ -1 +1 @@ -RecentChangeshttps://example.com/Recent Changes in CardiganBay Wikiclj-rssCardTypes changed on (Tue Mar 22 17:26:05 GMT 2022)https://example.com/CardTypesPatterningExamples changed on (Tue Mar 22 17:17:40 GMT 2022)https://example.com/PatterningExamplesEvalExamples changed on (Sun Feb 20 16:06:06 GMT 2022)https://example.com/EvalExamplesSandBox changed on (Wed Jun 16 16:29:33 BRT 2021)https://example.com/SandBoxASearchExample changed on (Wed Jun 16 16:25:07 BRT 2021)https://example.com/ASearchExampleWorkspaceExample changed on (Wed Jun 16 15:39:28 BRT 2021)https://example.com/WorkspaceExampleEmbeddingExamples changed on (Wed Jun 16 15:24:01 BRT 2021)https://example.com/EmbeddingExamplesSocialEmbedding changed on (Wed Jun 16 15:24:01 BRT 2021)https://example.com/SocialEmbeddingMusicEmbedding changed on (Wed Jun 16 15:19:38 BRT 2021)https://example.com/MusicEmbeddingVideoEmbedding changed on (Wed Jun 16 15:17:40 BRT 2021)https://example.com/VideoEmbeddingInQueue changed on (Wed Jun 16 15:08:18 BRT 2021)https://example.com/InQueueNetworkDiagramExample changed on (Wed Jun 16 13:40:13 BRT 2021)https://example.com/NetworkDiagramExampleSB2 changed on (Sat Jun 05 17:15:07 BRT 2021)https://example.com/SB2SimonWardley changed on (Tue Jun 01 22:55:07 BRT 2021)https://example.com/SimonWardleyTestTwo changed on (Tue Jun 01 22:52:20 BRT 2021)https://example.com/TestTwoTestMove changed on (Tue Jun 01 22:42:13 BRT 2021)https://example.com/TestMoveOutstandingTask changed on (Thu May 06 17:51:21 BRT 2021)https://example.com/OutstandingTaskAboutThisWiki changed on (Sun May 02 22:26:17 BRT 2021)https://example.com/AboutThisWikiBlahPage changed on (Wed Jan 20 19:17:49 BRT 2021)https://example.com/BlahPageSandBox2 changed on (Wed Jan 20 19:06:37 BRT 2021)https://example.com/SandBox2AnotherPage changed on (Tue Dec 01 15:48:42 BRT 2020)https://example.com/AnotherPageHelloWorld changed on (Tue Dec 01 15:38:11 BRT 2020)https://example.com/HelloWorldRecentChanges changed on (Tue Dec 01 15:37:15 BRT 2020)https://example.com/RecentChangesTrashCan changed on (Sun Nov 22 13:45:50 BRT 2020)https://example.com/TrashCanUserGuide changed on (Tue Oct 06 16:33:35 BRT 2020)https://example.com/UserGuideCardiganBay changed on (Mon Oct 05 19:20:28 BRT 2020)https://example.com/CardiganBayGettingStarted changed on (Sun Oct 04 23:29:55 BRT 2020)https://example.com/GettingStartedWhatIsAWiki changed on (Sun Oct 04 22:53:48 BRT 2020)https://example.com/WhatIsAWiki changed on https://example.com/ExtraMarkupExamples changed on (Sun Oct 04 21:48:38 BRT 2020)https://example.com/ExtraMarkupExamplesHackerOnBoarding changed on (Thu Oct 01 02:42:22 BRT 2020)https://example.com/HackerOnBoardingBookmarkingInstructions changed on (Thu Oct 01 01:42:31 BRT 2020)https://example.com/BookmarkingInstructionsCardBar changed on (Thu Oct 01 01:30:12 BRT 2020)https://example.com/CardBarOrphanPages changed on (Thu Oct 01 00:53:15 BRT 2020)https://example.com/OrphanPagesIntroductionToCardiganBay changed on (Mon Sep 07 23:33:16 BRT 2020)https://example.com/IntroductionToCardiganBayDigitalGardens changed on (Mon Sep 07 23:12:13 BRT 2020)https://example.com/DigitalGardensTransclusionExample changed on (Mon Sep 07 14:01:29 BRT 2020)https://example.com/TransclusionExampleSequenceOfCards changed on (Mon Sep 07 13:30:32 BRT 2020)https://example.com/SequenceOfCardssystemrecentchanges changed on (Thu Sep 03 13:10:24 BRT 2020)https://example.com/systemrecentchangesevalexamples changed on (Thu Sep 03 03:32:22 BRT 2020)https://example.com/evalexamplesgettingstarted changed on (Tue Aug 25 03:51:34 BRT 2020)https://example.com/gettingstarted \ No newline at end of file +RecentChangeshttps://example.com/Recent Changes in CardiganBay Wikiclj-rssWorkspaceExample changed on (Mon May 09 22:09:54 BST 2022)https://example.com/WorkspaceExampleCardTypes changed on (Tue Mar 22 17:26:05 GMT 2022)https://example.com/CardTypesPatterningExamples changed on (Tue Mar 22 17:17:40 GMT 2022)https://example.com/PatterningExamplesEvalExamples changed on (Sun Feb 20 16:06:06 GMT 2022)https://example.com/EvalExamplesSandBox changed on (Wed Jun 16 16:29:33 BRT 2021)https://example.com/SandBoxASearchExample changed on (Wed Jun 16 16:25:07 BRT 2021)https://example.com/ASearchExampleEmbeddingExamples changed on (Wed Jun 16 15:24:01 BRT 2021)https://example.com/EmbeddingExamplesSocialEmbedding changed on (Wed Jun 16 15:24:01 BRT 2021)https://example.com/SocialEmbeddingMusicEmbedding changed on (Wed Jun 16 15:19:38 BRT 2021)https://example.com/MusicEmbeddingVideoEmbedding changed on (Wed Jun 16 15:17:40 BRT 2021)https://example.com/VideoEmbeddingInQueue changed on (Wed Jun 16 15:08:18 BRT 2021)https://example.com/InQueueNetworkDiagramExample changed on (Wed Jun 16 13:40:13 BRT 2021)https://example.com/NetworkDiagramExampleSB2 changed on (Sat Jun 05 17:15:07 BRT 2021)https://example.com/SB2SimonWardley changed on (Tue Jun 01 22:55:07 BRT 2021)https://example.com/SimonWardleyTestTwo changed on (Tue Jun 01 22:52:20 BRT 2021)https://example.com/TestTwoTestMove changed on (Tue Jun 01 22:42:13 BRT 2021)https://example.com/TestMoveOutstandingTask changed on (Thu May 06 17:51:21 BRT 2021)https://example.com/OutstandingTaskAboutThisWiki changed on (Sun May 02 22:26:17 BRT 2021)https://example.com/AboutThisWikiBlahPage changed on (Wed Jan 20 19:17:49 BRT 2021)https://example.com/BlahPageSandBox2 changed on (Wed Jan 20 19:06:37 BRT 2021)https://example.com/SandBox2AnotherPage changed on (Tue Dec 01 15:48:42 BRT 2020)https://example.com/AnotherPageHelloWorld changed on (Tue Dec 01 15:38:11 BRT 2020)https://example.com/HelloWorldRecentChanges changed on (Tue Dec 01 15:37:15 BRT 2020)https://example.com/RecentChangesTrashCan changed on (Sun Nov 22 13:45:50 BRT 2020)https://example.com/TrashCanUserGuide changed on (Tue Oct 06 16:33:35 BRT 2020)https://example.com/UserGuideCardiganBay changed on (Mon Oct 05 19:20:28 BRT 2020)https://example.com/CardiganBayGettingStarted changed on (Sun Oct 04 23:29:55 BRT 2020)https://example.com/GettingStartedWhatIsAWiki changed on (Sun Oct 04 22:53:48 BRT 2020)https://example.com/WhatIsAWiki changed on https://example.com/ExtraMarkupExamples changed on (Sun Oct 04 21:48:38 BRT 2020)https://example.com/ExtraMarkupExamplesHackerOnBoarding changed on (Thu Oct 01 02:42:22 BRT 2020)https://example.com/HackerOnBoardingBookmarkingInstructions changed on (Thu Oct 01 01:42:31 BRT 2020)https://example.com/BookmarkingInstructionsCardBar changed on (Thu Oct 01 01:30:12 BRT 2020)https://example.com/CardBarOrphanPages changed on (Thu Oct 01 00:53:15 BRT 2020)https://example.com/OrphanPagesIntroductionToCardiganBay changed on (Mon Sep 07 23:33:16 BRT 2020)https://example.com/IntroductionToCardiganBayDigitalGardens changed on (Mon Sep 07 23:12:13 BRT 2020)https://example.com/DigitalGardensTransclusionExample changed on (Mon Sep 07 14:01:29 BRT 2020)https://example.com/TransclusionExampleSequenceOfCards changed on (Mon Sep 07 13:30:32 BRT 2020)https://example.com/SequenceOfCardssystemrecentchanges changed on (Thu Sep 03 13:10:24 BRT 2020)https://example.com/systemrecentchangesevalexamples changed on (Thu Sep 03 03:32:22 BRT 2020)https://example.com/evalexamplesgettingstarted changed on (Tue Aug 25 03:51:34 BRT 2020)https://example.com/gettingstarted \ No newline at end of file diff --git a/bedrock/system/recentchanges b/bedrock/system/recentchanges index 1135862..dcf7891 100644 --- a/bedrock/system/recentchanges +++ b/bedrock/system/recentchanges @@ -1,9 +1,14 @@ +* [[TestNetwork]] (Wed May 11 16:30:14 BST 2022) +* [[ReleaseNotes]] (Wed May 11 16:27:31 BST 2022) +* [[ExportTime]] (Wed May 11 16:26:24 BST 2022) +* [[ExportableWorkspaces]] (Wed May 11 16:07:07 BST 2022) +* [[WorkspaceExample]] (Wed May 11 16:04:07 BST 2022) +* [[EvalExamples]] (Wed May 11 16:02:49 BST 2022) +* [[HelloWorld]] (Wed May 11 15:55:20 BST 2022) * [[CardTypes]] (Tue Mar 22 17:26:05 GMT 2022) * [[PatterningExamples]] (Tue Mar 22 17:17:40 GMT 2022) -* [[EvalExamples]] (Sun Feb 20 16:06:06 GMT 2022) * [[SandBox]] (Wed Jun 16 16:29:33 BRT 2021) * [[ASearchExample]] (Wed Jun 16 16:25:07 BRT 2021) -* [[WorkspaceExample]] (Wed Jun 16 15:39:28 BRT 2021) * [[EmbeddingExamples]] (Wed Jun 16 15:24:01 BRT 2021) * [[SocialEmbedding]] (Wed Jun 16 15:24:01 BRT 2021) * [[MusicEmbedding]] (Wed Jun 16 15:19:38 BRT 2021) @@ -19,7 +24,6 @@ * [[BlahPage]] (Wed Jan 20 19:17:49 BRT 2021) * [[SandBox2]] (Wed Jan 20 19:06:37 BRT 2021) * [[AnotherPage]] (Tue Dec 01 15:48:42 BRT 2020) -* [[HelloWorld]] (Tue Dec 01 15:38:11 BRT 2020) * [[RecentChanges]] (Tue Dec 01 15:37:15 BRT 2020) * [[TrashCan]] (Sun Nov 22 13:45:50 BRT 2020) * [[UserGuide]] (Tue Oct 06 16:33:35 BRT 2020)