Fix a regression introduced in v0.14.0

Introduce the concept of catalogs, improve books and code refactoring

.github/workflows/django.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       max-parallel: 2
       matrix:
-        python-version: ['3.9', '3.10']
+        python-version: ['3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -10,7 +10,6 @@ __pycache__/
 .Python
 build/
 develop-eggs/
-dist/
 downloads/
 eggs/
 .eggs/

README.md

@@ -2,8 +2,7 @@
 
 [![Django CI](https://github.com/daniviga/django-rma/actions/workflows/django.yml/badge.svg)](https://github.com/daniviga/django-rma/actions/workflows/django.yml)
 
-![image](https://user-images.githubusercontent.com/1818657/175789825-9a03f0ff-a95e-42a2-9611-e14d2817e22f.png)
-
+![Screenshot 2023-09-18 at 21-57-33 Company RGS - Railroad Assets Manager](https://github.com/daniviga/django-ram/assets/1818657/d20fbe27-1192-4ab1-a19f-8d2ae50cf781)
 
 A `jff` (just for fun) project that aims to create a
 model railroad assets manager that allows to:
@@ -22,10 +21,12 @@ it has been developed with a commitment of few minutes a day;
 it lacks any kind of documentation, code review, architectural review,
 security assesment, pentest, ISO certification, etc.
 
-This project probably doesn't match you needs nor expectations. Be aware.
+This project probably doesn't match your needs nor expectations. Be aware.
 
 Your model train may also catch fire while using this software.
 
+Check out [my own instance](https://daniele.mynarrowgauge.org).
+
 ## Components
 
 Project is based on the following technologies and components:
@@ -48,7 +49,7 @@ It has been developed with:
 
 ## Requirements
 
-- Python 3.8+
+- Python 3.10+
 - A USB port when running Arduino hardware (and adaptors if you have a Mac)
 
 ## Web portal installation
@@ -95,7 +96,8 @@ Browse to `http://localhost:8000`
 
 The DCC++ EX connector exposes an Arduino board running DCC++ EX Command Station,
 connected via serial port, to the network, allowing commands to be sent via a
-TCP socket.
+TCP socket. A response generated by the DCC++ EX board is sent to all connected clients,
+providing synchronization between multiple clients (eg. multiple JMRI instances).
 
 Its use is not needed when running DCC++ EX from a [WiFi](https://dcc-ex.com/get-started/wifi-setup.html) capable board (like when
 using an ESP8266 module or a [Mega+WiFi board](https://dcc-ex.com/advanced-setup/supported-microcontrollers/wifi-mega.html)).
@@ -111,7 +113,7 @@ Settings may need to be customized based on your setup.
 ```bash
 $ cd daemons
 $ podman build -t dcc/net-to-serial .
-$ podman run -d -p 2560:2560 dcc/net-to-serial
+$ podman run --group-add keep-groups --device /dev/ttyACM0 -p 2560:2560 dcc/net-to-serial
 ```
 
 ### Manual setup
@@ -139,13 +141,18 @@ To be continued ...
 
 ### Frontend
 
-![image](https://user-images.githubusercontent.com/1818657/175789897-9ec4a9bb-9c65-48ef-9b57-ae94e094e6a7.png)
+![Screenshot 2023-09-18 at 22-00-39 RGS C-19 #40 - Railroad Assets Manager](https://github.com/daniviga/django-ram/assets/1818657/94834b89-5b17-46e7-9494-a1651d72c072)
 ---
-![image](https://user-images.githubusercontent.com/1818657/175789901-ef50acd7-8c05-4788-92a2-1bb1280d598c.png)
+![Screenshot 2023-09-18 at 21-59-30 RGS 1930s short train - Railroad Assets Manager](https://github.com/daniviga/django-ram/assets/1818657/77f9b7c9-27b3-4a65-bad0-26e9cf77e623)
+
+
+
+#### Dark mode
+
+![Screenshot 2023-09-18 at 21-58-22 Company RGS - Railroad Assets Manager](https://github.com/daniviga/django-ram/assets/1818657/c95697c9-0897-46f4-941c-6092271e4743)
+
 ---
-![image](https://user-images.githubusercontent.com/1818657/175790004-18926d23-28f9-45bb-b279-6c26575ae3a5.png)
----
-![image](https://user-images.githubusercontent.com/1818657/175790008-62eea2cc-1c41-42df-9026-4cf6e8ef712c.png)
+
 
 
 ### Backoffice
@@ -158,8 +165,7 @@ To be continued ...
 
 ### Rest API
 
-![image](https://user-images.githubusercontent.com/1818657/175790064-23ec038e-e8bf-4c39-964c-3118e4295b59.png)
-
+![image](https://user-images.githubusercontent.com/1818657/180622471-ade06c84-c73b-41d5-a2a7-02a95b2ffc02.png)
 
 
 

daemons/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10-alpine
+FROM python:3.11-alpine
 
 RUN mkdir /opt/dcc && pip -q install pyserial
 ADD net-to-serial.py config.ini /opt/dcc

daemons/README.md

@@ -0,0 +1,3 @@
+## DCC++ EX connector
+
+See [README.md](../README.md)

daemons/config.ini

@@ -2,6 +2,7 @@
 LogLevel = debug
 ListeningIP = 0.0.0.0
 ListeningPort = 2560
+MaxClients = 10
 
 [Serial]
 # UNO

daemons/net-to-serial.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 import re
-import time
 import logging
 import serial
 import asyncio
@@ -10,11 +9,15 @@ from pathlib import Path
 
 
 class SerialDaemon:
+    connected_clients = set()
+
     def __init__(self, config):
         self.ser = serial.Serial(
             config["Serial"]["Port"],
-            timeout=int(config["Serial"]["Timeout"])/1000)
+            timeout=int(config["Serial"]["Timeout"]) / 1000,
+        )
         self.ser.baudrate = config["Serial"]["Baudrate"]
+        self.max_clients = int(config["Daemon"]["MaxClients"])
 
     def __del__(self):
         try:
@@ -43,19 +46,32 @@ class SerialDaemon:
 
     async def handle_echo(self, reader, writer):
         """Process a request from socket and return the response"""
-        while 1:  # keep connection to client open
+        logging.info(
+            "Clients already connected: {} (max: {})".format(
+                len(self.connected_clients),
+                self.max_clients,
+            )
+        )
+
+        addr = writer.get_extra_info("peername")[0]
+        if len(self.connected_clients) < self.max_clients:
+            self.connected_clients.add(writer)
+            while True:  # keep connection to client open
                 data = await reader.read(100)
                 if not data:  # client has disconnected
                     break
-
-            addr = writer.get_extra_info('peername')
-            logging.info("Received {} from {}".format(data, addr[0]))
-
+                logging.info("Received {} from {}".format(data, addr))
                 self.__write_serial(data)
                 response = self.__read_serial()
-            writer.write(response)
-            await writer.drain()
+                for client in self.connected_clients:
+                    client.write(response)
+                    await client.drain()
                 logging.info("Sent: {}".format(response))
+            self.connected_clients.remove(writer)
+        else:
+            logging.warning(
+                "TooManyClients: client {} disconnected".format(addr)
+            )
 
         writer.close()
         await writer.wait_closed()
@@ -68,33 +84,37 @@ class SerialDaemon:
         while "DCC-EX" not in line:
             line = self.__read_serial().decode()
         board = re.findall(r"<iDCC-EX.*>", line)[0]
-        return(board)
+        return board
 
 
 async def main():
     config = configparser.ConfigParser()
     config.read(
-        Path(__file__).resolve().parent / "config.ini")  # mimick os.path.join
+        Path(__file__).resolve().parent / "config.ini"
+    )  # mimick os.path.join
     logging.basicConfig(level=config["Daemon"]["LogLevel"].upper())
 
     sd = SerialDaemon(config)
     server = await asyncio.start_server(
         sd.handle_echo,
         config["Daemon"]["ListeningIP"],
-        config["Daemon"]["ListeningPort"])
+        config["Daemon"]["ListeningPort"],
+    )
     addr = server.sockets[0].getsockname()
-    logging.warning("Serving on {} port {}".format(addr[0], addr[1]))
-    logging.warning(
+    logging.info("Serving on {} port {}".format(addr[0], addr[1]))
+    logging.info(
         "Proxying to {} (Baudrate: {}, Timeout: {})".format(
             config["Serial"]["Port"],
             config["Serial"]["Baudrate"],
-            config["Serial"]["Timeout"]))
-    logging.warning("Initializing board")
-    logging.warning("Board {} ready".format(
-        await sd.return_board()))
+            config["Serial"]["Timeout"],
+        )
+    )
+    logging.info("Initializing board")
+    logging.info("Board {} ready".format(await sd.return_board()))
 
     async with server:
         await server.serve_forever()
 
+
 if __name__ == "__main__":
     asyncio.run(main())

ram/bookshelf/admin.py

@@ -0,0 +1,169 @@
+from django.contrib import admin
+from adminsortable2.admin import SortableAdminBase, SortableInlineAdminMixin
+
+from bookshelf.models import (
+    BaseBookProperty,
+    BaseBookImage,
+    BaseBookDocument,
+    Book,
+    Author,
+    Publisher,
+    Catalog,
+)
+
+
+class BookImageInline(SortableInlineAdminMixin, admin.TabularInline):
+    model = BaseBookImage
+    min_num = 0
+    extra = 0
+    readonly_fields = ("image_thumbnail",)
+    classes = ["collapse"]
+    verbose_name = "Image"
+
+
+class BookDocInline(admin.TabularInline):
+    model = BaseBookDocument
+    min_num = 0
+    extra = 0
+    classes = ["collapse"]
+
+
+class BookPropertyInline(admin.TabularInline):
+    model = BaseBookProperty
+    min_num = 0
+    extra = 0
+    autocomplete_fields = ("property",)
+    verbose_name = "Property"
+    verbose_name_plural = "Properties"
+
+
+@admin.register(Book)
+class BookAdmin(SortableAdminBase, admin.ModelAdmin):
+    inlines = (
+        BookPropertyInline,
+        BookImageInline,
+        BookDocInline,
+    )
+    list_display = (
+        "title",
+        "get_authors",
+        "get_publisher",
+        "publication_year",
+        "number_of_pages",
+        "published",
+    )
+    autocomplete_fields = ("authors", "publisher")
+    readonly_fields = ("creation_time", "updated_time")
+    search_fields = ("title", "publisher__name", "authors__last_name")
+    list_filter = ("publisher__name", "authors")
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "published",
+                    "title",
+                    "authors",
+                    "publisher",
+                    "ISBN",
+                    "language",
+                    "number_of_pages",
+                    "publication_year",
+                    "description",
+                    "purchase_date",
+                    "notes",
+                    "tags",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )
+
+    @admin.display(description="Publisher")
+    def get_publisher(self, obj):
+        return obj.publisher.name
+
+    @admin.display(description="Authors")
+    def get_authors(self, obj):
+        return ", ".join(a.short_name() for a in obj.authors.all())
+
+
+@admin.register(Author)
+class AuthorAdmin(admin.ModelAdmin):
+    search_fields = (
+        "first_name",
+        "last_name",
+    )
+    list_filter = ("last_name",)
+
+
+@admin.register(Publisher)
+class PublisherAdmin(admin.ModelAdmin):
+    list_display = ("name", "country")
+    search_fields = ("name",)
+
+
+@admin.register(Catalog)
+class CatalogAdmin(SortableAdminBase, admin.ModelAdmin):
+    inlines = (
+        BookPropertyInline,
+        BookImageInline,
+        BookDocInline,
+    )
+    list_display = (
+        "__str__",
+        "manufacturer",
+        "years",
+        "get_scales",
+        "published",
+    )
+    autocomplete_fields = ("manufacturer",)
+    readonly_fields = ("creation_time", "updated_time")
+    search_fields = ("manufacturer__name", "years", "scales__scale")
+    list_filter = ("manufacturer__name", "publication_year", "scales__scale")
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "published",
+                    "manufacturer",
+                    "years",
+                    "scales",
+                    "ISBN",
+                    "language",
+                    "number_of_pages",
+                    "publication_year",
+                    "description",
+                    "purchase_date",
+                    "notes",
+                    "tags",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )
+
+    @admin.display(description="Scales")
+    def get_scales(self, obj):
+        return "/".join(s.scale for s in obj.scales.all())

ram/bookshelf/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class BookshelfConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "bookshelf"

ram/bookshelf/migrations/0001_initial.py

@@ -0,0 +1,121 @@
+# Generated by Django 4.2.5 on 2023-10-01 20:16
+
+# ckeditor removal
+# import ckeditor_uploader.fields
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("metadata", "0012_alter_decoder_manufacturer_decoderdocument"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Author",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("first_name", models.CharField(max_length=100)),
+                ("last_name", models.CharField(max_length=100)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Book",
+            fields=[
+                (
+                    "uuid",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        primary_key=True,
+                        serialize=False,
+                    ),
+                ),
+                ("title", models.CharField(max_length=200)),
+                ("ISBN", models.CharField(max_length=13, unique=True)),
+                ("publication_year", models.SmallIntegerField(blank=True, null=True)),
+                ("purchase_date", models.DateField(blank=True, null=True)),
+                # ("notes", ckeditor_uploader.fields.RichTextUploadingField(blank=True)),
+                ("notes", models.TextField(blank=True)),
+                ("creation_time", models.DateTimeField(auto_now_add=True)),
+                ("updated_time", models.DateTimeField(auto_now=True)),
+                ("authors", models.ManyToManyField(to="bookshelf.author")),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Publisher",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=200)),
+                ("website", models.URLField()),
+            ],
+        ),
+        migrations.CreateModel(
+            name="BookProperty",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("value", models.CharField(max_length=256)),
+                (
+                    "book",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="property",
+                        to="bookshelf.book",
+                    ),
+                ),
+                (
+                    "property",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="metadata.property",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name_plural": "Properties",
+            },
+        ),
+        migrations.AddField(
+            model_name="book",
+            name="publisher",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE, to="bookshelf.publisher"
+            ),
+        ),
+        migrations.AddField(
+            model_name="book",
+            name="tags",
+            field=models.ManyToManyField(
+                blank=True, related_name="bookshelf", to="metadata.tag"
+            ),
+        ),
+    ]

ram/bookshelf/migrations/0002_book_language_book_numbers_of_pages_and_more.py

@@ -0,0 +1,142 @@
+# Generated by Django 4.2.5 on 2023-10-01 21:33
+
+from django.db import migrations, models
+import django_countries.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="book",
+            name="language",
+            field=models.CharField(
+                choices=[
+                    ("af", "Afrikaans"),
+                    ("ar", "Arabic"),
+                    ("ar-dz", "Algerian Arabic"),
+                    ("ast", "Asturian"),
+                    ("az", "Azerbaijani"),
+                    ("bg", "Bulgarian"),
+                    ("be", "Belarusian"),
+                    ("bn", "Bengali"),
+                    ("br", "Breton"),
+                    ("bs", "Bosnian"),
+                    ("ca", "Catalan"),
+                    ("ckb", "Central Kurdish (Sorani)"),
+                    ("cs", "Czech"),
+                    ("cy", "Welsh"),
+                    ("da", "Danish"),
+                    ("de", "German"),
+                    ("dsb", "Lower Sorbian"),
+                    ("el", "Greek"),
+                    ("en", "English"),
+                    ("en-au", "Australian English"),
+                    ("en-gb", "British English"),
+                    ("eo", "Esperanto"),
+                    ("es", "Spanish"),
+                    ("es-ar", "Argentinian Spanish"),
+                    ("es-co", "Colombian Spanish"),
+                    ("es-mx", "Mexican Spanish"),
+                    ("es-ni", "Nicaraguan Spanish"),
+                    ("es-ve", "Venezuelan Spanish"),
+                    ("et", "Estonian"),
+                    ("eu", "Basque"),
+                    ("fa", "Persian"),
+                    ("fi", "Finnish"),
+                    ("fr", "French"),
+                    ("fy", "Frisian"),
+                    ("ga", "Irish"),
+                    ("gd", "Scottish Gaelic"),
+                    ("gl", "Galician"),
+                    ("he", "Hebrew"),
+                    ("hi", "Hindi"),
+                    ("hr", "Croatian"),
+                    ("hsb", "Upper Sorbian"),
+                    ("hu", "Hungarian"),
+                    ("hy", "Armenian"),
+                    ("ia", "Interlingua"),
+                    ("id", "Indonesian"),
+                    ("ig", "Igbo"),
+                    ("io", "Ido"),
+                    ("is", "Icelandic"),
+                    ("it", "Italian"),
+                    ("ja", "Japanese"),
+                    ("ka", "Georgian"),
+                    ("kab", "Kabyle"),
+                    ("kk", "Kazakh"),
+                    ("km", "Khmer"),
+                    ("kn", "Kannada"),
+                    ("ko", "Korean"),
+                    ("ky", "Kyrgyz"),
+                    ("lb", "Luxembourgish"),
+                    ("lt", "Lithuanian"),
+                    ("lv", "Latvian"),
+                    ("mk", "Macedonian"),
+                    ("ml", "Malayalam"),
+                    ("mn", "Mongolian"),
+                    ("mr", "Marathi"),
+                    ("ms", "Malay"),
+                    ("my", "Burmese"),
+                    ("nb", "Norwegian Bokmål"),
+                    ("ne", "Nepali"),
+                    ("nl", "Dutch"),
+                    ("nn", "Norwegian Nynorsk"),
+                    ("os", "Ossetic"),
+                    ("pa", "Punjabi"),
+                    ("pl", "Polish"),
+                    ("pt", "Portuguese"),
+                    ("pt-br", "Brazilian Portuguese"),
+                    ("ro", "Romanian"),
+                    ("ru", "Russian"),
+                    ("sk", "Slovak"),
+                    ("sl", "Slovenian"),
+                    ("sq", "Albanian"),
+                    ("sr", "Serbian"),
+                    ("sr-latn", "Serbian Latin"),
+                    ("sv", "Swedish"),
+                    ("sw", "Swahili"),
+                    ("ta", "Tamil"),
+                    ("te", "Telugu"),
+                    ("tg", "Tajik"),
+                    ("th", "Thai"),
+                    ("tk", "Turkmen"),
+                    ("tr", "Turkish"),
+                    ("tt", "Tatar"),
+                    ("udm", "Udmurt"),
+                    ("uk", "Ukrainian"),
+                    ("ur", "Urdu"),
+                    ("uz", "Uzbek"),
+                    ("vi", "Vietnamese"),
+                    ("zh-hans", "Simplified Chinese"),
+                    ("zh-hant", "Traditional Chinese"),
+                ],
+                default="en",
+                max_length=7,
+            ),
+        ),
+        migrations.AddField(
+            model_name="book",
+            name="numbers_of_pages",
+            field=models.SmallIntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="publisher",
+            name="country",
+            field=django_countries.fields.CountryField(blank=True, max_length=2),
+        ),
+        migrations.AlterField(
+            model_name="book",
+            name="ISBN",
+            field=models.CharField(blank=True, max_length=13),
+        ),
+        migrations.AlterField(
+            model_name="publisher",
+            name="website",
+            field=models.URLField(blank=True),
+        ),
+    ]

ram/bookshelf/migrations/0003_bookimage.py

@@ -0,0 +1,51 @@
+# Generated by Django 4.2.5 on 2023-10-02 10:36
+
+from django.db import migrations, models
+import django.db.models.deletion
+import ram.utils
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0002_book_language_book_numbers_of_pages_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="BookImage",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("order", models.PositiveIntegerField(default=0)),
+                (
+                    "image",
+                    models.ImageField(
+                        blank=True,
+                        null=True,
+                        storage=ram.utils.DeduplicatedStorage,
+                        upload_to="images/books/",
+                    ),
+                ),
+                (
+                    "book",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="image",
+                        to="bookshelf.book",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["order"],
+                "abstract": False,
+            },
+        ),
+    ]

ram/bookshelf/migrations/0004_rename_numbers_of_pages_book_number_of_pages.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-10-02 20:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0003_bookimage"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="book",
+            old_name="numbers_of_pages",
+            new_name="number_of_pages",
+        ),
+    ]

ram/bookshelf/migrations/0005_alter_book_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.5 on 2023-10-03 19:57
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0004_rename_numbers_of_pages_book_number_of_pages"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="book",
+            options={"ordering": ["authors__last_name", "title"]},
+        ),
+    ]

