Cardigan-Bay 0.8.0

Release 0.8.0 Notes

A lot of big changes, and some fixes.

Breaking Changes

There's been a change to the way we pass parameters to Cardigan Bay when starting up.

• Command line arguments still work ... BUT
• You are now encouraged to keep most of your configurations in a file called <page-directory>/system/config.edn

When Cardigan Bay starts it will start by reading the command line arguments. But then read the config.edn file.

The parameters defined in config.edn will take precedence over those defined on the command line.

Astute observers will note that the one parameter which can NOT be given in the config.edn file is the :directory ... as Cardigan Bay needs to know the directory before it can find the config.edn file

I've dithered about this for a while, but of all the options I considered, this seems the least confusing in practice. Basically either run Cardigan Bay with the default bedrock directory under the place where the code sits. Or, pass the -d flag on the command line as you have currently been doing, to point it at a different page directory. All the other parameters can now be kept within that page directory, in system/config.edn

Non-breaking Changes

Card level editing. This is the BIG ONE anyone who has used CB will have been waiting for. You can now edit an individual card. It's not particularly pretty yet (though hopefully it will get prettier soon), but now, when you open up the card bar at the bottom of a card, there's another edit-box with just the source of that particular card. So you can now do more focused editing.

Note, that while this is very useful, particularly on longer pages, it will never replace the one-big-text-box philosophy of Cardigan Bay. There will always be a canonical single text file view of a page.

Workspace Saving. This is also a big deal. As the server now has the ability to accept individual card updates, it means that the Workspace finally gets a [Save] button. So as you are working on code interactively in the workspace, you can hit the save button to store it. No need to copy and paste it into the page level editor.

Network Cards. These are still an experimental feature. But it's always been the intention for Cardigan Bay to support a type of card which is a hand-drawn network diagram of boxes and arrows. Each node is, itself, a link to a page. So you can make graphical overviews of topics that are then covered on their own pages. There's currently no graphical editor for this card type. But this version of CB does at least now have a reasonable looking rendering. (The graphical editor is being worked on, but not yet enabled)

Media Directory Cards. CB already has the <page-directory>/media/ as a place to store your media files. There is now a :system command for listing the media directory. And an extra card type for linking to a media file.

Cardigan-Bay 0.7.3

Release 0.7.3 Notes

There's been a considerable overhaul of the look Cardigan Bay, with improved CSS, some changes to hopefully make the UI a lot more friendly and intelligible to new users.

Patterning support has been enhanced (including adding l-systems etc.)

The Export All link on the main menu has been replaced by an Export Recent Pages link. This exports only the pages listed on RecentChanges. So rather than re-exporting the whole wiki after making a few changes, you can now just re-export what's changed.

The "Quick Paste" bar in the editor has been replaced by a "Copy Bar". When you press the buttons, instead of the snippet being inserted into the edit box directly, it's now copied to the clipboard. It was decided that it's more logical to select a snippet and then find where to insert it (using normal browser paste) than position the cursor first and then press the button. The copy bar is also in several pages. Page 0 is things useful for convenient text editing, especially on mobile (eg quick paste of pairs of double square brackets etc.) The second page has the embedded media types. And the third page useful snippets of Clojure.

More documentation in bedrock.

Cardigan-Bay 0.7.1

Release 0.7.1 Notes

Now added private / public separation for Workspaces.

Cardigan-Bay 0.7.0

Release 0.7.0 Notes

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)

Cardigan-Bay 0.6.0

New release

• New NavBar functionality (Execute ClojureScript and Search Buttons)

• Improved bookmarking.

• RSS feed reader as card-type

• Still clunky but generally slicker

Cardigan-Bay 0.5.1

Some minor additions and improvements which you don't need to worry about.

Cardigan-Bay 0.5.0

Notes :

ANOTHER BREAKING CHANGE

The template for exporting has now been moved to a system subfolder of the pages folder. As has the recentchanges page.

From now on CardiganBay needs to have this system subdirectory

There also now needs to be an api/ subdir of the exported directory for the rss feed. See the layout of the included Bedrock wiki.

Other fixes / improvements

Some code refactoring.

It should now be possible to have the right link pattern for the exported static pages. You need to pass this as an argument using the -l (for "link pattern") flag.

A static RSS feed file is now exported.

Cardigan-Bay 0.1.0

New in this release :

• Move a card from one page to another
• RSS link
• Better looking
• Internal refactoring of graphql

Known Issues

• moving cards to pages that contain transclusions causes a serious bug that kills the server. Transclusions are not officially recommended yet.

Cardigan-Bay Early 0.0.3

Working version : 29/08/2020

Tested on Linux, Raspian on the Raspberry Pi 3, Windows

Quick Start :

Unzip the cardigan.zip file

Go into the cardigan directory

java -jar cardigan.jar

Go to http://localhost:4545/index.html in your browser

This is in the go.sh file. And the go.bat file for Windows.

Options

java -jar cardigan.jar -n NAME -p PORT-NUMBER -d DIRECTORY

NAME should be a string, and be the name of your wiki. Eg. "ThoughtStorms Wiki"

PORT-NUMBER should be a port number. Eg. 4008. That puts your wiki at http://localhost:4008/index.html

DIRECTORY should be the absolute path on your operating system to an existing directory where you will keep the pages.

By Default

Cardigan Bay uses a directory called bedrock which contains the default wiki pages. It's best to start any new wiki by cloning the "bedrock" directory. Cardigan Bay doesn't need you to do this, this, but there is useful functionality and examples embedded in those pages.

The front-page of all wikis is the "HelloWorld" page.

The default port number is 4545

What's in this release?

Bug Fixes

Nicer CSS and look

Has automatic backlinks in an automatically generated card at the end of each page. (For all you Roam Research cultists)

Moved to Java new Files and Paths to manage file system and dropped fsquery-clj dependency.