Saltearse al contenido

Notas Editoriales y Anotaciones — Guía de Desarrollo y Admin UI

Ventana de terminal
pnpm add @vicacha-devs/strapi-plugin-notes

2. Configuración del Servidor (config/plugins.ts)

Sección titulada «2. Configuración del Servidor (config/plugins.ts)»

Agregue la configuración del plugin en el archivo config/plugins.ts de su aplicación Strapi v5:

config/plugins.ts
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({
"notes": {
enabled: true,
config: {
enablePinning: true,
enableLocaleScoping: true,
},
},
});

Notas Editoriales y Anotaciones — Strapi v5 Settings Panel

3. Recorrido por la Interfaz de Administración (Strapi v5 Admin UI)

Sección titulada «3. Recorrido por la Interfaz de Administración (Strapi v5 Admin UI)»

Una vez habilitado, el plugin registra su espacio de trabajo y ajustes dentro del panel de administración de Strapi v5 utilizando Strapi Design System v2:

Notas Editoriales y Anotaciones — Strapi v5 Admin UI

Etiquetas Localizadas de la Interfaz (Español)

Sección titulada «Etiquetas Localizadas de la Interfaz (Español)»
Clave de Traducción Texto en Interfaz
plugin.name Notas
notes.loading Cargando contenido …
notes.notification.loadError No se pudieron cargar las notas.
notes.notification.created La nota ha sido creada exitosamente.
notes.notification.createError Error al crear la nota.
notes.notification.updated La nota ha sido actualizada exitosamente.
notes.notification.updateError Error al actualizar la nota.
notes.notification.deleted La nota ha sido eliminada exitosamente.

4. Entidades Content-Type, Ubicación y Esquemas (strapi.documents)

Sección titulada «4. Entidades Content-Type, Ubicación y Esquemas (strapi.documents)»

Registers one internal polymorphic Collection Type (plugin::notes.note, content-manager.visible: false) that attaches editorial annotations to any Strapi Content Manager document via entitySlug (e.g., api::article.article), entityDocumentId, and entityLocale.

Dónde Encontrar las Entidades Content-Type en Strapi v5

Sección titulada «Dónde Encontrar las Entidades Content-Type en Strapi v5»
  • Content Manager Right Side Panel: Open any document in /admin/content-manager/collection-types/... or single-types/... to view, create, and pin notes scoped to that document and locale
  • Global Notes Hub Workspace: /admin/plugins/notes (centralized search, category filter, and pin board across all Content-Type entities)
  • Database Table: notes (plugin::notes.note queried via strapi.documents('plugin::notes.note'))

Editorial notes attached to Content Manager entity records

Kind: collectionType · DB Table: notes · Admin Location: Internal (/admin/plugins/notes) · Draft & Publish: No · i18n: No

Atributo Tipo en Strapi Requerido Restricciones / Relación
title string Yes max: 255
content text No —
category enumeration Yes enum: general, todo, blocker, idea; default: "general"
isPinned boolean No default: false
entityId integer No —
entityDocumentId string No max: 128
entitySlug string Yes max: 160
entityLocale string No max: 32
createdByName string No max: 120
updatedByName string No max: 120

Integración con el Content Manager de Strapi v5 (/admin/content-manager)

Sección titulada «Integración con el Content Manager de Strapi v5 (/admin/content-manager)»

Grupo en la Barra Lateral del Content Manager: Injected into All Content Manager Collection Types & Single Types (Right Sidebar)

Entidades y Componentes en el Content Manager