ram/bookshelf/migrations/0006_alter_book_isbn.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-10-03 20:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0005_alter_book_options"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="ISBN",
+            field=models.CharField(blank=True, max_length=17),
+        ),
+    ]

ram/bookshelf/migrations/0007_alter_book_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.5 on 2023-10-03 21:07
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0006_alter_book_isbn"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="book",
+            options={"ordering": ["title"]},
+        ),
+    ]

ram/bookshelf/migrations/0008_alter_author_options_alter_publisher_options.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.6 on 2023-10-09 21:08
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0007_alter_book_options"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="author",
+            options={"ordering": ["last_name", "first_name"]},
+        ),
+        migrations.AlterModelOptions(
+            name="publisher",
+            options={"ordering": ["name"]},
+        ),
+    ]

ram/bookshelf/migrations/0009_alter_bookimage_image.py

@@ -0,0 +1,51 @@
+# Generated by Django 4.2.6 on 2023-10-30 13:16
+
+import os
+import sys
+import shutil
+import ram.utils
+import bookshelf.models
+
+from django.db import migrations, models
+from django.conf import settings
+
+
+def move_images(apps, schema_editor):
+    sys.stdout.write("\n  Processing files. Please await...")
+    for r in bookshelf.models.BaseBookImage.objects.all():
+        fname = os.path.basename(r.image.path)
+        new_image = bookshelf.models.book_image_upload(r, fname)
+        new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+        os.makedirs(os.path.dirname(new_path), exist_ok=True)
+        try:
+            shutil.move(r.image.path, new_path)
+        except FileNotFoundError:
+            sys.stderr.write("  !! FileNotFoundError: {}\n".format(new_image))
+            pass
+        r.image.name = new_image
+        r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0008_alter_author_options_alter_publisher_options"),
+    ]
+
+    # Migration is stale and shouldn't be used since model hes been heavily
+    # modified since then. Leaving it here for reference.
+    operations = [
+        #     migrations.AlterField(
+        #         model_name="bookimage",
+        #         name="image",
+        #         field=models.ImageField(
+        #             blank=True,
+        #             null=True,
+        #             storage=ram.utils.DeduplicatedStorage,
+        #             upload_to=bookshelf.models.book_image_upload,
+        #         ),
+        #     ),
+        #     migrations.RunPython(
+        #         move_images,
+        #         reverse_code=migrations.RunPython.noop
+        #     ),
+    ]

ram/bookshelf/migrations/0010_alter_bookimage_image.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.6 on 2023-11-04 22:53
+
+import bookshelf.models
+from django.db import migrations, models
+import ram.utils
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0009_alter_bookimage_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="bookimage",
+            name="image",
+            field=models.ImageField(
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to=bookshelf.models.book_image_upload,
+            ),
+        ),
+    ]

ram/bookshelf/migrations/0011_alter_book_language.py

@@ -0,0 +1,121 @@
+# Generated by Django 5.0.1 on 2024-01-20 21:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0010_alter_bookimage_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="language",
+            field=models.CharField(
+                choices=[
+                    ("af", "Afrikaans"),
+                    ("ar", "Arabic"),
+                    ("ar-dz", "Algerian Arabic"),
+                    ("ast", "Asturian"),
+                    ("az", "Azerbaijani"),
+                    ("bg", "Bulgarian"),
+                    ("be", "Belarusian"),
+                    ("bn", "Bengali"),
+                    ("br", "Breton"),
+                    ("bs", "Bosnian"),
+                    ("ca", "Catalan"),
+                    ("ckb", "Central Kurdish (Sorani)"),
+                    ("cs", "Czech"),
+                    ("cy", "Welsh"),
+                    ("da", "Danish"),
+                    ("de", "German"),
+                    ("dsb", "Lower Sorbian"),
+                    ("el", "Greek"),
+                    ("en", "English"),
+                    ("en-au", "Australian English"),
+                    ("en-gb", "British English"),
+                    ("eo", "Esperanto"),
+                    ("es", "Spanish"),
+                    ("es-ar", "Argentinian Spanish"),
+                    ("es-co", "Colombian Spanish"),
+                    ("es-mx", "Mexican Spanish"),
+                    ("es-ni", "Nicaraguan Spanish"),
+                    ("es-ve", "Venezuelan Spanish"),
+                    ("et", "Estonian"),
+                    ("eu", "Basque"),
+                    ("fa", "Persian"),
+                    ("fi", "Finnish"),
+                    ("fr", "French"),
+                    ("fy", "Frisian"),
+                    ("ga", "Irish"),
+                    ("gd", "Scottish Gaelic"),
+                    ("gl", "Galician"),
+                    ("he", "Hebrew"),
+                    ("hi", "Hindi"),
+                    ("hr", "Croatian"),
+                    ("hsb", "Upper Sorbian"),
+                    ("hu", "Hungarian"),
+                    ("hy", "Armenian"),
+                    ("ia", "Interlingua"),
+                    ("id", "Indonesian"),
+                    ("ig", "Igbo"),
+                    ("io", "Ido"),
+                    ("is", "Icelandic"),
+                    ("it", "Italian"),
+                    ("ja", "Japanese"),
+                    ("ka", "Georgian"),
+                    ("kab", "Kabyle"),
+                    ("kk", "Kazakh"),
+                    ("km", "Khmer"),
+                    ("kn", "Kannada"),
+                    ("ko", "Korean"),
+                    ("ky", "Kyrgyz"),
+                    ("lb", "Luxembourgish"),
+                    ("lt", "Lithuanian"),
+                    ("lv", "Latvian"),
+                    ("mk", "Macedonian"),
+                    ("ml", "Malayalam"),
+                    ("mn", "Mongolian"),
+                    ("mr", "Marathi"),
+                    ("ms", "Malay"),
+                    ("my", "Burmese"),
+                    ("nb", "Norwegian Bokmål"),
+                    ("ne", "Nepali"),
+                    ("nl", "Dutch"),
+                    ("nn", "Norwegian Nynorsk"),
+                    ("os", "Ossetic"),
+                    ("pa", "Punjabi"),
+                    ("pl", "Polish"),
+                    ("pt", "Portuguese"),
+                    ("pt-br", "Brazilian Portuguese"),
+                    ("ro", "Romanian"),
+                    ("ru", "Russian"),
+                    ("sk", "Slovak"),
+                    ("sl", "Slovenian"),
+                    ("sq", "Albanian"),
+                    ("sr", "Serbian"),
+                    ("sr-latn", "Serbian Latin"),
+                    ("sv", "Swedish"),
+                    ("sw", "Swahili"),
+                    ("ta", "Tamil"),
+                    ("te", "Telugu"),
+                    ("tg", "Tajik"),
+                    ("th", "Thai"),
+                    ("tk", "Turkmen"),
+                    ("tr", "Turkish"),
+                    ("tt", "Tatar"),
+                    ("udm", "Udmurt"),
+                    ("ug", "Uyghur"),
+                    ("uk", "Ukrainian"),
+                    ("ur", "Urdu"),
+                    ("uz", "Uzbek"),
+                    ("vi", "Vietnamese"),
+                    ("zh-hans", "Simplified Chinese"),
+                    ("zh-hant", "Traditional Chinese"),
+                ],
+                default="en",
+                max_length=7,
+            ),
+        ),
+    ]

