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:
@@ -11,18 +11,18 @@ import { ElMessage, type FormInstance, type FormRules } from 'element-plus'
|
||||
|
||||
import { errorMessage } from '@/api/client'
|
||||
import {
|
||||
createTemplateFieldLibrary,
|
||||
updateTemplateFieldLibrary,
|
||||
type TemplateFieldLibrary,
|
||||
type TemplateFieldLibraryPayload,
|
||||
} from '@/api/templateFieldLibrary'
|
||||
createTemplateTitle,
|
||||
updateTemplateTitle,
|
||||
type TemplateTitle,
|
||||
type TemplateTitlePayload,
|
||||
} from '@/api/templateTitles'
|
||||
import { normalizeHexColor, typographyStyle } from '@/utils/format'
|
||||
|
||||
const props = defineProps<{
|
||||
/** Visibility, used with `v-model`. */
|
||||
modelValue: boolean
|
||||
/** The field being edited, or `null` to create a new one. */
|
||||
field: TemplateFieldLibrary | null
|
||||
field: TemplateTitle | null
|
||||
}>()
|
||||
|
||||
const emit = defineEmits<{
|
||||
@@ -39,7 +39,7 @@ const visible = computed({
|
||||
const formRef = ref<FormInstance>()
|
||||
const saving = ref(false)
|
||||
|
||||
const form = reactive<TemplateFieldLibraryPayload>({
|
||||
const form = reactive<TemplateTitlePayload>({
|
||||
name: '',
|
||||
level: 1,
|
||||
// 小四, the conventional body size for a Chinese thesis.
|
||||
@@ -47,7 +47,7 @@ const form = reactive<TemplateFieldLibraryPayload>({
|
||||
font_color: '#000000',
|
||||
})
|
||||
|
||||
const rules: FormRules<TemplateFieldLibraryPayload> = {
|
||||
const rules: FormRules<TemplateTitlePayload> = {
|
||||
name: [
|
||||
{ required: true, message: '请填写字段名称', trigger: 'blur' },
|
||||
{ max: 255, message: '字段名称最多 255 个字符', trigger: 'blur' },
|
||||
@@ -118,10 +118,10 @@ async function submit(): Promise<void> {
|
||||
saving.value = true
|
||||
try {
|
||||
if (props.field) {
|
||||
await updateTemplateFieldLibrary(props.field.id, { ...form })
|
||||
await updateTemplateTitle(props.field.id, { ...form })
|
||||
ElMessage.success('字段已更新,使用它的模板会同步生效')
|
||||
} else {
|
||||
await createTemplateFieldLibrary({ ...form })
|
||||
await createTemplateTitle({ ...form })
|
||||
ElMessage.success('字段已创建')
|
||||
}
|
||||
emit('saved')
|
||||
|
||||
Reference in New Issue
Block a user