Jaculabilis
/
redstring
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Support subtopics as subtags in index

This commit is contained in:
Tim Van Baak 2021-02-21 20:08:57 -08:00
parent b0d14a89ca
commit 2a45ad1a1b
1 changed files with 55 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
redstring/library.py
View File

@ -3,7 +3,15 @@ Logic for managing documents.
""" """
import os import os
from redstring.parser import load, DocumentTag, DocumentTab, Document, TabOptions, TagOptions from redstring.parser import (
Document,
DocumentTab,
DocumentTag,
DocumentSubtag,
load,
TabOptions,
TagOptions,
)
def generate_index_document(directory: str) -> Document: def generate_index_document(directory: str) -> Document:
@ -12,31 +20,48 @@ def generate_index_document(directory: str) -> Document:
""" """
categories: dict = {} categories: dict = {}
# categories = {
# tab_name: {
# tag_name: {
# 'documents': [ (id, title), ... ]
# 'subtags': {
# subtag_name: [ (id, title), ... ]
# }
# }
# }
# }
for filename in os.listdir(directory): for filename in os.listdir(directory):
with open(os.path.join(directory, filename)) as f: with open(os.path.join(directory, filename)) as f:
document: Document = load(f) document: Document = load(f)
# Check if this document specifies a tab, and create it if necessary. # Check if this document specifies a tab, and create it if necessary.
if category_tag := document.get_tag('category'): if category_tag := document.get_tag('category'):
category = category_tag.value category_name = category_tag.value
else: else:
category = 'index' category_name = 'index'
if category not in categories: if category_name not in categories:
categories[category] = {} categories[category_name] = {}
category_tab = categories[category] destination_category = categories[category_name]
# Check if this document specifies a topic, and create it if necessary. # Check if this document specifies a topic, and create it if necessary.
if topic_tag := document.get_tag('topic'): if topic_tag := document.get_tag('topic'):
topic = topic_tag.value topic_name, subtopic_name = topic_tag.value, None
else: else:
topic = 'uncategorized' topic_name, subtopic_name = 'uncategorized', None
if '.' in topic: if '.' in topic_name:
topic, subtopic = topic.split('.', maxsplit=1) topic_name, subtopic_name = topic_name.split('.', maxsplit=1)
if topic_name not in destination_category:
destination_category[topic_name] = {
'documents': [],
'subtopics': {},
}
if subtopic_name:
if subtopic_name not in destination_category[topic_name]['subtopics']:
destination_category[topic_name]['subtopics'][subtopic_name] = []
destination_topic = destination_category[topic_name]['subtopics'][subtopic_name]
else: else:
subtopic = None destination_topic = destination_category[topic_name]['documents']
if topic not in category_tab:
category_tab[topic] = []
topic_tag = category_tab[topic]
# Save the title and id. # Save the title and id.
doc_id = document.get_tag('id').value doc_id = document.get_tag('id').value
@ -45,7 +70,7 @@ def generate_index_document(directory: str) -> Document:
else: else:
doc_title = None doc_title = None
topic_tag.append((doc_id, doc_title)) destination_topic.append((doc_id, doc_title))
# Build an index document # Build an index document
def document_link(info): def document_link(info):
@ -57,16 +82,24 @@ def generate_index_document(directory: str) -> Document:
) )
built_tabs: list = [] built_tabs: list = []
for category in sorted(categories.keys()): for category_name, category in sorted(categories.items()):
built_tags: list = [] built_tags: list = []
for topic_name, topic in sorted(category.items()):
for topic in sorted(categories[category].keys()): docs = sorted(topic['documents'], key=lambda x: x[0])
docs = sorted(categories[category][topic], key=lambda x: x[0])
doc_links = map(document_link, docs) doc_links = map(document_link, docs)
value = '- ' + '<br>- '.join(doc_links) value = '- ' + '<br>- '.join(doc_links) if docs else ''
built_tags.append(DocumentTag(topic, value))
built_tabs.append(DocumentTab(category, built_tags)) built_subtags: list = []
for subtopic_name, subtopic in sorted(topic['subtopics'].items()):
docs = sorted(subtopic, key = lambda x: x[0])
doc_links = map(document_link, docs)
subtag_value = '- ' + '<br>- '.join(doc_links) if docs else ''
built_subtags.append(DocumentSubtag(subtopic_name, subtag_value))
built_tags.append(DocumentTag(topic_name, value, subtags=built_subtags))
built_tabs.append(DocumentTab(category_name, built_tags))
return Document(built_tabs) return Document(built_tabs)