ram/bookshelf/migrations/0012_alter_book_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0011_alter_book_language"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="notes",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/bookshelf/migrations/0013_book_description.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 14:31
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0012_alter_book_notes"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="book",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/bookshelf/migrations/0014_book_published.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-04 13:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0013_book_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="book",
+            name="published",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/bookshelf/migrations/0015_alter_book_authors.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-26 22:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0014_book_published"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="authors",
+            field=models.ManyToManyField(blank=True, to="bookshelf.author"),
+        ),
+    ]

ram/bookshelf/migrations/0016_basebook_book_catalogue.py

@@ -0,0 +1,141 @@
+# Generated by Django 5.1.2 on 2024-11-27 16:35
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def basebook_to_book(apps, schema_editor):
+    basebook = apps.get_model("bookshelf", "BaseBook")
+    book = apps.get_model("bookshelf", "Book")
+    for row in basebook.objects.all():
+        b = book.objects.create(
+            basebook_ptr=row,
+            title=row.old_title,
+            publisher=row.old_publisher,
+        )
+        b.authors.set(row.old_authors.all())
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0015_alter_book_authors"),
+        ("metadata", "0019_alter_scale_gauge"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="Book",
+            options={"ordering": ["creation_time"]},
+        ),
+        migrations.RenameModel(
+            old_name="BookImage",
+            new_name="BaseBookImage",
+        ),
+        migrations.RenameModel(
+            old_name="BookProperty",
+            new_name="BaseBookProperty",
+        ),
+        migrations.RenameModel(
+            old_name="Book",
+            new_name="BaseBook",
+        ),
+        migrations.RenameField(
+            model_name="basebook",
+            old_name="title",
+            new_name="old_title",
+        ),
+        migrations.RenameField(
+            model_name="basebook",
+            old_name="authors",
+            new_name="old_authors",
+        ),
+        migrations.RenameField(
+            model_name="basebook",
+            old_name="publisher",
+            new_name="old_publisher",
+        ),
+        migrations.AlterModelOptions(
+            name="basebookimage",
+            options={"ordering": ["order"], "verbose_name_plural": "Images"},
+        ),
+        migrations.CreateModel(
+            name="Book",
+            fields=[
+                (
+                    "basebook_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="bookshelf.basebook",
+                    ),
+                ),
+                ("title", models.CharField(max_length=200)),
+                (
+                    "authors",
+                    models.ManyToManyField(
+                        blank=True,
+                        to="bookshelf.author"
+                    ),
+                ),
+                (
+                    "publisher",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="bookshelf.publisher"
+                    ),
+                 ),
+            ],
+            options={
+                "ordering": ["title"],
+            },
+        ),
+        migrations.RunPython(
+            basebook_to_book,
+            reverse_code=migrations.RunPython.noop
+        ),
+        migrations.RemoveField(
+            model_name="basebook",
+            name="old_title",
+        ),
+        migrations.RemoveField(
+            model_name="basebook",
+            name="old_authors",
+        ),
+        migrations.RemoveField(
+            model_name="basebook",
+            name="old_publisher",
+        ),
+        migrations.CreateModel(
+            name="Catalog",
+            fields=[
+                (
+                    "basebook_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="bookshelf.basebook",
+                    ),
+                ),
+                ("years", models.CharField(max_length=12)),
+                (
+                    "manufacturer",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="metadata.manufacturer",
+                    ),
+                ),
+                ("scales", models.ManyToManyField(to="metadata.scale")),
+            ],
+            options={
+                "ordering": ["manufacturer", "publication_year"],
+            },
+            bases=("bookshelf.basebook",),
+        ),
+    ]

ram/bookshelf/migrations/0017_alter_basebook_options_basebookdocument.py

@@ -0,0 +1,52 @@
+# Generated by Django 5.1.2 on 2024-12-22 20:38
+
+import django.db.models.deletion
+import ram.utils
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0016_basebook_book_catalogue"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="basebook",
+            options={},
+        ),
+        migrations.CreateModel(
+            name="BaseBookDocument",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("description", models.CharField(blank=True, max_length=128)),
+                (
+                    "file",
+                    models.FileField(
+                        storage=ram.utils.DeduplicatedStorage(), upload_to="files/"
+                    ),
+                ),
+                ("private", models.BooleanField(default=False)),
+                (
+                    "book",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="document",
+                        to="bookshelf.basebook",
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("book", "file")},
+            },
+        ),
+    ]

ram/bookshelf/migrations/0018_alter_basebookdocument_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.1.4 on 2024-12-22 20:44
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0017_alter_basebook_options_basebookdocument"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="basebookdocument",
+            options={"verbose_name_plural": "Documents"},
+        ),
+    ]

ram/bookshelf/models.py

@@ -0,0 +1,150 @@
+import os
+import shutil
+from django.db import models
+from django.conf import settings
+from django.urls import reverse
+from django_countries.fields import CountryField
+
+from tinymce import models as tinymce
+
+from metadata.models import Tag
+from ram.utils import DeduplicatedStorage
+from ram.models import BaseModel, Image, Document, PropertyInstance
+from metadata.models import Scale, Manufacturer
+
+
+class Publisher(models.Model):
+    name = models.CharField(max_length=200)
+    country = CountryField(blank=True)
+    website = models.URLField(blank=True)
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+
+class Author(models.Model):
+    first_name = models.CharField(max_length=100)
+    last_name = models.CharField(max_length=100)
+
+    class Meta:
+        ordering = ["last_name", "first_name"]
+
+    def __str__(self):
+        return f"{self.last_name}, {self.first_name}"
+
+    def short_name(self):
+        return f"{self.last_name} {self.first_name[0]}."
+
+
+class BaseBook(BaseModel):
+    ISBN = models.CharField(max_length=17, blank=True)  # 13 + dashes
+    language = models.CharField(
+        max_length=7,
+        choices=settings.LANGUAGES,
+        default='en'
+    )
+    number_of_pages = models.SmallIntegerField(null=True, blank=True)
+    publication_year = models.SmallIntegerField(null=True, blank=True)
+    description = tinymce.HTMLField(blank=True)
+    purchase_date = models.DateField(null=True, blank=True)
+    tags = models.ManyToManyField(
+        Tag, related_name="bookshelf", blank=True
+    )
+
+    def delete(self, *args, **kwargs):
+        shutil.rmtree(
+            os.path.join(
+                settings.MEDIA_ROOT, "images", "books", str(self.uuid)
+            ),
+            ignore_errors=True
+        )
+        super(BaseBook, self).delete(*args, **kwargs)
+
+
+def book_image_upload(instance, filename):
+    return os.path.join(
+        "images",
+        "books",
+        str(instance.book.uuid),
+        filename
+    )
+
+
+class BaseBookImage(Image):
+    book = models.ForeignKey(
+        BaseBook, on_delete=models.CASCADE, related_name="image"
+    )
+    image = models.ImageField(
+        upload_to=book_image_upload,
+        storage=DeduplicatedStorage,
+    )
+
+
+class BaseBookDocument(Document):
+    book = models.ForeignKey(
+        BaseBook, on_delete=models.CASCADE, related_name="document"
+    )
+
+    class Meta:
+        verbose_name_plural = "Documents"
+        unique_together = ("book", "file")
+
+
+class BaseBookProperty(PropertyInstance):
+    book = models.ForeignKey(
+        BaseBook,
+        on_delete=models.CASCADE,
+        null=False,
+        blank=False,
+        related_name="property",
+    )
+
+
+class Book(BaseBook):
+    title = models.CharField(max_length=200)
+    authors = models.ManyToManyField(Author, blank=True)
+    publisher = models.ForeignKey(Publisher, on_delete=models.CASCADE)
+
+    class Meta:
+        ordering = ["title"]
+
+    def __str__(self):
+        return self.title
+
+    def publisher_name(self):
+        return self.publisher.name
+
+    def get_absolute_url(self):
+        return reverse(
+            "bookshelf_item",
+            kwargs={"selector": "book", "uuid": self.uuid}
+        )
+
+
+class Catalog(BaseBook):
+    manufacturer = models.ForeignKey(
+        Manufacturer,
+        on_delete=models.CASCADE,
+    )
+    years = models.CharField(max_length=12)
+    scales = models.ManyToManyField(Scale)
+
+    class Meta:
+        ordering = ["manufacturer", "publication_year"]
+
+    def __str__(self):
+        scales = self.get_scales
+        return "%s %s %s" % (self.manufacturer.name, self.years, scales)
+
+    def get_absolute_url(self):
+        return reverse(
+            "bookshelf_item",
+            kwargs={"selector": "catalog", "uuid": self.uuid}
+        )
+
+    @property
+    def get_scales(self):
+        return "/".join([s.scale for s in self.scales.all()])

ram/bookshelf/serializers.py

@@ -0,0 +1,26 @@
+from rest_framework import serializers
+from bookshelf.models import Book, Author, Publisher
+from metadata.serializers import TagSerializer
+
+
+class AuthorSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Author
+        fields = "__all__"
+
+
+class PublisherSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Publisher
+        fields = "__all__"
+
+
+class BookSerializer(serializers.ModelSerializer):
+    authors = AuthorSerializer(many=True)
+    publisher = PublisherSerializer()
+    tags = TagSerializer(many=True)
+
+    class Meta:
+        model = Book
+        fields = "__all__"
+        read_only_fields = ("creation_time", "updated_time")

ram/bookshelf/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

ram/bookshelf/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+from bookshelf.views import BookList, BookGet
+
+urlpatterns = [
+    path("book/list", BookList.as_view()),
+    path("book/get/<uuid:uuid>", BookGet.as_view()),
+]

ram/bookshelf/views.py

@@ -0,0 +1,21 @@
+from rest_framework.generics import ListAPIView, RetrieveAPIView
+from rest_framework.schemas.openapi import AutoSchema
+
+from bookshelf.models import Book
+from bookshelf.serializers import BookSerializer
+
+
+class BookList(ListAPIView):
+    serializer_class = BookSerializer
+
+    def get_queryset(self):
+        return Book.objects.get_published(self.request.user)
+
+
+class BookGet(RetrieveAPIView):
+    serializer_class = BookSerializer
+    lookup_field = "uuid"
+    schema = AutoSchema(operation_id_base="retrieveBookByUUID")
+
+    def get_queryset(self):
+        return Book.objects.get_published(self.request.user)

ram/consist/admin.py

@@ -8,7 +8,8 @@ class ConsistItemInline(SortableInlineAdminMixin, admin.TabularInline):
     model = ConsistItem
     min_num = 1
     extra = 0
-    readonly_fields = ("address", "type", "company", "era")
+    autocomplete_fields = ("rolling_stock",)
+    readonly_fields = ("preview", "published", "address", "type", "company", "era")
 
 
 @admin.register(Consist)
@@ -18,15 +19,17 @@ class ConsistAdmin(SortableAdminBase, admin.ModelAdmin):
         "creation_time",
         "updated_time",
     )
-    list_display = ("identifier", "company", "era")
+    list_display = ("identifier", "published", "company", "era")
     list_filter = list_display
     search_fields = list_display
+    save_as = True
 
     fieldsets = (
         (
             None,
             {
                 "fields": (
+                    "published",
                     "identifier",
                     "consist_address",
                     "company",

ram/consist/migrations/0005_alter_consist_notes.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.1 on 2022-08-23 15:54
+
+# ckeditor removal
+# import ckeditor_uploader.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0004_alter_consist_company"),
+    ]
+
+    operations = [
+        # migrations.AlterField(
+        #     model_name="consist",
+        #     name="notes",
+        #     field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
+        # ),
+    ]

ram/consist/migrations/0006_md_to_html.py

@@ -0,0 +1,34 @@
+# Generated by Django 4.1 on 2022-08-24 15:30
+
+import markdown
+from django.db import migrations
+
+
+def md_to_html(apps, schema_editor):
+    fields = {
+        "Consist": ["notes"],
+    }
+
+    for m in fields.items():
+        model = apps.get_model("consist", m[0])
+
+        for row in model.objects.all():
+            for field in m[1]:
+                html = markdown.markdown(getattr(row, field))
+                row.__dict__[field] = html
+
+            row.save(update_fields=m[1])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0005_alter_consist_notes"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            md_to_html,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/consist/migrations/0007_alter_consist_image.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.1.2 on 2022-11-27 00:10
+
+from django.db import migrations, models
+import ram.utils
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0006_md_to_html"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/",
+            ),
+        ),
+    ]

ram/consist/migrations/0008_alter_consist_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.1.3 on 2023-01-02 15:03
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0007_alter_consist_image"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="consist",
+            options={"ordering": ["company", "-creation_time"]},
+        ),
+    ]

ram/consist/migrations/0009_alter_consist_image.py