Sección titulada «Entidades y Componentes en el Content Manager»
  • Right-Sidebar Notes (NOTES) Panel injected into every /admin/content-manager/collection-types/* and /admin/content-manager/single-types/* edit view
  • Internal Polymorphic Entity plugin::notes.note (notes table, managed via Content Manager side panel & /admin/plugins/notes)

Notas Editoriales y Anotaciones — Vista de Entidades en el Content Manager de Strapi v5

Por Qué Este Plugin Crea e Integra Entidades en el Content Manager

Sección titulada «Por Qué Este Plugin Crea e Integra Entidades en el Content Manager»

@vicacha-devs/strapi-plugin-notes is purpose-built for the Strapi v5 Content Manager: it injects an interactive Notes panel directly into the right sidebar of every document edit view while keeping plugin::notes.note (content-manager.visible: false) out of the collection list to avoid cluttering the left sidebar:

  • Works on Every api::* and plugin::* Content Manager Entity: Attach general, todo, blocker, or idea notes to an Article & Course, Event, Donation Campaign, Islam Scripture Entry, or Resource Publication directly inside Content Manager.
  • Per-Locale (Scope only to locale) or Cross-Locale Pinning: Scope a translation note specifically to en, es, ar, or tr, and pin critical blockers (Pin note to top) so editors see them immediately upon opening the entry.

Cómo Usarlo en el Content Manager de Strapi (Paso a Paso)

Sección titulada «Cómo Usarlo en el Content Manager de Strapi (Paso a Paso)»
  1. Open Any Entry in Content Manager: Open any document in /admin/content-manager/collection-types/... or /admin/content-manager/single-types/....
  2. Click + Add a note: In the right-hand sidebar under NOTES, click the button to open the note modal.
  3. Set Category, Pin & Locale Scope: Enter Title, select Category (General, To-Do, Blocker, Idea), write the Content, optionally check Pin note to top or Scope only to locale, and click Save.
  4. Triage Across All Entities: Visit /admin/plugins/notes (Global Notes Hub) to filter all notes across the entire CMS and click any card to jump back into Content Manager.

Sincronización entre el Content Manager y el Espacio del Plugin

Sección titulada «Sincronización entre el Content Manager y el Espacio del Plugin»

Casos de Uso en el Content Manager y Flujos Editoriales

Sección titulada «Casos de Uso en el Content Manager y Flujos Editoriales»

Content Manager Use Case 1 — Attaching Locale-Scoped Translation & Scholar Review Notes

Sección titulada «Content Manager Use Case 1 — Attaching Locale-Scoped Translation & Scholar Review Notes»
  • Para qué sirve y por qué usarlo: Leave a blocker or todo review note on a course or scripture entry directly inside the Content Manager edit screen.
  • Cómo ejecutarlo en el Content Manager: Open /admin/content-manager/collection-types/api::article.article/{documentId}?plugins[i18n][locale]=en, click + Add a note in the right sidebar, check Scope only to locale (en), and save.

Use Case 1 — In-Context Editorial Review & Translation Handoff Notes

Sección titulada «Use Case 1 — In-Context Editorial Review & Translation Handoff Notes»
  • What it is for: Leave todo, blocker, idea, or general notes directly on a draft Article, Event, or Donation Campaign for fellow editors and translators.
  • How it works: Open the record in Content Manager; the injected side panel queries GET /notes/entity?entitySlug=...&entityDocumentId=...&entityLocale=... and creates notes via POST /notes.

Editorial Notes & Pins — Strapi v5 Content Manager Entities

Use Case 2 — Pinning Critical Editorial Blockers to the Top of a Document

Sección titulada «Use Case 2 — Pinning Critical Editorial Blockers to the Top of a Document»
  • What it is for: Ensure legal, theological, or fact-checking warnings stay pinned (isPinned: true) at the top of a Content Manager entry.
  • How it works: Toggle pin status in the Content Manager side panel (PUT /notes/{id}), surfacing the note both on the document and in the Global Notes Hub.

Editorial Notes & Pins — Strapi v5 Admin Workspace

Use Case 3 — Cross-Collection Editorial Triage in the Global Notes Hub

Sección titulada «Use Case 3 — Cross-Collection Editorial Triage in the Global Notes Hub»
  • What it is for: Review all unresolved blocker and todo annotations across every collection type from a single dashboard.
  • How it works: Navigate to /admin/plugins/notes to filter plugin::notes.note records by category, isPinned, entitySlug, or keyword and jump straight to the target document.

Editorial Notes & Pins — Strapi v5 Settings Panel

Método Ruta del Endpoint Ámbito Controlador Autenticación
GET /notes/notes admin notesController.find Bearer JWT
GET /notes/notes/stats admin notesController.stats Bearer JWT
GET /notes/notes/{id} admin notesController.findOne Bearer JWT
POST /notes/notes admin notesController.create Bearer JWT
PUT /notes/notes/{id} admin notesController.update Bearer JWT
DELETE /notes/notes/{id} admin notesController.delete Bearer JWT
GET /api/notes/notes content-api notesController.find Bearer JWT
GET /api/notes/notes/{id} content-api notesController.findOne Bearer JWT

7. Uso Programático en el Servidor (strapi.plugin y strapi.documents)

Sección titulada «7. Uso Programático en el Servidor (strapi.plugin y strapi.documents)»
// Registered services on plugin "notes": "notesService", "noteService", "note"
const pluginService = strapi.plugin("notes")?.service("notesService");
// Querying records via the Strapi v5 Document Service API
const records = await strapi.documents("plugin::notes.note").findMany({
limit: 25,
sort: "createdAt:desc",
});
  • Cambios no visibles en el panel Admin: Ejecute pnpm strapi build después de editar config/plugins.ts.
  • Aislamiento de dependencias peer: Mantenga hoistPattern: ["*", "!@strapi/*"] en pnpm-workspace.yaml para evitar colisiones de contexto en React.
  • Verificación estricta de TypeScript: Ejecute pnpm check para validar admin/tsconfig.json y server/tsconfig.json.