refactor: call a heading a title, and its use a placement
`template_field_library` and `template_field` were one word apart and meant
opposite kinds of thing — a catalogue of rows versus one row — and neither name
said what a row actually is. Every row of the library is a **heading**: a piece
of text like 「1. Introduction」 with a level and typography, which is what the
reader sees at the top of a paragraph; and every row of the join table is that
heading *placed* in a template, `sort` included.
template_field_library -> template_title
template_field -> template_title_placement
field_id (the column) -> title_id
TemplateFieldLibrary -> TemplateTitle
TemplateField -> TemplateTitlePlacement
The join table keeps its own name rather than becoming `_link`, because it is
not a bare link: it carries `sort`, the only place display order is stored, and
it deliberately allows the same title twice in one template. `_link` would
describe two foreign keys and hide the column the ordering rule rests on.
Carried through every level, because a half-renamed layer is how the confusing
pair got there in the first place: HTTP paths (`/template-field-library` ->
`/template-titles`), the template payload (`fields`/`field_id` ->
`placements`/`title_id`, and `field_count` -> `placement_count`), the Pydantic
schemas, the CRUD modules, the seed script, the frontend API module and types,
and `docs/OVERVIEW.md`, which now states the naming rules outright.
Two deliberate exceptions:
* `paper_template_filed_sort` is untouched — it is a column of the paper module
and is spelled as the feature was specified.
* The MCP tools keep their agent-facing names (`field_list`, `field_ids`, and
the `fields`/`field_id` keys in their responses). Agents already call them by
those names; the storage names they read underneath have changed.
The migration renames in place (data preserved: 4 templates, 45 titles, 63
placements) and is written to tolerate a database where part of it already ran,
which is not hypothetical — the first attempt renamed the tables and then failed
on the column, because Alembic's MySQL dialect wants an explicit type for
`alter_column` and will not rename a column without one. TiDB carries the
foreign key along with both the renamed table and the renamed column, rehearsed
against the cluster first, and it stays enforced.
Verified: seed re-runs clean, the paper smoke test's 45 checks and the MCP
smoke test's 47 pass, `vue-tsc` and the build are clean, and the UI was driven
in a headless browser through the template list, its preview drawer, the title
library page, the template form (which now posts `placements` with `title_id`)
and the paper document with no console errors.
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
"""Field-library tools (字段库): the reusable headings templates are built from.
|
||||
|
||||
The library is the catalogue, and ``template_field`` is a placement in one
|
||||
The library is the catalogue, and ``template_title_placement`` is a placement in one
|
||||
template — one word apart, opposite meanings. A field exists once and may be
|
||||
placed by any number of templates, which is why editing a field restyles every
|
||||
outline that uses it and why deleting one is refused while any template still
|
||||
@@ -20,13 +20,13 @@ from mcp.server.mcpserver import MCPServer
|
||||
from pydantic import Field
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from app.crud import template_field_library as field_crud
|
||||
from app.crud import template_title as field_crud
|
||||
from app.mcp import support as s
|
||||
from app.mcp.tools.registry import mcp_tool
|
||||
from app.models import TemplateFieldLibrary
|
||||
from app.schemas.template_field_library import (
|
||||
TemplateFieldLibraryCreate,
|
||||
TemplateFieldLibraryUpdate,
|
||||
from app.models import TemplateTitle
|
||||
from app.schemas.template_title import (
|
||||
TemplateTitleCreate,
|
||||
TemplateTitleUpdate,
|
||||
)
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ def register(server: MCPServer) -> None:
|
||||
"""列出字段库(模板能用的所有标题)。建模板前先查这里的 id。"""
|
||||
page, page_size = s.page_args(page, page_size)
|
||||
with s.session() as db:
|
||||
rows, total = field_crud.list_fields(
|
||||
rows, total = field_crud.list_titles(
|
||||
db, keyword=keyword, level=level, page=page, page_size=page_size
|
||||
)
|
||||
return s.dumps(
|
||||
@@ -87,7 +87,7 @@ def register(server: MCPServer) -> None:
|
||||
] = "#000000",
|
||||
) -> str:
|
||||
"""往字段库加一个标题字段,可带字号颜色。"""
|
||||
payload = TemplateFieldLibraryCreate(
|
||||
payload = TemplateTitleCreate(
|
||||
name=name, level=level, font_size=font_size, font_color=font_color
|
||||
)
|
||||
with s.session() as db:
|
||||
@@ -117,7 +117,7 @@ def register(server: MCPServer) -> None:
|
||||
if not values:
|
||||
s.fail("没有给出任何要修改的内容")
|
||||
|
||||
payload = TemplateFieldLibraryUpdate(**values)
|
||||
payload = TemplateTitleUpdate(**values)
|
||||
|
||||
with s.session() as db:
|
||||
field = s.field_or_fail(db, field_id)
|
||||
@@ -155,7 +155,7 @@ def register(server: MCPServer) -> None:
|
||||
# --- helpers -----------------------------------------------------------------
|
||||
|
||||
|
||||
def _field_row(field: TemplateFieldLibrary) -> dict:
|
||||
def _field_row(field: TemplateTitle) -> dict:
|
||||
"""One library entry as a model reads it."""
|
||||
return {
|
||||
"id": field.id,
|
||||
@@ -166,7 +166,7 @@ def _field_row(field: TemplateFieldLibrary) -> dict:
|
||||
}
|
||||
|
||||
|
||||
def _assert_unused(db: Session, fields: list[TemplateFieldLibrary]) -> None:
|
||||
def _assert_unused(db: Session, fields: list[TemplateTitle]) -> None:
|
||||
"""Refuse the delete while any template still places the field.
|
||||
|
||||
Dropping a field that is placed somewhere would silently remove a heading
|
||||
|
||||
Reference in New Issue
Block a user