@@ -0,0 +1,51 @@
+# Generated by Django 4.2.6 on 2023-10-31 09:41
+
+import os
+import sys
+import shutil
+import ram.utils
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+def move_images(apps, schema_editor):
+    sys.stdout.write("\n  Processing files. Please await...")
+    model = apps.get_model("consist", "Consist")
+    for r in model.objects.all():
+        if not r.image:  # exit the loop if there's no image
+            continue
+        fname = os.path.basename(r.image.path)
+        new_image = os.path.join("images", "consists", fname)
+        new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+        os.makedirs(os.path.dirname(new_path), exist_ok=True)
+        try:
+            shutil.move(r.image.path, new_path)
+        except FileNotFoundError:
+            sys.stderr.write("  !! FileNotFoundError: {}\n".format(new_image))
+            pass
+        r.image.name = new_image
+        r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("consist", "0008_alter_consist_options"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/consists",
+            ),
+        ),
+        migrations.RunPython(
+            move_images,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/consist/migrations/0010_alter_consist_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0009_alter_consist_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="notes",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/consist/migrations/0011_alter_consist_consist_address_alter_consist_era.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.0.4 on 2024-04-20 12:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0010_alter_consist_notes"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="consist_address",
+            field=models.SmallIntegerField(
+                blank=True,
+                default=None,
+                help_text="DCC consist address if enabled",
+                null=True,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="consist",
+            name="era",
+            field=models.CharField(
+                blank=True, help_text="Era or epoch of the consist", max_length=32
+            ),
+        ),
+    ]

ram/consist/migrations/0012_consist_published.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-04 12:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0011_alter_consist_consist_address_alter_consist_era"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="consist",
+            name="published",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/consist/models.py

@@ -1,24 +1,37 @@
-from uuid import uuid4
+import os
+
 from django.db import models
 from django.urls import reverse
+from django.dispatch import receiver
+from django.core.exceptions import ValidationError
 
+from ram.models import BaseModel
+from ram.utils import DeduplicatedStorage
 from metadata.models import Company, Tag
 from roster.models import RollingStock
 
 
-class Consist(models.Model):
-    uuid = models.UUIDField(primary_key=True, default=uuid4, editable=False)
+class Consist(BaseModel):
     identifier = models.CharField(max_length=128, unique=False)
     tags = models.ManyToManyField(Tag, related_name="consist", blank=True)
     consist_address = models.SmallIntegerField(
-        default=None, null=True, blank=True
+        default=None,
+        null=True,
+        blank=True,
+        help_text="DCC consist address if enabled",
     )
     company = models.ForeignKey(Company, on_delete=models.CASCADE)
-    era = models.CharField(max_length=32, blank=True)
-    image = models.ImageField(upload_to="images/", null=True, blank=True)
-    notes = models.TextField(blank=True)
-    creation_time = models.DateTimeField(auto_now_add=True)
-    updated_time = models.DateTimeField(auto_now=True)
+    era = models.CharField(
+        max_length=32,
+        blank=True,
+        help_text="Era or epoch of the consist",
+    )
+    image = models.ImageField(
+        upload_to=os.path.join("images", "consists"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
+    )
 
     def __str__(self):
         return "{0} {1}".format(self.company, self.identifier)
@@ -26,8 +39,14 @@ class Consist(models.Model):
     def get_absolute_url(self):
         return reverse("consist", kwargs={"uuid": self.uuid})
 
+    def clean(self):
+        if self.consist_item.filter(rolling_stock__published=False).exists():
+            raise ValidationError(
+                "You must publish all items in the consist before publishing the consist."  # noqa: E501
+            )
+
     class Meta:
-        ordering = ["creation_time"]
+        ordering = ["company", "-creation_time"]
 
 
 class ConsistItem(models.Model):
@@ -43,6 +62,13 @@ class ConsistItem(models.Model):
     def __str__(self):
         return "{0}".format(self.rolling_stock)
 
+    def published(self):
+        return self.rolling_stock.published
+    published.boolean = True
+
+    def preview(self):
+        return self.rolling_stock.image.first().image_thumbnail(100)
+
     def type(self):
         return self.rolling_stock.rolling_class.type
 
@@ -54,3 +80,14 @@ class ConsistItem(models.Model):
 
     def era(self):
         return self.rolling_stock.era
+
+
+# Unpublish any consist that contains an unpublished rolling stock
+# this signal is called after a rolling stock is saved
+# it is hosted here to avoid circular imports
+@receiver(models.signals.post_save, sender=RollingStock)
+def post_save_unpublish_consist(sender, instance, *args, **kwargs):
+    consists = Consist.objects.filter(consist_item__rolling_stock=instance)
+    for consist in consists:
+        consist.published = False
+        consist.save()

ram/consist/views.py

@@ -5,11 +5,15 @@ from consist.serializers import ConsistSerializer
 
 
 class ConsistList(ListAPIView):
-    queryset = Consist.objects.all()
     serializer_class = ConsistSerializer
 
+    def get_queryset(self):
+        return Consist.objects.get_published(self.request.user)
+
 
 class ConsistGet(RetrieveAPIView):
-    queryset = Consist.objects.all()
     serializer_class = ConsistSerializer
     lookup_field = "uuid"
+
+    def get_queryset(self):
+        return Consist.objects.get_published(self.request.user)

ram/metadata/admin.py

@@ -4,6 +4,7 @@ from adminsortable2.admin import SortableAdminMixin
 from metadata.models import (
     Property,
     Decoder,
+    DecoderDocument,
     Scale,
     Manufacturer,
     Company,
@@ -14,21 +15,30 @@ from metadata.models import (
 
 @admin.register(Property)
 class PropertyAdmin(admin.ModelAdmin):
+    list_display = ("name", "private")
     search_fields = ("name",)
 
 
+class DecoderDocInline(admin.TabularInline):
+    model = DecoderDocument
+    min_num = 0
+    extra = 0
+    classes = ["collapse"]
+
+
 @admin.register(Decoder)
 class DecoderAdmin(admin.ModelAdmin):
+    inlines = (DecoderDocInline,)
     readonly_fields = ("image_thumbnail",)
-    list_display = ("__str__", "interface")
-    list_filter = ("manufacturer", "interface")
-    search_fields = ("__str__",)
+    list_display = ("__str__", "sound")
+    list_filter = ("manufacturer", "sound")
+    search_fields = ("name", "manufacturer__name")
 
 
 @admin.register(Scale)
 class ScaleAdmin(admin.ModelAdmin):
-    list_display = ("scale", "ratio", "gauge")
-    list_filter = ("ratio", "gauge")
+    list_display = ("scale", "ratio", "gauge", "tracks")
+    list_filter = ("ratio", "gauge", "tracks")
     search_fields = list_display
 
 
@@ -59,4 +69,4 @@ class TagAdmin(admin.ModelAdmin):
 class RollingStockTypeAdmin(SortableAdminMixin, admin.ModelAdmin):
     list_display = ("__str__",)
     list_filter = ("type", "category")
-    search_fields = list_display
+    search_fields = ("type", "category")

ram/metadata/migrations/0005_rename_gauge_scale_track.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.0.6 on 2022-07-18 21:40
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0004_alter_rollingstocktype_options_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='scale',
+            old_name='gauge',
+            new_name='track',
+        ),
+    ]

ram/metadata/migrations/0006_scale_gauge.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.0.6 on 2022-07-18 21:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0005_rename_gauge_scale_track'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='scale',
+            name='gauge',
+            field=models.CharField(blank=True, max_length=16),
+        ),
+    ]

ram/metadata/migrations/0007_rename_track_scale_tracks.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.0.6 on 2022-07-18 21:44
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0006_scale_gauge'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='scale',
+            old_name='track',
+            new_name='tracks',
+        ),
+    ]

ram/metadata/migrations/0008_remove_decoder_interface.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.2 on 2022-10-31 23:01
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0007_rename_track_scale_tracks"),
+        ("roster", "0013_rollingstock_decoder_interface"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="decoder",
+            name="interface",
+        ),
+    ]

ram/metadata/migrations/0009_alter_company_logo_alter_decoder_image_and_more.py

@@ -0,0 +1,44 @@
+# Generated by Django 4.1.2 on 2022-11-27 00:10
+
+from django.db import migrations, models
+import ram.utils
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0008_remove_decoder_interface"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="company",
+            name="logo",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="decoder",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="manufacturer",
+            name="logo",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/",
+            ),
+        ),
+    ]

ram/metadata/migrations/0010_alter_manufacturer_category.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.1.5 on 2023-01-06 00:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0009_alter_company_logo_alter_decoder_image_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="manufacturer",
+            name="category",
+            field=models.CharField(
+                choices=[
+                    ("model", "Model"),
+                    ("real", "Real"),
+                    ("accessory", "Accessory"),
+                    ("other", "Other"),
+                ],
+                max_length=64,
+            ),
+        ),
+    ]

ram/metadata/migrations/0011_company_slug_and_more.py

@@ -0,0 +1,93 @@
+# Generated by Django 4.1.5 on 2023-01-09 11:22
+
+from django.db import migrations, models
+
+
+from ram.utils import slugify
+
+
+def create_slug(apps, schema_editor):
+    fields = ["Company", "Manufacturer", "RollingStockType", "Scale"]
+
+    for m in fields:
+        model = apps.get_model("metadata", m)
+
+        for row in model.objects.all():
+            if hasattr(row, "type"):
+                row.slug = slugify("{} {}".format(row.type, row.category))
+            elif hasattr(row, "scale"):
+                row.slug = slugify(row.scale)
+            else:
+                row.slug = slugify(row.name)
+
+            row.save(update_fields=["slug"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0010_alter_manufacturer_category"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="company",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=64, blank=True
+            ),
+        ),
+        migrations.AddField(
+            model_name="manufacturer",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=128, blank=True
+            ),
+        ),
+        migrations.AddField(
+            model_name="rollingstocktype",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=128, blank=True
+            ),
+        ),
+        migrations.AddField(
+            model_name="scale",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=32, blank=True
+            ),
+        ),
+        migrations.RunPython(
+            create_slug,
+            reverse_code=migrations.RunPython.noop
+        ),
+        migrations.AlterField(
+            model_name="company",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=64, unique=True
+            ),
+        ),
+        migrations.AlterField(
+            model_name="manufacturer",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=128, unique=True
+            ),
+        ),
+        migrations.AlterField(
+            model_name="rollingstocktype",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=128, unique=True
+            ),
+        ),
+        migrations.AlterField(
+            model_name="scale",
+            name="slug",
+            field=models.CharField(
+                editable=False, max_length=32, unique=True
+            ),
+        ),
+    ]

ram/metadata/migrations/0012_alter_decoder_manufacturer_decoderdocument.py

@@ -0,0 +1,59 @@
+# Generated by Django 4.2 on 2023-09-30 21:54
+
+from django.db import migrations, models
+import django.db.models.deletion
+import ram.utils
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0011_company_slug_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="decoder",
+            name="manufacturer",
+            field=models.ForeignKey(
+                limit_choices_to={"category": "accessory"},
+                on_delete=django.db.models.deletion.CASCADE,
+                to="metadata.manufacturer",
+            ),
+        ),
+        migrations.CreateModel(
+            name="DecoderDocument",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("description", models.CharField(blank=True, max_length=128)),
+                (
+                    "file",
+                    models.FileField(
+                        blank=True,
+                        null=True,
+                        storage=ram.utils.DeduplicatedStorage(),
+                        upload_to="files/",
+                    ),
+                ),
+                (
+                    "decoder",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="document",
+                        to="metadata.decoder",
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("decoder", "file")},
+            },
+        ),
+    ]

ram/metadata/migrations/0013_decoderdocument_private.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-10-06 19:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0012_alter_decoder_manufacturer_decoderdocument"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="decoderdocument",
+            name="private",
+            field=models.BooleanField(default=False),
+        ),
+    ]

ram/metadata/migrations/0014_alter_decoder_options_alter_tag_options.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.6 on 2023-10-10 12:44
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("metadata", "0013_decoderdocument_private"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="decoder",
+            options={"ordering": ["manufacturer", "name"]},
+        ),
+        migrations.AlterModelOptions(
+            name="tag",
+            options={"ordering": ["name"]},
+        ),
+    ]

ram/metadata/migrations/0015_alter_company_logo_alter_decoder_image_and_more.py

@@ -0,0 +1,80 @@
+# Generated by Django 4.2.6 on 2023-10-30 13:16
+
+import os
+import sys
+import shutil
+import ram.utils
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+def move_images(apps, schema_editor):
+    fields = {
+        "Company": ["companies", "logo"],
+        "Decoder": ["decoders", "image"],
+        "Manufacturer": ["manufacturers", "logo"],
+    }
+    sys.stdout.write("\n  Processing files. Please await...")
+    for m in fields.items():
+        model = apps.get_model("metadata", m[0])
+        for r in model.objects.all():
+            field = getattr(r, m[1][1])
+            if not field:  # exit the loop if there's no image
+                continue
+            fname = os.path.basename(field.path)
+            new_image = os.path.join("images", m[1][0], fname)
+            new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+            os.makedirs(os.path.dirname(new_path), exist_ok=True)
+            try:
+                shutil.move(field.path, new_path)
+            except FileNotFoundError:
+                sys.stderr.write(
+                    "  !! FileNotFoundError: {}\n".format(new_image)
+                )
+                pass
+            field.name = new_image
+            r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("metadata", "0014_alter_decoder_options_alter_tag_options"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="company",
+            name="logo",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/companies",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="decoder",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/decoders",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="manufacturer",
+            name="logo",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/manufacturers",
+            ),
+        ),
+        migrations.RunPython(
+            move_images,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/metadata/migrations/0016_alter_decoderdocument_file.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.6 on 2023-11-04 22:53
+
+from django.db import migrations, models
+import ram.utils
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("metadata", "0015_alter_company_logo_alter_decoder_image_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="decoderdocument",
+            name="file",
+            field=models.FileField(
+                storage=ram.utils.DeduplicatedStorage(), upload_to="files/"
+            ),
+        ),
+    ]

ram/metadata/migrations/0017_alter_property_private.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.0.4 on 2024-04-20 12:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0016_alter_decoderdocument_file"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="property",
+            name="private",
+            field=models.BooleanField(
+                default=False, help_text="Property will be only visible to logged users"
+            ),
+        ),
+    ]

