Skip to content

Commit

Permalink
adding ReleaseNotes to wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
interstar committed May 11, 2022
1 parent 9488772 commit 1477c70
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 17 deletions.
27 changes: 18 additions & 9 deletions RELEASE_NOTES.txt
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion bedrock/EvalExamples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down
10 changes: 10 additions & 0 deletions bedrock/ExportTime.md
Original file line number Diff line number Diff line change
@@ -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*.
1 change: 1 addition & 0 deletions bedrock/HelloWorld.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]]

----

Expand Down
24 changes: 24 additions & 0 deletions bedrock/ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 2 additions & 3 deletions bedrock/WorkspaceExample.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
]]

----


Expand Down
2 changes: 1 addition & 1 deletion bedrock/exported/api/rc-rss.xml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<?xml version="1.0" encoding="UTF-8"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><atom:link href="https://example.com/" rel="self" type="application/rss+xml"/><title>RecentChanges</title><link>https://example.com/</link><description>Recent Changes in CardiganBay Wiki</description><generator>clj-rss</generator><item><title>CardTypes changed on (Tue Mar 22 17:26:05 GMT 2022)</title><link>https://example.com/CardTypes</link></item><item><title>PatterningExamples changed on (Tue Mar 22 17:17:40 GMT 2022)</title><link>https://example.com/PatterningExamples</link></item><item><title>EvalExamples changed on (Sun Feb 20 16:06:06 GMT 2022)</title><link>https://example.com/EvalExamples</link></item><item><title>SandBox changed on (Wed Jun 16 16:29:33 BRT 2021)</title><link>https://example.com/SandBox</link></item><item><title>ASearchExample changed on (Wed Jun 16 16:25:07 BRT 2021)</title><link>https://example.com/ASearchExample</link></item><item><title>WorkspaceExample changed on (Wed Jun 16 15:39:28 BRT 2021)</title><link>https://example.com/WorkspaceExample</link></item><item><title>EmbeddingExamples changed on (Wed Jun 16 15:24:01 BRT 2021)</title><link>https://example.com/EmbeddingExamples</link></item><item><title>SocialEmbedding changed on (Wed Jun 16 15:24:01 BRT 2021)</title><link>https://example.com/SocialEmbedding</link></item><item><title>MusicEmbedding changed on (Wed Jun 16 15:19:38 BRT 2021)</title><link>https://example.com/MusicEmbedding</link></item><item><title>VideoEmbedding changed on (Wed Jun 16 15:17:40 BRT 2021)</title><link>https://example.com/VideoEmbedding</link></item><item><title>InQueue changed on (Wed Jun 16 15:08:18 BRT 2021)</title><link>https://example.com/InQueue</link></item><item><title>NetworkDiagramExample changed on (Wed Jun 16 13:40:13 BRT 2021)</title><link>https://example.com/NetworkDiagramExample</link></item><item><title>SB2 changed on (Sat Jun 05 17:15:07 BRT 2021)</title><link>https://example.com/SB2</link></item><item><title>SimonWardley changed on (Tue Jun 01 22:55:07 BRT 2021)</title><link>https://example.com/SimonWardley</link></item><item><title>TestTwo changed on (Tue Jun 01 22:52:20 BRT 2021)</title><link>https://example.com/TestTwo</link></item><item><title>TestMove changed on (Tue Jun 01 22:42:13 BRT 2021)</title><link>https://example.com/TestMove</link></item><item><title>OutstandingTask changed on (Thu May 06 17:51:21 BRT 2021)</title><link>https://example.com/OutstandingTask</link></item><item><title>AboutThisWiki changed on (Sun May 02 22:26:17 BRT 2021)</title><link>https://example.com/AboutThisWiki</link></item><item><title>BlahPage changed on (Wed Jan 20 19:17:49 BRT 2021)</title><link>https://example.com/BlahPage</link></item><item><title>SandBox2 changed on (Wed Jan 20 19:06:37 BRT 2021)</title><link>https://example.com/SandBox2</link></item><item><title>AnotherPage changed on (Tue Dec 01 15:48:42 BRT 2020)</title><link>https://example.com/AnotherPage</link></item><item><title>HelloWorld changed on (Tue Dec 01 15:38:11 BRT 2020)</title><link>https://example.com/HelloWorld</link></item><item><title>RecentChanges changed on (Tue Dec 01 15:37:15 BRT 2020)</title><link>https://example.com/RecentChanges</link></item><item><title>TrashCan changed on (Sun Nov 22 13:45:50 BRT 2020)</title><link>https://example.com/TrashCan</link></item><item><title>UserGuide changed on (Tue Oct 06 16:33:35 BRT 2020)</title><link>https://example.com/UserGuide</link></item><item><title>CardiganBay changed on (Mon Oct 05 19:20:28 BRT 2020)</title><link>https://example.com/CardiganBay</link></item><item><title>GettingStarted changed on (Sun Oct 04 23:29:55 BRT 2020)</title><link>https://example.com/GettingStarted</link></item><item><title>WhatIsAWiki changed on (Sun Oct 04 22:53:48 BRT 2020)</title><link>https://example.com/WhatIsAWiki</link></item><item><title> changed on </title><link>https://example.com/</link></item><item><title>ExtraMarkupExamples changed on (Sun Oct 04 21:48:38 BRT 2020)</title><link>https://example.com/ExtraMarkupExamples</link></item><item><title>HackerOnBoarding changed on (Thu Oct 01 02:42:22 BRT 2020)</title><link>https://example.com/HackerOnBoarding</link></item><item><title>BookmarkingInstructions changed on (Thu Oct 01 01:42:31 BRT 2020)</title><link>https://example.com/BookmarkingInstructions</link></item><item><title>CardBar changed on (Thu Oct 01 01:30:12 BRT 2020)</title><link>https://example.com/CardBar</link></item><item><title>OrphanPages changed on (Thu Oct 01 00:53:15 BRT 2020)</title><link>https://example.com/OrphanPages</link></item><item><title>IntroductionToCardiganBay changed on (Mon Sep 07 23:33:16 BRT 2020)</title><link>https://example.com/IntroductionToCardiganBay</link></item><item><title>DigitalGardens changed on (Mon Sep 07 23:12:13 BRT 2020)</title><link>https://example.com/DigitalGardens</link></item><item><title>TransclusionExample changed on (Mon Sep 07 14:01:29 BRT 2020)</title><link>https://example.com/TransclusionExample</link></item><item><title>SequenceOfCards changed on (Mon Sep 07 13:30:32 BRT 2020)</title><link>https://example.com/SequenceOfCards</link></item><item><title>systemrecentchanges changed on (Thu Sep 03 13:10:24 BRT 2020)</title><link>https://example.com/systemrecentchanges</link></item><item><title>evalexamples changed on (Thu Sep 03 03:32:22 BRT 2020)</title><link>https://example.com/evalexamples</link></item><item><title>gettingstarted changed on (Tue Aug 25 03:51:34 BRT 2020)</title><link>https://example.com/gettingstarted</link></item></channel></rss>
<?xml version="1.0" encoding="UTF-8"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><atom:link href="https://example.com/" rel="self" type="application/rss+xml"/><title>RecentChanges</title><link>https://example.com/</link><description>Recent Changes in CardiganBay Wiki</description><generator>clj-rss</generator><item><title>WorkspaceExample changed on (Mon May 09 22:09:54 BST 2022)</title><link>https://example.com/WorkspaceExample</link></item><item><title>CardTypes changed on (Tue Mar 22 17:26:05 GMT 2022)</title><link>https://example.com/CardTypes</link></item><item><title>PatterningExamples changed on (Tue Mar 22 17:17:40 GMT 2022)</title><link>https://example.com/PatterningExamples</link></item><item><title>EvalExamples changed on (Sun Feb 20 16:06:06 GMT 2022)</title><link>https://example.com/EvalExamples</link></item><item><title>SandBox changed on (Wed Jun 16 16:29:33 BRT 2021)</title><link>https://example.com/SandBox</link></item><item><title>ASearchExample changed on (Wed Jun 16 16:25:07 BRT 2021)</title><link>https://example.com/ASearchExample</link></item><item><title>EmbeddingExamples changed on (Wed Jun 16 15:24:01 BRT 2021)</title><link>https://example.com/EmbeddingExamples</link></item><item><title>SocialEmbedding changed on (Wed Jun 16 15:24:01 BRT 2021)</title><link>https://example.com/SocialEmbedding</link></item><item><title>MusicEmbedding changed on (Wed Jun 16 15:19:38 BRT 2021)</title><link>https://example.com/MusicEmbedding</link></item><item><title>VideoEmbedding changed on (Wed Jun 16 15:17:40 BRT 2021)</title><link>https://example.com/VideoEmbedding</link></item><item><title>InQueue changed on (Wed Jun 16 15:08:18 BRT 2021)</title><link>https://example.com/InQueue</link></item><item><title>NetworkDiagramExample changed on (Wed Jun 16 13:40:13 BRT 2021)</title><link>https://example.com/NetworkDiagramExample</link></item><item><title>SB2 changed on (Sat Jun 05 17:15:07 BRT 2021)</title><link>https://example.com/SB2</link></item><item><title>SimonWardley changed on (Tue Jun 01 22:55:07 BRT 2021)</title><link>https://example.com/SimonWardley</link></item><item><title>TestTwo changed on (Tue Jun 01 22:52:20 BRT 2021)</title><link>https://example.com/TestTwo</link></item><item><title>TestMove changed on (Tue Jun 01 22:42:13 BRT 2021)</title><link>https://example.com/TestMove</link></item><item><title>OutstandingTask changed on (Thu May 06 17:51:21 BRT 2021)</title><link>https://example.com/OutstandingTask</link></item><item><title>AboutThisWiki changed on (Sun May 02 22:26:17 BRT 2021)</title><link>https://example.com/AboutThisWiki</link></item><item><title>BlahPage changed on (Wed Jan 20 19:17:49 BRT 2021)</title><link>https://example.com/BlahPage</link></item><item><title>SandBox2 changed on (Wed Jan 20 19:06:37 BRT 2021)</title><link>https://example.com/SandBox2</link></item><item><title>AnotherPage changed on (Tue Dec 01 15:48:42 BRT 2020)</title><link>https://example.com/AnotherPage</link></item><item><title>HelloWorld changed on (Tue Dec 01 15:38:11 BRT 2020)</title><link>https://example.com/HelloWorld</link></item><item><title>RecentChanges changed on (Tue Dec 01 15:37:15 BRT 2020)</title><link>https://example.com/RecentChanges</link></item><item><title>TrashCan changed on (Sun Nov 22 13:45:50 BRT 2020)</title><link>https://example.com/TrashCan</link></item><item><title>UserGuide changed on (Tue Oct 06 16:33:35 BRT 2020)</title><link>https://example.com/UserGuide</link></item><item><title>CardiganBay changed on (Mon Oct 05 19:20:28 BRT 2020)</title><link>https://example.com/CardiganBay</link></item><item><title>GettingStarted changed on (Sun Oct 04 23:29:55 BRT 2020)</title><link>https://example.com/GettingStarted</link></item><item><title>WhatIsAWiki changed on (Sun Oct 04 22:53:48 BRT 2020)</title><link>https://example.com/WhatIsAWiki</link></item><item><title> changed on </title><link>https://example.com/</link></item><item><title>ExtraMarkupExamples changed on (Sun Oct 04 21:48:38 BRT 2020)</title><link>https://example.com/ExtraMarkupExamples</link></item><item><title>HackerOnBoarding changed on (Thu Oct 01 02:42:22 BRT 2020)</title><link>https://example.com/HackerOnBoarding</link></item><item><title>BookmarkingInstructions changed on (Thu Oct 01 01:42:31 BRT 2020)</title><link>https://example.com/BookmarkingInstructions</link></item><item><title>CardBar changed on (Thu Oct 01 01:30:12 BRT 2020)</title><link>https://example.com/CardBar</link></item><item><title>OrphanPages changed on (Thu Oct 01 00:53:15 BRT 2020)</title><link>https://example.com/OrphanPages</link></item><item><title>IntroductionToCardiganBay changed on (Mon Sep 07 23:33:16 BRT 2020)</title><link>https://example.com/IntroductionToCardiganBay</link></item><item><title>DigitalGardens changed on (Mon Sep 07 23:12:13 BRT 2020)</title><link>https://example.com/DigitalGardens</link></item><item><title>TransclusionExample changed on (Mon Sep 07 14:01:29 BRT 2020)</title><link>https://example.com/TransclusionExample</link></item><item><title>SequenceOfCards changed on (Mon Sep 07 13:30:32 BRT 2020)</title><link>https://example.com/SequenceOfCards</link></item><item><title>systemrecentchanges changed on (Thu Sep 03 13:10:24 BRT 2020)</title><link>https://example.com/systemrecentchanges</link></item><item><title>evalexamples changed on (Thu Sep 03 03:32:22 BRT 2020)</title><link>https://example.com/evalexamples</link></item><item><title>gettingstarted changed on (Tue Aug 25 03:51:34 BRT 2020)</title><link>https://example.com/gettingstarted</link></item></channel></rss>
10 changes: 7 additions & 3 deletions bedrock/system/recentchanges
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)
Expand Down

0 comments on commit 1477c70

Please sign in to comment.