Tidied up documentation; added GNU GPL header to many files.

This commit is contained in:
Simon Brooke 2014-11-11 17:38:38 +00:00
parent fc89b25a2f
commit 45a4b2fb99
11 changed files with 148 additions and 6 deletions

View file

@ -18,11 +18,12 @@ that is to say, the username is a keyword and the corresponding password is a st
## Todo ## Todo
* Git integration! Smeagol doesn't have any inbuilt versioning or backup mechanism; it's intended that Git will be used as that mechanism. But it isn't implemented yet. * Git integration! Smeagol doesn't have any inbuilt versioning or backup mechanism; it's intended that Git will be used as that mechanism. But it isn't implemented yet;
* Image (and other media) upload. * Image (and other media) upload;
* Improved security. * Improved editor. The editor is at present very primitive - right back from the beginnings of the Web. It would be nice to have a rich embedded editor like [Hallo](https://github.com/bergie/hallo) or [Aloha](http://aloha-editor.org/Content.Node/index.html) but I havenven't (yet) had time to integrate them!
* Mechanism to add users through the user interface. * Improved security. Having the passwords in plain text rather than encrypted is just basically poor; having the passwd file in *public* space is also poor (although I believe it cannot be accessed via HTTP). Essentially, authentication mechanisms should be pluggable, and at present they aren't;
* Mechanism to change passwords through the user interface. * Mechanism to add users through the user interface;
* Mechanism to change passwords through the user interface;
## Editing the framing content ## Editing the framing content

View file

@ -1,3 +1,23 @@
/*
* Smeagol: a very simple Wiki engine
* Copyright (C) 2014 Simon Brooke
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*/
body { body {
margin: 0; margin: 0;
padding: 0; padding: 0;
@ -84,9 +104,10 @@ li.nav-item a:active { background: gray; color: white; }
padding: 0 2em; padding: 0 2em;
text-align: center; text-align: center;
color:white; color:white;
background:rgba(196,196,196,0.95); background:rgba(128,128,128,0.95);
width: 100%; width: 100%;
margin: 0; margin: 0;
padding: 0.1em 10%;
bottom:0; bottom:0;
position:fixed; position:fixed;
z-index:150; z-index:150;

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

View file

@ -50,6 +50,7 @@
<img height="16" width="16" align="top" src="img/smeagol.png"/>Smeagol wiki engine || Built with <a href="http://www.luminusweb.net/">LuminusWeb</a> || <img height="16" width="16" align="top" src="img/smeagol.png"/>Smeagol wiki engine || Built with <a href="http://www.luminusweb.net/">LuminusWeb</a> ||
<img height="16" width="16" align="top" src="img/clojure-icon.gif"/> Powered by <a href="http://clojure.org">Clojure</a> || <img height="16" width="16" align="top" src="img/clojure-icon.gif"/> Powered by <a href="http://clojure.org">Clojure</a> ||
<img height="16" width="16" align="top" src="img/github-logo-transparent.png"/>Find me/fork me on <a href="https://github.com/simon-brooke/smeagol">Github</a> || <img height="16" width="16" align="top" src="img/github-logo-transparent.png"/>Find me/fork me on <a href="https://github.com/simon-brooke/smeagol">Github</a> ||
<img height="16" width="16" align="top" src="img/gnu.small.png"/>Licensed under the <a href="http://www.gnu.org/licenses/gpl-2.0.html">GNU General Public License version 2.0</a>
</div> </div>
</div> </div>
</body> </body>

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.handler (ns smeagol.handler
(:require [compojure.core :refer [defroutes]] (:require [compojure.core :refer [defroutes]]
[smeagol.routes.wiki :refer [wiki-routes]] [smeagol.routes.wiki :refer [wiki-routes]]

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.layout (ns smeagol.layout
(:require [selmer.parser :as parser] (:require [selmer.parser :as parser]
[clojure.string :as s] [clojure.string :as s]

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.middleware (ns smeagol.middleware
(:require [taoensso.timbre :as timbre] (:require [taoensso.timbre :as timbre]
[selmer.parser :as parser] [selmer.parser :as parser]

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.repl (ns smeagol.repl
(:use smeagol.handler (:use smeagol.handler
ring.server.standalone ring.server.standalone

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.routes.wiki (ns smeagol.routes.wiki
(:use clojure.walk) (:use clojure.walk)
(:require [compojure.core :refer :all] (:require [compojure.core :refer :all]

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.session-manager (ns smeagol.session-manager
(:require [noir.session :refer [clear-expired-sessions]] (:require [noir.session :refer [clear-expired-sessions]]
[cronj.core :refer [cronj]])) [cronj.core :refer [cronj]]))

View file

@ -1,3 +1,20 @@
;; Smeagol: a very simple Wiki engine
;; Copyright (C) 2014 Simon Brooke
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(ns smeagol.util (ns smeagol.util
(:require [noir.io :as io] (:require [noir.io :as io]
[markdown.core :as md])) [markdown.core :as md]))