ram/metadata/migrations/0018_alter_decoder_options_alter_scale_options_and_more.py

@@ -0,0 +1,69 @@
+# Generated by Django 5.1.2 on 2024-11-04 21:17
+
+import django.db.migrations.operations.special
+import metadata.models
+from django.db import migrations, models
+
+
+def gen_ratio(apps, schema_editor):
+    Scale = apps.get_model('metadata', 'Scale')
+    for row in Scale.objects.all():
+        row.ratio_int = metadata.models.calculate_ratio(row.ratio)
+        row.save(update_fields=['ratio_int'])
+
+
+def convert_tarcks(apps, schema_editor):
+    Scale = apps.get_model("metadata", "Scale")
+    for row in Scale.objects.all():
+        row.tracks = "".join(
+            filter(
+                lambda x: str.isdigit(x) or x == "." or x == ",",
+                row.tracks
+            )
+        )
+        row.save(update_fields=["tracks"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0017_alter_property_private'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='decoder',
+            options={'ordering': ['manufacturer__name', 'name']},
+        ),
+        migrations.AlterModelOptions(
+            name='scale',
+            options={'ordering': ['ratio_int', 'scale']},
+        ),
+        migrations.AddField(
+            model_name='scale',
+            name='ratio_int',
+            field=models.SmallIntegerField(default=0, editable=False),
+        ),
+        migrations.RunPython(
+            code=gen_ratio,
+            reverse_code=django.db.migrations.operations.special.RunPython.noop,
+        ),
+        migrations.AlterField(
+            model_name='scale',
+            name='ratio',
+            field=models.CharField(max_length=16, validators=[metadata.models.calculate_ratio]),
+        ),
+        migrations.AlterModelOptions(
+            name='scale',
+            options={'ordering': ['-ratio_int', '-tracks', 'scale']},
+        ),
+        migrations.RunPython(
+            code=convert_tarcks,
+            reverse_code=django.db.migrations.operations.special.RunPython.noop,
+        ),
+        migrations.AlterField(
+            model_name='scale',
+            name='tracks',
+            field=models.FloatField(help_text='Distance between model tracks in mm'),
+        ),
+    ]

ram/metadata/migrations/0019_alter_scale_gauge.py

@@ -0,0 +1,22 @@
+# Generated by Django 5.1.2 on 2024-11-04 21:32
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0018_alter_decoder_options_alter_scale_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="scale",
+            name="gauge",
+            field=models.CharField(
+                blank=True,
+                help_text="Distance between real tracks. Please specify the unit (mm, in, ...)",
+                max_length=16,
+            ),
+        ),
+    ]

ram/metadata/models.py

@@ -1,14 +1,22 @@
+import os
 from django.db import models
+from django.urls import reverse
 from django.conf import settings
 from django.dispatch.dispatcher import receiver
+from django.core.exceptions import ValidationError
 from django_countries.fields import CountryField
 
-from ram.utils import get_image_preview, slugify
+from ram.models import Document
+from ram.utils import DeduplicatedStorage, get_image_preview, slugify
+from ram.managers import PublicManager
 
 
 class Property(models.Model):
     name = models.CharField(max_length=128, unique=True)
-    private = models.BooleanField(default=False)
+    private = models.BooleanField(
+        default=False,
+        help_text="Property will be only visible to logged users",
+    )
 
     class Meta:
         verbose_name_plural = "Properties"
@@ -17,14 +25,22 @@ class Property(models.Model):
     def __str__(self):
         return self.name
 
+    objects = PublicManager()
+
 
 class Manufacturer(models.Model):
     name = models.CharField(max_length=128, unique=True)
+    slug = models.CharField(max_length=128, unique=True, editable=False)
     category = models.CharField(
         max_length=64, choices=settings.MANUFACTURER_TYPES
     )
     website = models.URLField(blank=True)
-    logo = models.ImageField(upload_to="images/", null=True, blank=True)
+    logo = models.ImageField(
+        upload_to=os.path.join("images", "manufacturers"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
+    )
 
     class Meta:
         ordering = ["category", "name"]
@@ -32,6 +48,15 @@ class Manufacturer(models.Model):
     def __str__(self):
         return self.name
 
+    def get_absolute_url(self):
+        return reverse(
+            "filtered",
+            kwargs={
+                "_filter": "manufacturer",
+                "search": self.slug,
+            },
+        )
+
     def logo_thumbnail(self):
         return get_image_preview(self.logo.url)
 
@@ -40,10 +65,16 @@ class Manufacturer(models.Model):
 
 class Company(models.Model):
     name = models.CharField(max_length=64, unique=True)
+    slug = models.CharField(max_length=64, unique=True, editable=False)
     extended_name = models.CharField(max_length=128, blank=True)
     country = CountryField()
     freelance = models.BooleanField(default=False)
-    logo = models.ImageField(upload_to="images/", null=True, blank=True)
+    logo = models.ImageField(
+        upload_to=os.path.join("images", "companies"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
+    )
 
     class Meta:
         verbose_name_plural = "Companies"
@@ -52,6 +83,18 @@ class Company(models.Model):
     def __str__(self):
         return self.name
 
+    def get_absolute_url(self):
+        return reverse(
+            "filtered",
+            kwargs={
+                "_filter": "company",
+                "search": self.slug,
+            },
+        )
+
+    def extended_name_pp(self):
+        return "({})".format(self.extended_name) if self.extended_name else ""
+
     def logo_thumbnail(self):
         return get_image_preview(self.logo.url)
 
@@ -63,14 +106,19 @@ class Decoder(models.Model):
     manufacturer = models.ForeignKey(
         Manufacturer,
         on_delete=models.CASCADE,
-        limit_choices_to={"category": "model"},
+        limit_choices_to={"category": "accessory"},
     )
     version = models.CharField(max_length=64, blank=True)
-    interface = models.PositiveSmallIntegerField(
-        choices=settings.DECODER_INTERFACES, null=True, blank=True
-    )
     sound = models.BooleanField(default=False)
-    image = models.ImageField(upload_to="images/", null=True, blank=True)
+    image = models.ImageField(
+        upload_to=os.path.join("images", "decoders"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
+    )
+
+    class Meta(object):
+        ordering = ["manufacturer__name", "name"]
 
     def __str__(self):
         return "{0} - {1}".format(self.manufacturer, self.name)
@@ -81,29 +129,56 @@ class Decoder(models.Model):
     image_thumbnail.short_description = "Preview"
 
 
-class Scale(models.Model):
-    scale = models.CharField(max_length=32, unique=True)
-    ratio = models.CharField(max_length=16, blank=True)
-    gauge = models.CharField(max_length=16, blank=True)
+class DecoderDocument(Document):
+    decoder = models.ForeignKey(
+        Decoder, on_delete=models.CASCADE, related_name="document"
+    )
 
     class Meta:
-        ordering = ["scale"]
+        unique_together = ("decoder", "file")
+
+
+def calculate_ratio(ratio):
+    try:
+        num, den = ratio.split(":")
+        return int(num) / float(den) * 10000
+    except (ValueError, ZeroDivisionError):
+        raise ValidationError("Invalid ratio format")
+
+
+class Scale(models.Model):
+    scale = models.CharField(max_length=32, unique=True)
+    slug = models.CharField(max_length=32, unique=True, editable=False)
+    ratio = models.CharField(max_length=16, validators=[calculate_ratio])
+    ratio_int = models.SmallIntegerField(editable=False, default=0)
+    tracks = models.FloatField(
+        help_text="Distance between model tracks in mm",
+    )
+    gauge = models.CharField(
+        max_length=16,
+        blank=True,
+        help_text="Distance between real tracks. Please specify the unit (mm, in, ...)",  # noqa: E501
+    )
+
+    class Meta:
+        ordering = ["-ratio_int", "-tracks", "scale"]
+
+    def get_absolute_url(self):
+        return reverse(
+            "filtered",
+            kwargs={
+                "_filter": "scale",
+                "search": self.slug,
+            },
+        )
 
     def __str__(self):
         return str(self.scale)
 
 
-class Tag(models.Model):
-    name = models.CharField(max_length=128, unique=True)
-    slug = models.CharField(max_length=128, unique=True)
-
-    def __str__(self):
-        return self.name
-
-
-@receiver(models.signals.pre_save, sender=Tag)
-def tag_pre_save(sender, instance, **kwargs):
-    instance.slug = slugify(instance.name)
+@receiver(models.signals.pre_save, sender=Scale)
+def scale_save(sender, instance, **kwargs):
+    instance.ratio_int = calculate_ratio(instance.ratio)
 
 
 class RollingStockType(models.Model):
@@ -112,10 +187,49 @@ class RollingStockType(models.Model):
     category = models.CharField(
         max_length=64, choices=settings.ROLLING_STOCK_TYPES
     )
+    slug = models.CharField(max_length=128, unique=True, editable=False)
 
     class Meta(object):
         unique_together = ("category", "type")
         ordering = ["order"]
 
+    def get_absolute_url(self):
+        return reverse(
+            "filtered",
+            kwargs={
+                "_filter": "type",
+                "search": self.slug,
+            },
+        )
+
     def __str__(self):
         return "{0} {1}".format(self.type, self.category)
+
+
+class Tag(models.Model):
+    name = models.CharField(max_length=128, unique=True)
+    slug = models.CharField(max_length=128, unique=True)
+
+    class Meta(object):
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    def get_absolute_url(self):
+        return reverse(
+            "filtered",
+            kwargs={
+                "_filter": "tag",
+                "search": self.slug,
+            },
+        )
+
+
+@receiver(models.signals.pre_save, sender=Manufacturer)
+@receiver(models.signals.pre_save, sender=Company)
+@receiver(models.signals.pre_save, sender=Scale)
+@receiver(models.signals.pre_save, sender=RollingStockType)
+@receiver(models.signals.pre_save, sender=Tag)
+def slug_pre_save(sender, instance, **kwargs):
+    instance.slug = slugify(instance.__str__())

ram/portal/admin.py

@@ -1,6 +1,68 @@
 from django.contrib import admin
 from solo.admin import SingletonModelAdmin
 
-from portal.models import SiteConfiguration
+from portal.models import SiteConfiguration, Flatpage
 
-admin.site.register(SiteConfiguration, SingletonModelAdmin)
+
+@admin.register(SiteConfiguration)
+class SiteConfigurationAdmin(SingletonModelAdmin):
+    readonly_fields = ("site_name",)
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "site_name",
+                    "site_author",
+                    "about",
+                    "items_per_page",
+                    "items_ordering",
+                    "footer",
+                    "footer_extended",
+                )
+            },
+        ),
+        (
+            "Advanced",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "show_version",
+                    "use_cdn",
+                    "extra_head",
+                ),
+            },
+        ),
+    )
+
+
+@admin.register(Flatpage)
+class FlatpageAdmin(admin.ModelAdmin):
+    readonly_fields = ("path", "creation_time", "updated_time")
+    list_display = ("name", "path", "published", "get_link")
+    list_filter = ("published",)
+    search_fields = ("name",)
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "name",
+                    "path",
+                    "content",
+                    "published",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )

ram/portal/context_processors.py

@@ -0,0 +1,5 @@
+from django.conf import settings
+
+
+def default_card_image(request):
+    return {"DEFAULT_CARD_IMAGE": settings.DEFAULT_CARD_IMAGE}

ram/portal/migrations/0008_flatpage.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.0.6 on 2022-08-07 15:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('portal', '0007_siteconfiguration_items_ordering'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Flatpage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=256, unique=True)),
+                ('draft', models.BooleanField(default=True)),
+                ('content', models.TextField(blank=True)),
+            ],
+        ),
+    ]

ram/portal/migrations/0009_flatpage_path.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.0.6 on 2022-08-07 15:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('portal', '0008_flatpage'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='flatpage',
+            name='path',
+            field=models.CharField(default='', max_length=256, unique=True),
+            preserve_default=False,
+        ),
+    ]

ram/portal/migrations/0010_flatpage_creation_time_flatpage_updated_time.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.0.6 on 2022-08-07 15:46
+
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('portal', '0009_flatpage_path'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='flatpage',
+            name='creation_time',
+            field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='flatpage',
+            name='updated_time',
+            field=models.DateTimeField(auto_now=True),
+        ),
+    ]

ram/portal/migrations/0011_alter_flatpage_content_alter_siteconfiguration_about_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.1 on 2022-08-23 15:54
+
+# ckeditor dependency removal
+# import ckeditor.fields
+# import ckeditor_uploader.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0010_flatpage_creation_time_flatpage_updated_time"),
+    ]
+
+    operations = [
+#         migrations.AlterField(
+#             model_name="flatpage",
+#             name="content",
+#             field=ckeditor_uploader.fields.RichTextUploadingField(),
+#         ),
+#         migrations.AlterField(
+#             model_name="siteconfiguration",
+#             name="about",
+#             field=ckeditor.fields.RichTextField(blank=True),
+#         ),
+#         migrations.AlterField(
+#             model_name="siteconfiguration",
+#             name="footer",
+#             field=ckeditor.fields.RichTextField(blank=True),
+#         ),
+#         migrations.AlterField(
+#             model_name="siteconfiguration",
+#             name="footer_extended",
+#             field=ckeditor.fields.RichTextField(blank=True),
+#         ),
+    ]

