Diferencia entre revisiones de «WikiF2 Parámetros 2»
Página creada con «__toc__ {{cen1|WikiF2 Parámetros 2}} {{cen2|Criterios de documentación técnica y sintaxis en WikiFSF}} ---- == Introducción == {{marca|WikiF2}} {{sc|Refinamiento técnico de la Capa Forma}} Esta segunda versión de parámetros profundiza en la documentación de sintaxis, plantillas y comandos dentro de WikiFSF. Si “Parámetros 1” definió jerarquía visual y cognitiva, “Parámetros 2” define precisión técnica y coherencia estructural interna. No s…» |
|||
| Línea 21: | Línea 21: | ||
== I. Documentación de Sintaxis MediaWiki == | == I. Documentación de Sintaxis MediaWiki == | ||
=== 1. Uso Preferente de <nowiki> === | === 1. Uso Preferente de <nowiki><nowiki></nowiki> === | ||
Cuando se documenten: | Cuando se documenten: | ||
Revisión del 09:58 27 feb 2026
Introducción
🌟 WikiF2
Esta segunda versión de parámetros profundiza en la documentación de sintaxis, plantillas y comandos dentro de WikiFSF.
Si “Parámetros 1” definió jerarquía visual y cognitiva, “Parámetros 2” define precisión técnica y coherencia estructural interna.
No se agregan reglas por acumulación. Se agregan para reducir ambigüedad.
I. Documentación de Sintaxis MediaWiki
1. Uso Preferente de <nowiki>
Cuando se documenten:
- Comandos internos de MediaWiki.
- Plantillas WikiFSF.
- Parámetros reales.
- Estructuras ejecutables.
Se utilizará:
<nowiki> ... </nowiki>
Ejemplo:
- __toc__
- {{cen1|Título}}
- {{o|Texto}}
Principio: <nowiki></nowiki> preserva sintaxis real sin ejecutarla y mantiene coherencia con el ecosistema MediaWiki.
2. Uso Secundario de
... podrá utilizarse cuando:
- Se muestren símbolos aislados.
- Se mencionen caracteres técnicos (*, #, :, etc.).
- Se haga referencia genérica a notación técnica no ejecutable.
Ejemplo:
- Uso del símbolo
* para listas.
- Evitar el uso de
# salvo necesidad conceptual.
Regla de prioridad:
Para plantillas y comandos reales → preferir <nowiki></nowiki>.
Para símbolos aislados → puede utilizarse ....
II. Documentación Completa de Plantillas
1. Mostrar Estructura Completa
Cuando se documente una plantilla, se debe mostrar:
- Nombre completo.
- Uso del parámetro.
- Sintaxis íntegra.
Ejemplo correcto:
- {{o|texto enviado por parámetro}}
Evitar ejemplos incompletos como:
- {{o}}
Principio pedagógico:
La documentación debe enseñar estructura real, no fragmentos ambiguos.
2. Precisión Tipográfica
Al documentar plantillas:
- No omitir parámetros obligatorios.
- No alterar el nombre.
- Corregir errores tipográficos.
- Mantener consistencia en espacios internos.
Ejemplo correcto:
- {{oro|texto}}
No recomendable:
- {{oro | texo}}
La documentación técnica exige exactitud.
III. Coherencia entre Ejecución y Documentación
1. Separación Clara
Debe diferenciarse visualmente:
- Plantilla ejecutada (se muestra resultado).
- Plantilla documentada (se muestra sintaxis).
Ejemplo:
Plantilla ejecutada:
Ejemplo visible
Plantilla documentada:
- {{o|Ejemplo visible}}
Esto evita confusión entre resultado y estructura.
IV. Sintaxis y Convenciones Técnicas Internas
1. Prioridad del Ecosistema WikiFSF
En caso de ambigüedad entre:
- Convención general de HTML.
- Convención típica de Markdown.
- Convención MediaWiki.
Se priorizará siempre:
Convención MediaWiki y estándar interno WikiFSF.
2. Desactivación de Patrones Externos
Evitar automatismos heredados de otros sistemas, como:
- Uso excesivo de
# por influencia Markdown.
- Notación híbrida que no pertenezca al entorno MediaWiki.
WikiF2 privilegia coherencia sistémica sobre costumbre externa.
V. Principios Técnicos del Modelo
- Documentar es parte del diseño.
- La sintaxis debe ser pedagógica.
- La precisión técnica fortalece la claridad.
- Forma visual y forma técnica deben estar alineadas.
- Cada ejemplo debe poder ejecutarse correctamente si se activa.
VI. Alcance de Parámetros 2
Esta versión:
- Refuerza identidad técnica de WikiFSF.
- Reduce ambigüedad entre mostrar y ejecutar.
- Consolida coherencia interna.
Se mantiene abierta a refinamiento progresivo.
Estado
- Parámetros 2 formalizados.
- Integración activa con Parámetros 1.
- Listos para prueba y curado posterior.