ram/portal/migrations/0012_md_to_html.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.1 on 2022-08-24 15:00
+
+import markdown
+from django.db import migrations
+
+
+def md_to_html(apps, schema_editor):
+    fields = {
+        "SiteConfiguration": ["about", "footer", "footer_extended"],
+        "Flatpage": ["content"]
+    }
+
+    for m in fields.items():
+        model = apps.get_model("portal", m[0])
+
+        for row in model.objects.all():
+            for field in m[1]:
+                html = markdown.markdown(getattr(row, field))
+                row.__dict__[field] = html
+
+            row.save(update_fields=m[1])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "portal",
+            "0011_alter_flatpage_content_alter_siteconfiguration_about_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            md_to_html,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/portal/migrations/0013_remove_flatpage_draft_flatpage_published.py

@@ -0,0 +1,42 @@
+# Generated by Django 4.1 on 2022-08-25 10:18
+
+from django.db import migrations, models
+
+
+def reverse_bool(apps, schema_editor):
+    model = apps.get_model("portal", "Flatpage")
+
+    for row in model.objects.all():
+        row.published = not row.draft
+        row.save(update_fields=["published"])
+
+
+def reverse_bool_back(apps, schema_editor):
+    model = apps.get_model("portal", "Flatpage")
+
+    for row in model.objects.all():
+        row.draft = not row.published
+        row.save(update_fields=["draft"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0012_md_to_html"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="flatpage",
+            name="published",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.RunPython(
+            reverse_bool,
+            reverse_code=reverse_bool_back
+        ),
+        migrations.RemoveField(
+            model_name="flatpage",
+            name="draft",
+        ),
+    ]

ram/portal/migrations/0014_siteconfiguration_extra_head.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.3 on 2022-12-28 22:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0013_remove_flatpage_draft_flatpage_published"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="siteconfiguration",
+            name="extra_head",
+            field=models.TextField(blank=True),
+        ),
+    ]

ram/portal/migrations/0015_siteconfiguration_use_cdn.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.5 on 2023-01-03 15:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0014_siteconfiguration_extra_head"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="siteconfiguration",
+            name="use_cdn",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/portal/migrations/0016_remove_siteconfiguration_site_name.py

@@ -0,0 +1,16 @@
+# Generated by Django 5.0.1 on 2024-01-20 21:02
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("portal", "0015_siteconfiguration_use_cdn"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="siteconfiguration",
+            name="site_name",
+        ),
+    ]

ram/portal/migrations/0017_alter_flatpage_content_alter_siteconfiguration_about_and_more.py

@@ -0,0 +1,34 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0016_remove_siteconfiguration_site_name"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="flatpage",
+            name="content",
+            field=tinymce.models.HTMLField(),
+        ),
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="about",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="footer",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="footer_extended",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/portal/models.py

@@ -1,16 +1,21 @@
 import django
 from django.db import models
+from django.conf import settings
+from django.urls import reverse
+from django.dispatch.dispatcher import receiver
+from django.utils.safestring import mark_safe
+from solo.models import SingletonModel
+
+from tinymce import models as tinymce
 
 from ram import __version__ as app_version
-from solo.models import SingletonModel
+from ram.managers import PublicManager
+from ram.utils import slugify
 
 
 class SiteConfiguration(SingletonModel):
-    site_name = models.CharField(
-        max_length=256, default="Railroad Assets Manager"
-    )
     site_author = models.CharField(max_length=256, blank=True)
-    about = models.TextField(blank=True)
+    about = tinymce.HTMLField(blank=True)
     items_per_page = models.CharField(
         max_length=2,
         choices=[(str(x * 3), str(x * 3)) for x in range(2, 11)],
@@ -25,9 +30,11 @@ class SiteConfiguration(SingletonModel):
         ],
         default="type",
     )
-    footer = models.TextField(blank=True)
-    footer_extended = models.TextField(blank=True)
+    footer = tinymce.HTMLField(blank=True)
+    footer_extended = tinymce.HTMLField(blank=True)
     show_version = models.BooleanField(default=True)
+    use_cdn = models.BooleanField(default=True)
+    extra_head = models.TextField(blank=True)
 
     class Meta:
         verbose_name = "Site Configuration"
@@ -35,8 +42,40 @@ class SiteConfiguration(SingletonModel):
     def __str__(self):
         return "Site Configuration"
 
+    def site_name(self):
+        return settings.SITE_NAME
+
     def version(self):
         return app_version
 
     def django_version(self):
         return django.get_version()
+
+
+class Flatpage(models.Model):
+    name = models.CharField(max_length=256, unique=True)
+    path = models.CharField(max_length=256, unique=True)
+    published = models.BooleanField(default=False)
+    content = tinymce.HTMLField()
+    creation_time = models.DateTimeField(auto_now_add=True)
+    updated_time = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.name
+
+    def get_absolute_url(self):
+        return reverse("flatpage", kwargs={"flatpage": self.path})
+
+    def get_link(self):
+        return mark_safe(
+            '<a href="{0}" target="_blank">Link</a>'.format(
+                self.get_absolute_url()
+            )
+        )
+
+    objects = PublicManager()
+
+
+@receiver(models.signals.pre_save, sender=Flatpage)
+def tag_pre_save(sender, instance, **kwargs):
+    instance.path = slugify(instance.name)

ram/portal/static/coming_soon.svg

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="420"
+   height="226"
+   viewBox="0 0 5.8333333 3.1388889"
+   version="1.1"
+   id="svg1"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <defs
+     id="defs1">
+    <linearGradient
+       id="linearGradient1">
+      <stop
+         style="stop-color:#ffffff;stop-opacity:1;"
+         offset="0.59606808"
+         id="stop2" />
+      <stop
+         style="stop-color:#f5f5f5;stop-opacity:1;"
+         offset="1"
+         id="stop1" />
+    </linearGradient>
+    <linearGradient
+       xlink:href="#linearGradient1"
+       id="linearGradient2"
+       x1="0"
+       y1="1.5694444"
+       x2="5.8333335"
+       y2="1.5694444"
+       gradientUnits="userSpaceOnUse"
+       gradientTransform="matrix(0.53809522,0,0,1.8584071,-3.1388889,0)"
+       spreadMethod="pad" />
+  </defs>
+  <g
+     id="layer1">
+    <rect
+       style="mix-blend-mode:normal;fill:url(#linearGradient2);stroke:none;stroke-width:0.801535"
+       id="rect1"
+       width="3.1388888"
+       height="5.8333335"
+       x="-3.1388888"
+       y="-2.220446e-16"
+       transform="rotate(-90)" />
+    <text
+       xml:space="preserve"
+       style="font-weight:bold;font-size:0.444444px;line-height:1.25;font-family:system-ui,-apple-system,'Segoe UI',Roboto,'Helvetica Neue','Noto Sans','Liberation Sans',Arial,sans-serif;-inkscape-font-specification:'Noto Sans Bold';letter-spacing:0px;word-spacing:0px;stroke-width:0.0138889"
+       x="1.5366687"
+       y="1.6798887"
+       id="text1"><tspan
+         id="tspan1"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:0.444444px;font-family:system-ui,-apple-system,'Segoe UI',Roboto,'Helvetica Neue','Noto Sans','Liberation Sans',Arial,sans-serif;-inkscape-font-specification:'Noto Sans';fill:#dee2e6;fill-opacity:1;stroke-width:0.0138889"
+         x="1.5366687"
+         y="1.6798887">Coming soon</tspan></text>
+  </g>
+</svg>

ram/portal/static/css/main.css

@@ -1,7 +1,22 @@
+/* Switch SVG logo to white on dark mode */
+html[data-bs-theme='dark'] .navbar svg {
+  fill: #fff;
+}
+
 .card > a > img {
   width: 100%;
 }
 
+td > img.logo {
+  max-width: 200px;
+  max-height: 48px;
+}
+
+td > img.logo-xl {
+  max-width: 400px;
+  max-height: 96px;
+}
+
 .btn > span {
   display: inline-block;
 }
@@ -11,18 +26,31 @@ a.badge, a.badge:hover {
   color: #fff;
 }
 
-.tab-pane {
-  min-height: 300px;
-}
-
 .img-thumbnail {
   padding: 0;
 }
 
+.w-33 {
+  width: 33% !important;
+}
+
+.table-group-divider {
+  border-top: calc(var(--bs-border-width) * 3) solid var(--bs-border-color);
+}
+
 #nav-notes > p {
   padding: .5rem;
 }
 
+#nav-journal ul, #nav-journal ol {
+  margin: 0;
+  padding-left: 1rem;
+}
+
+#nav-journal p {
+  margin: 0;
+}
+
 #footer > p {
   display: inline;
 }

ram/portal/static/favicon.svg

@@ -0,0 +1,9 @@
+            <svg width="26" height="16" enable-background="new 0 0 26 26" version="1" viewBox="0 0 26 16" xmlns="http://www.w3.org/2000/svg">
+              <path d="m2.8125 0.0010991a1.0001 1.0001 0 0 0-0.8125 1c0 0.55455-0.44545 1-1 1a1.0001 1.0001 0 0 0-1 1v10a1.0001 1.0001 0 0 0 1 1c0.55455 0 1 0.44546 1 1a1.0001 1.0001 0 0 0 1 1h20a1.0001 1.0001 0 0 0 1-1c0-0.55454 0.44546-1 1-1a1.0001 1.0001 0 0 0 1-1v-10a1.0001 1.0001 0 0 0-1-1c-0.55454 0-1-0.44545-1-1a1.0001 1.0001 0 0 0-1-1h-20a1.0001 1.0001 0 0 0-0.09375 0 1.0001 1.0001 0 0 0-0.09375 0zm0.78125 2h14.406v1h2v-1h2.4062c0.30628 0.76906 0.82469 1.2875 1.5938 1.5938v8.8125c-0.76906 0.30628-1.2875 0.82469-1.5938 1.5938h-2.4062v-1h-2v1h-14.406c-0.30628-0.76906-0.82469-1.2875-1.5938-1.5938v-8.8125c0.76906-0.30628 1.2875-0.82469 1.5938-1.5938zm14.406 2v2h2v-2zm0 3v2h2v-2zm0 3v2h2v-2z" enable-background="accumulate" overflow="visible" stroke-width="2" />
+              <style>
+                path {
+                  text-indent:0;
+                  text-transform:none;
+                }
+              </style>
+            </svg>

ram/portal/templates/base.html

@@ -1,19 +1,28 @@
 {% load static %}
 {% load solo_tags %}
-{% load markdown %}
+{% load show_menu %}
 {% get_solo 'portal.SiteConfiguration' as site_conf %}
 
 <!doctype html>
-<html lang="en">
+<html lang="en" data-bs-theme="auto">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="color-scheme" content="light dark">
     <meta name="description" content="{{ site_conf.about}}">
     <meta name="author" content="{{ site_conf.site_author }}">
     <meta name="generator" content="Django Framework">
-    <title>{{ site_conf.site_name }}</title>
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet">
-    <link href="{% static "css/main.css" %}" rel="stylesheet">
+    <title>{% block title %}{{ title }}{% endblock %} - {{ site_conf.site_name }}</title>
+    <link rel="icon" href="{% static "favicon.png" %}" sizes="any">
+    <link rel="icon" href="{% static "favicon.svg" %}" type="image/svg+xml">
+    {% if site_conf.use_cdn %}
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.css" rel="stylesheet">
+    {% else %}
+    <link href="{% static "bootstrap@5.3.3/dist/css/bootstrap.min.css" %}" rel="stylesheet">
+    <link href="{% static "bootstrap-icons@1.11.3/font/bootstrap-icons.css" %}" rel="stylesheet">
+    {% endif %}
+    <link href="{% static "css/main.css" %}?v={{ site_conf.version }}" rel="stylesheet">
     <style>
       .bd-placeholder-img {
         font-size: 1.125rem;
@@ -22,41 +31,162 @@
         -moz-user-select: none;
         user-select: none;
       }
-
       @media (min-width: 768px) {
         .bd-placeholder-img-lg {
           font-size: 3.5rem;
         }
       }
     </style>
+    <script>
+      /*!
+      * Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
+      * Copyright 2011-2023 The Bootstrap Authors
+      * Licensed under the Creative Commons Attribution 3.0 Unported License.
+      */
+
+      (() => {
+        'use strict'
+
+        const getStoredTheme = () => localStorage.getItem('theme')
+        const setStoredTheme = theme => localStorage.setItem('theme', theme)
+
+        const getPreferredTheme = () => {
+          const storedTheme = getStoredTheme()
+          if (storedTheme) {
+            return storedTheme
+          }
+
+          return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
+        }
+
+        const setTheme = theme => {
+          if (theme === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches) {
+            document.documentElement.setAttribute('data-bs-theme', 'dark')
+          } else {
+            document.documentElement.setAttribute('data-bs-theme', theme)
+          }
+        }
+
+        setTheme(getPreferredTheme())
+
+        const showActiveTheme = (theme, focus = false) => {
+          const themeSwitcher = document.querySelector('#bd-theme')
+
+          if (!themeSwitcher) {
+            return
+          }
+
+          const activeThemeIcon = document.querySelector('.theme-icon-active i')
+          const btnToActive = document.querySelector(`[data-bs-theme-value="${theme}"]`)
+          const biOfActiveBtn = btnToActive.querySelector('.theme-icon i').getAttribute('class')
+
+          document.querySelectorAll('[data-bs-theme-value]').forEach(element => {
+            element.classList.remove('active')
+            element.setAttribute('aria-pressed', 'false')
+          })
+
+          btnToActive.classList.add('active')
+          btnToActive.setAttribute('aria-pressed', 'true')
+          activeThemeIcon.setAttribute('class', biOfActiveBtn)
+
+          if (focus) {
+            themeSwitcher.focus()
+          }
+        }
+
+        window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
+          const storedTheme = getStoredTheme()
+          if (storedTheme !== 'light' && storedTheme !== 'dark') {
+            setTheme(getPreferredTheme())
+          }
+        })
+
+        window.addEventListener('DOMContentLoaded', () => {
+          showActiveTheme(getPreferredTheme())
+          document.querySelectorAll('[data-bs-theme-value]')
+            .forEach(toggle => {
+              toggle.addEventListener('click', () => {
+                const theme = toggle.getAttribute('data-bs-theme-value')
+                setStoredTheme(theme)
+                setTheme(theme)
+                showActiveTheme(theme, true)
+              })
+            })
+          })
+       })()
+    </script>
+    <script>
+      document.addEventListener('DOMContentLoaded', function () {
+      var selectElement = document.getElementById('tabSelector');
+      selectElement.addEventListener('change', function () {
+        var selectedTabId = this.value;
+        var tabs = document.querySelectorAll('.tab-pane');
+        tabs.forEach(function (tab) {
+        tab.classList.remove('show', 'active');
+        });
+        document.getElementById(selectedTabId).classList.add('show', 'active');
+      });
+      });
+    </script>
+    {% block extra_head %}
+    {{ site_conf.extra_head | safe }}
+    {% endblock %}
   </head>
   <body>
     <header>
-      <div class="navbar navbar-light bg-light shadow-sm">
-        <div class="container">
+      <nav class="navbar navbar-expand-sm bg-body-tertiary shadow-sm">
+        <div class="container d-flex">
+          <div class="me-auto">
             <a href="{% url 'index' %}" class="navbar-brand d-flex align-items-center">
-            <svg class="me-2" width="26" height="16" enable-background="new 0 0 26 26" version="1" viewBox="0 0 26 16" xmlns="http://www.w3.org/2000/svg">
-              <path d="m2.8125 0.0010991a1.0001 1.0001 0 0 0-0.8125 1c0 0.55455-0.44545 1-1 1a1.0001 1.0001 0 0 0-1 1v10a1.0001 1.0001 0 0 0 1 1c0.55455 0 1 0.44546 1 1a1.0001 1.0001 0 0 0 1 1h20a1.0001 1.0001 0 0 0 1-1c0-0.55454 0.44546-1 1-1a1.0001 1.0001 0 0 0 1-1v-10a1.0001 1.0001 0 0 0-1-1c-0.55454 0-1-0.44545-1-1a1.0001 1.0001 0 0 0-1-1h-20a1.0001 1.0001 0 0 0-0.09375 0 1.0001 1.0001 0 0 0-0.09375 0zm0.78125 2h14.406v1h2v-1h2.4062c0.30628 0.76906 0.82469 1.2875 1.5938 1.5938v8.8125c-0.76906 0.30628-1.2875 0.82469-1.5938 1.5938h-2.4062v-1h-2v1h-14.406c-0.30628-0.76906-0.82469-1.2875-1.5938-1.5938v-8.8125c0.76906-0.30628 1.2875-0.82469 1.5938-1.5938zm14.406 2v2h2v-2zm0 3v2h2v-2zm0 3v2h2v-2z" enable-background="accumulate" fill="#000" overflow="visible" stroke-width="2" style="text-indent:0;text-transform:none"/>
+              <svg class="me-2" width="26" height="16" viewBox="0 0 26 16" xmlns="http://www.w3.org/2000/svg">
+                <path d="m2.8125 0.0010991a1.0001 1.0001 0 0 0-0.8125 1c0 0.55455-0.44545 1-1 1a1.0001 1.0001 0 0 0-1 1v10a1.0001 1.0001 0 0 0 1 1c0.55455 0 1 0.44546 1 1a1.0001 1.0001 0 0 0 1 1h20a1.0001 1.0001 0 0 0 1-1c0-0.55454 0.44546-1 1-1a1.0001 1.0001 0 0 0 1-1v-10a1.0001 1.0001 0 0 0-1-1c-0.55454 0-1-0.44545-1-1a1.0001 1.0001 0 0 0-1-1h-20a1.0001 1.0001 0 0 0-0.09375 0 1.0001 1.0001 0 0 0-0.09375 0zm0.78125 2h14.406v1h2v-1h2.4062c0.30628 0.76906 0.82469 1.2875 1.5938 1.5938v8.8125c-0.76906 0.30628-1.2875 0.82469-1.5938 1.5938h-2.4062v-1h-2v1h-14.406c-0.30628-0.76906-0.82469-1.2875-1.5938-1.5938v-8.8125c0.76906-0.30628 1.2875-0.82469 1.5938-1.5938zm14.406 2v2h2v-2zm0 3v2h2v-2zm0 3v2h2v-2z" stroke-width="2" />
+                <style>
+                  path {
+                    text-indent:0;
+                    text-transform:none;
+                  }
+                </style>
               </svg>
               <strong>{{ site_conf.site_name }}</strong>
             </a>
+         </div>
          {% include 'includes/login.html' %}
         </div>
-      </div>
+      </nav>
     </header>
     <main>
       <div class="container py-2">
-        <nav class="navbar navbar-expand-lg navbar-light">
+        <nav class="navbar navbar-expand-lg">
           <div class="container-fluid g-0">
             <a class="navbar-brand" href="{% url 'index' %}">Home</a>
-            <div class="navbar-collapse" id="navbarSupportedContent">
+            <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+            </button>
+            <div class="collapse navbar-collapse" id="navbarSupportedContent">
               <ul class="navbar-nav me-auto mb-2 mb-lg-0">
                 <li class="nav-item">
-                  <a class="nav-link" href="{% url 'index' %}">Roster</a>
+                  <a class="nav-link" href="{% url 'roster' %}">Roster</a>
                 </li>
                 <li class="nav-item">
                   <a class="nav-link" href="{% url 'consists' %}">Consists</a>
                 </li>
+                <li class="nav-item dropdown">
+                  <a class="nav-link dropdown-toggle" href="#" id="filterDropdownMenu" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                    Search by
+                  </a>
+                  <ul class="dropdown-menu" aria-labelledby="filterDropdownMenu">
+                    <li class="ps-2 text-secondary">Model</li>
+                    <li><a class="dropdown-item" href="{% url 'scales' %}">Scale</a></li>
+                    <li><a class="dropdown-item" href="{% url 'manufacturers' category='model' %}">Manufacturer</a></li>
+                    <li><hr class="dropdown-divider"></li>
+                    <li class="ps-2 text-secondary">Prototype</li>
+                    <li><a class="dropdown-item" href="{% url 'rolling_stock_types' %}">Type</a></li>
+                    <li><a class="dropdown-item" href="{% url 'companies' %}">Company</a></li>
+                    <li><a class="dropdown-item" href="{% url 'manufacturers' category='real' %}">Manufacturer</a></li>
+                  </ul>
+                </li>
+                {% show_bookshelf_menu %}
+                {% show_flatpages_menu user %}
               </ul>
               {% include 'includes/search.html' %}
             </div>
@@ -66,110 +196,29 @@
       <section class="py-4 text-center container">
         <div class="row">
           <div class="mx-auto">
-            {% block header %}{% endblock %}
+            <h1 class="fw-light">{{ title }}</h1>
+            {% block header %}
+            {% endblock %}
           </div>
         </div>
       </section>
-      <div class="album py-5 bg-light">
+      <div class="album py-4 bg-body-tertiary">
         <div class="container">
-          <a id="rolling-stock"></a>
-          <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
-            {% block cards %}
-            {% for r in rolling_stock %}
-            <div class="col">
-              <div class="card shadow-sm">
-                {% for i in r.image.all %}
-                {% if i.is_thumbnail %}<a href="{{r.get_absolute_url}}"><img src="{{ i.image.url }}" alt="Card image cap"></a>{% endif %}
-                {% endfor %}
-                <div class="card-body">
-                  <p class="card-text"><strong>{{ r }}</strong></p>
-                  {% if r.tags.all %}
-                  <p class="card-text"><small>Tags:</small>
-                    {% for t in r.tags.all %}<a href="{% url 'filtered' _filter="tag" search=t.slug %}" class="badge rounded-pill bg-primary">
-                    {{ t.name }}</a>{# new line is required #}
-                    {% endfor %}
-                  </p>
-                  {% endif %}
-                  <table class="table table-striped">
-                    <thead>
-                      <tr>
-                        <th colspan="2" scope="row">Data</th>
-                      </tr>
-                    </thead>
-                    <tbody>
-                      <tr>
-                        <th width="35%" scope="row">Type</th>
-                        <td>{{ r.rolling_class.type }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Company</th>
-                        <td><abbr title="{{ r.rolling_class.company.extended_name }}">{{ r.rolling_class.company }}</abbr></td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Class</th>
-                        <td>{{ r.rolling_class.identifier }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Road number</th>
-                        <td>{{ r.road_number }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Era</th>
-                        <td>{{ r.era }}</td>
-                      </tr>
-                      <tr>
-                        <th width="35%" scope="row">Manufacturer</th>
-                        <td>{% if r.manufacturer.website %}<a href="{{ r.manufacturer.website }}">{% endif %}{{ r.manufacturer }}{% if r.manufacturer.website %}</a>{% endif %}</th>
-                      </tr>
-                      <tr>
-                        <th scope="row">Scale</th>
-                        <td><abbr title="{{ r.scale.ratio }} - {{ r.scale.gauge }}">{{ r.scale }}</abbr></td>
-                      </tr>
-                      <tr>
-                        <th scope="row">SKU</th>
-                        <td>{{ r.sku }}</td>
-                      </tr>
-                    </tbody>
-                  </table>
-                  {% if r.decoder %}
-                  <table class="table table-striped">
-                    <thead>
-                      <tr>
-                        <th colspan="2" scope="row">DCC data</th>
-                      </tr>
-                    </thead>
-                    <tbody>
-                      <tr>
-                        <th width="35%" scope="row">Decoder</th>
-                        <td>{{ r.decoder }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Address</th>
-                        <td>{{ r.address }}</td>
-                      </tr>
-                    </tbody>
-                  </table>
-                  {% endif %}
-                  <div class="btn-group mb-4">
-                   <a class="btn btn-sm btn-outline-primary" href="{{r.get_absolute_url}}">Show all data</a>
-                    {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:roster_rollingstock_change' r.pk %}">Edit</a>{% endif %}
-                  </div>
-                  <div class="d-flex justify-content-between align-items-center">
-                    <small class="text-muted">Updated {{ r.updated_time | date:"M d, Y H:m" }}</small>
-                  </div>
-                </div>
-              </div>
-            </div>
-            {% endfor %}
+          {% block carousel %}
+          {% endblock %}
+          <a id="main-content"></a>
+          {% block cards_layout %}
           {% endblock %}
-          </div>
         </div>
         <div class="container">{% block pagination %}{% endblock %}</div>
       </div>
       {% block extra_content %}{% endblock %}
     </main>
     {% include 'includes/footer.html' %}
-    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
-    <script src="https://cdn.jsdelivr.net/npm/masonry-layout@4.2.2/dist/masonry.pkgd.min.js" integrity="sha384-GNFwBvfVxBkLMJpYMOABq3c+d3KnQxudP/mGPkzpZSTYykLBNsZEnG2D9G/X/+7D" crossorigin="anonymous" async></script>
+    {% if site_conf.use_cdn %}
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"></script>
+    {% else %}
+    <script src="{% static "bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js" %}"></script>
+    {% endif %}
   </body>
 </html>

ram/portal/templates/bookshelf/book.html

@@ -0,0 +1,164 @@
+{% extends 'base.html' %}
+{% load dynamic_url %}
+
+        {% block header %}
+        {% if book.tags.all %}
+        <p><small>Tags:</small>
+          {% for t in book.tags.all %}<a href="{% url 'filtered' _filter="tag" search=t.slug %}" class="badge rounded-pill bg-primary">
+          {{ t.name }}</a>{# new line is required #}
+          {% endfor %}
+        </p>
+        {% endif %}
+        <small class="text-muted">Updated {{ book.updated_time | date:"M d, Y H:i" }}</small>
+        {% endblock %}
+        {% block carousel %}
+        <div class="row">
+          <div id="carouselControls" class="carousel carousel-dark slide" data-bs-ride="carousel" data-bs-interval="10000">
+            <div class="carousel-inner">
+              {% for t in book.image.all %}
+              {% if forloop.first %}
+              <div class="carousel-item active">
+              {% else %}
+              <div class="carousel-item">
+              {% endif %}
+                <img src="{{ t.image.url }}" class="d-block w-100 rounded img-thumbnail" alt="...">
+              </div>
+              {% endfor %}
+            </div>
+            {% if book.image.count > 1 %}
+            <button class="carousel-control-prev" type="button" data-bs-target="#carouselControls" data-bs-slide="prev">
+              <span class="carousel-control-prev-icon" aria-hidden="true"></span>
+              <span class="visually-hidden"><i class="bi bi-chevron-left"></i></span>
+            </button>
+            <button class="carousel-control-next" type="button" data-bs-target="#carouselControls" data-bs-slide="next">
+              <span class="carousel-control-next-icon" aria-hidden="true"></span>
+              <span class="visually-hidden"><i class="bi bi-chevron-right"></i></span>
+            </button>
+            {% endif %}
+          </div>
+        </div>
+        {% endblock %}
+        {% block cards %}
+        {% endblock %}
+        {% block extra_content %}
+        <section class="py-4 text-start container">
+          <div class="row">
+            <div class="mx-auto">
+              <nav class="nav nav-tabs d-none d-lg-flex flex-row mb-2" id="nav-tab" role="tablist">
+                <button class="nav-link active" id="nav-summary-tab" data-bs-toggle="tab" data-bs-target="#nav-summary" type="button" role="tab" aria-controls="nav-summary" aria-selected="true">Summary</button>
+                {% if documents %}<button class="nav-link" id="nav-documents-tab" data-bs-toggle="tab" data-bs-target="#nav-documents" type="button" role="tab" aria-controls="nav-documents" aria-selected="false">Documents</button>{% endif %}
+                {% if book.notes %}<button class="nav-link" id="nav-notes-tab" data-bs-toggle="tab" data-bs-target="#nav-notes" type="button" role="tab" aria-controls="nav-notes" aria-selected="false">Notes</button>{% endif %}
+              </nav>
+              <select class="form-select d-lg-none mb-2" id="tabSelector" aria-label="Tab selector">
+                <option value="nav-summary" selected>Summary</option>
+                {% if documents %}<option value="nav-documents">Documents</option>{% endif %}
+                {% if book.notes %}<option value="nav-notes">Notes</option>{% endif %}
+              </select>
+              <div class="tab-content" id="nav-tabContent">
+                <div class="tab-pane show active" id="nav-summary" role="tabpanel" aria-labelledby="nav-summary-tab">
+                  <table class="table table-striped">
+                    {{ book.description | safe }}
+                    <thead>
+                      <tr>
+                      {% if type == "catalog" %}
+                        <th colspan="2" scope="row">Catalog</th>
+                      {% elif type == "book" %}
+                        <th colspan="2" scope="row">Book</th>
+                      {% endif %}
+                      </tr>
+                    </thead>
+                    <tbody class="table-group-divider">
+                      {% if type == "catalog" %}
+                      <tr>
+                        <th class="w-33" scope="row">Manufacturer</th>
+                        <td>{{ book.manufacturer }}</td>
+                      </tr>
+                      <tr>
+                        <th class="w-33" scope="row">Scales</th>
+                        <td>{{ book.get_scales }}</td>
+                      </tr>
+                      {% elif type == "book" %}
+                      <tr>
+                        <th class="w-33" scope="row">Title</th>
+                        <td>{{ book.title }}</td>
+                      </tr>
+                      <tr>
+                        <th class="w-33" scope="row">Authors</th>
+                        <td>
+                          <ul class="mb-0 list-unstyled">{% for a in book.authors.all %}<li>{{ a }}</li>{% endfor %}</ul>
+                        </td>
+                      </tr>
+                      <tr>
+                        <th class="w-33" scope="row">Publisher</th>
+                        <td>{{ book.publisher }}</td>
+                      </tr>
+                      {% endif %}
+                      <tr>
+                        <th scope="row">ISBN</th>
+                        <td>{{ book.ISBN|default:"-" }}</td>
+                      </tr>
+                      <tr>
+                        <th scope="row">Language</th>
+                        <td>{{ book.get_language_display }}</td>
+                      </tr>
+                      <tr>
+                        <th scope="row">Number of pages</th>
+                        <td>{{ book.number_of_pages|default:"-" }}</td>
+                      </tr>
+                      <tr>
+                        <th scope="row">Publication year</th>
+                        <td>{{ book.publication_year|default:"-" }}</td>
+                      </tr>
+                      <tr>
+                        <th scope="row">Purchase date</th>
+                        <td>{{ book.purchase_date|default:"-" }}</td>
+                      </tr>
+                    </tbody>
+                  </table>
+                  {% if properties %}
+                  <table class="table table-striped">
+                    <thead>
+                      <tr>
+                        <th colspan="2" scope="row">Properties</th>
+                      </tr>
+                    </thead>
+                    <tbody class="table-group-divider">
+                    {% for p in properties %}
+                      <tr>
+                        <th class="w-33" scope="row">{{ p.property }}</th>
+                        <td>{{ p.value }}</td>
+                      </tr>
+                    {% endfor %}
+                    </tbody>
+                  </table>
+                  {% endif %}
+                </div>
+                <div class="tab-pane" id="nav-documents" role="tabpanel" aria-labelledby="nav-documents-tab">
+                  <table class="table table-striped">
+                    <thead>
+                      <tr>
+                        <th colspan="3" scope="row">Documents</th>
+                      </tr>
+                    </thead>
+                    <tbody class="table-group-divider">
+                    {% for d in documents.all %}
+                      <tr>
+                        <td class="w-33">{{ d.description }}</td>
+                        <td><a href="{{ d.file.url }}" target="_blank">{{ d.filename }}</a></td>
+                        <td class="text-end">{{ d.file.size | filesizeformat }}</td>
+                      </tr>
+                    {% endfor %}
+                    </tbody>
+                  </table>
+                </div>
+                <div class="tab-pane" id="nav-notes" role="tabpanel" aria-labelledby="nav-notes-tab">
+                  {{ book.notes | safe }}
+                </div>
+              </div>
+              <div class="d-grid gap-2 d-md-flex justify-content-md-end">
+                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% dynamic_admin_url 'bookshelf' type book.pk %}">Edit</a>{% endif %}
+              </div>
+            </div>
+          </div>
+        </section>
+        {% endblock %}

ram/portal/templates/bookshelf/bookshelf_menu.html

@@ -0,0 +1,15 @@
+                {% if bookshelf_menu %}
+                <li class="nav-item dropdown">
+                  <a class="nav-link dropdown-toggle" href="#" id="bookshelfDropdownMenuLink" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                    Bookshelf
+                  </a>
+                  <ul class="dropdown-menu" aria-labelledby="bookshelfDropdownMenuLink">
+                    {% if books_menu %}
+                    <li><a class="dropdown-item" href="{% url 'books' %}">Books</a></li>
+                    {% endif %}
+                    {% if catalogs_menu %}
+                    <li><a class="dropdown-item" href="{% url 'catalogs' %}">Catalogs</a></li>
+                    {% endif %}
+                  </ul>
+                </li>
+                {% endif %}

ram/portal/templates/cards.html

@@ -0,0 +1,27 @@
+{% extends "base.html" %}
+      {% block header %}
+        <p class="lead text-muted">Results found: {{ matches }}</p>
+      {% endblock %}
+      {% block cards_layout %}
+      <div class="row row-cols-1 row-cols-md-2 row-cols-lg-3 g-3">
+      {% block cards %}
+        {% for d in data %}
+        {% if d.type == "roster" %}
+        {% include "cards/roster.html" %}
+        {% elif d.type == "company" %}
+        {% include "cards/company.html" %}
+        {% elif d.type == "rolling_stock_type" %}
+        {% include "cards/rolling_stock_type.html" %}
+        {% elif d.type == "scale" %}
+        {% include "cards/scale.html" %}
+        {% elif d.type == "consist" %}
+        {% include "cards/consist.html" %}
+        {% elif d.type == "manufacturer" %}
+        {% include "cards/manufacturer.html" %}
+        {% elif d.type == "book" or d.type == "catalog" %}
+        {% include "cards/book.html" %}
+        {% endif %}
+        {% endfor %}
+      {% endblock %}
+      </div>
+      {% endblock %}

ram/portal/templates/cards/book.html

@@ -0,0 +1,72 @@
+{% load dynamic_url %}
+        <div class="col">
+          <div class="card shadow-sm">
+            {% if d.item.image.exists %}
+            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d.item }}"></a>
+            {% endif %}
+            <div class="card-body">
+              <p class="card-text" style="position: relative;">
+                <strong>{{ d.item }}</strong>
+                <a class="stretched-link" href="{{ d.item.get_absolute_url }}"></a>
+              </p>
+              {% if d.item.tags.all %}
+              <p class="card-text"><small>Tags:</small>
+                {% for t in d.item.tags.all %}<a href="{% url 'filtered' _filter="tag" search=t.slug %}" class="badge rounded-pill bg-primary">
+                {{ t.name }}</a>{# new line is required #}
+                {% endfor %}
+              </p>
+              {% endif %}
+              <table class="table table-striped">
+                <thead>
+                  <tr>
+                    {% if d.type == "catalog" %}
+                    <th colspan="2" scope="row">Catalog</th>
+                    {% elif d.type == "book" %}
+                    <th colspan="2" scope="row">Book</th>
+                    {% endif %}
+                  </tr>
+                </thead>
+                <tbody class="table-group-divider">
+                  {% if d.type == "catalog" %}
+                  <tr>
+                    <th class="w-33" scope="row">Manufacturer</th>
+                    <td>{{ d.item.manufacturer }}</td>
+                  </tr>
+                  <tr>
+                    <th class="w-33" scope="row">Scales</th>
+                    <td>{{ d.item.get_scales }}</td>
+                  </tr>
+                  {% elif d.type == "book" %}
+                  <tr>
+                    <th class="w-33" scope="row">Authors</th>
+                    <td>
+                      <ul class="mb-0 list-unstyled">{% for a in d.item.authors.all %}<li>{{ a }}</li>{% endfor %}</ul>
+                    </td>
+                  </tr>
+                  <tr>
+                    <th class="w-33" scope="row">Publisher</th>
+                    <td>{{ d.item.publisher }}</td>
+                  </tr>
+                  {% endif %}
+                  <tr>
+                    <th scope="row">Language</th>
+                    <td>{{ d.item.get_language_display }}</td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Pages</th>
+                    <td>{{ d.item.number_of_pages|default:"-" }}</td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Year</th>
+                    <td>{{ d.item.publication_year|default:"-" }}</td>
+                  </tr>
+                </tbody>
+              </table>
+              <div class="d-grid gap-2 mb-1 d-md-block">
+                <a class="btn btn-sm btn-outline-primary" href="{{ d.item.get_absolute_url }}">Show all data</a>
+                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% dynamic_admin_url 'bookshelf' d.type d.item.pk %}">Edit</a>{% endif %}
+              </div>
+            </div>
+          </div>
+        </div>
+

ram/portal/templates/cards/company.html

@@ -0,0 +1,46 @@
+      <div class="col">
+        <div class="card shadow-sm">
+          <div class="card-body">
+            <p class="card-text" style="position: relative;">
+              <strong>{{ d.item.name }}</strong>
+            </p>
+            <table class="table table-striped">
+              <thead>
+                <tr>
+                  <th colspan="2" scope="row">Company</th>
+                </tr>
+              </thead>
+              <tbody class="table-group-divider">
+                {% if d.item.logo %}
+                <tr>
+                  <th class="w-33" scope="row">Logo</th>
+                  <td><img class="logo" src="{{ d.item.logo.url }}" alt="{{ d.item.name }} logo"></td>
+                </tr>
+                {% endif %}
+                <tr>
+                  <th class="w-33" scope="row">Name</th>
+                  <td>{{ d.item.extended_name }}</td>
+                </tr>
+                <tr>
+                  <th class="w-33" scope="row">Abbreviation</th>
+                  <td>{{ d.item.name }}</td>
+                </tr>
+                <tr>
+                  <th class="w-33" scope="row">Country</th>
+                  <td>{{ d.item.country.name }} <img src="{{ d.item.country.flag }}" alt="{{ d.item.country }}">
+                </tr>
+               {% if d.item.freelance %}
+               <tr>
+                  <th class="w-33" scope="row">Notes</th>
+                  <td>A <em>freelance</em> company</td>
+                </tr>
+               {% endif %}
+              </tbody>
+            </table>
+            <div class="d-grid gap-2 mb-1 d-md-block">
+              <a class="btn btn-sm btn-outline-primary" href="{% url 'filtered' _filter="company" search=d.item.slug %}">Show all rolling stock</a>
+              {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:metadata_company_change' d.item.pk %}">Edit</a>{% endif %}
+            </div>
+          </div>
+        </div>
+      </div>

ram/portal/templates/cards/consist.html

@@ -0,0 +1,57 @@
+      <div class="col">
+        <div class="card shadow-sm">
+          <a href="{{ d.item.get_absolute_url }}">
+          {% if d.item.image %}
+            <img class="card-img-top" src="{{ d.item.image.url }}" alt="{{ d.item }}">
+          {% else %}
+            {% with d.item.consist_item.first.rolling_stock as r %}
+            <img class="card-img-top" src="{{ r.image.first.image.url }}" alt="{{ d.item }}">
+            {% endwith %}
+          {% endif %}
+          </a>
+          <div class="card-body">
+            <p class="card-text" style="position: relative;">
+              <strong>{{ d.item }}</strong>
+              <a class="stretched-link" href="{{ d.item.get_absolute_url }}"></a>
+            </p>
+            {% if d.item.tags.all %}
+            <p class="card-text"><small>Tags:</small>
+              {% for t in d.item.tags.all %}<a href="{% url 'filtered' _filter="tag" search=t.slug %}" class="badge rounded-pill bg-primary">
+              {{ t.name }}</a>{# new line is required #}
+              {% endfor %}
+            </p>
+            {% endif %}
+            <table class="table table-striped">
+              <thead>
+                <tr>
+                  <th colspan="2" scope="row">Consist</th>
+                </tr>
+              </thead>
+              <tbody class="table-group-divider">
+                {% if d.item.address %}
+                <tr>
+                  <th class="w-33" scope="row">Address</th>
+                  <td>{{ d.item.address }}</td>
+                </tr>
+                {% endif %}
+                <tr>
+                  <th class="w-33" scope="row">Company</th>
+                  <td><abbr title="{{ d.item.company.extended_name }}">{{ d.item.company }}</abbr></td>
+                </tr>
+                <tr>
+                  <th scope="row">Era</th>
+                  <td>{{ d.item.era }}</td>
+                </tr>
+                <tr>
+                  <th scope="row">Length</th>
+                  <td>{{ d.item.consist_item.count }}</td>
+                </tr>
+              </tbody>
+            </table>
+            <div class="d-grid gap-2 mb-1 d-md-block">
+             <a class="btn btn-sm btn-outline-primary" href="{{ d.item.get_absolute_url }}">Show all data</a>
+              {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:consist_consist_change' d.item.pk %}">Edit</a>{% endif %}
+            </div>
+          </div>
+        </div>
+      </div>