2011-01-11 18 views
11

Trabajando en mi base de conocimiento personal ... Quiero formatear mis documentos, incluso en el disco duro local en sintaxis wiki. A veces los subía a una wiki (corporativa), a veces los descargaba desde allí. Se planificaron algunas herramientas para respaldar este flujo y buscar en mi base de conocimiento (documentos) para más adelante. Obviamente, quiero que el descuento sea compatible con la mayoría, minimizando el trabajo de conversión.¿Qué sintaxis de texto wiki o Markdown usar?

Así que mi pregunta es similar a this related question, pero la versión de texto

  • Lo wiki o de rebajas (dialecto) se debe utilizar cuando comienzo algo nuevo? (es decir, proyecto de documentación y tipo de wiki).
  • ¿Cuáles son los más usados ​​/ reconocidos?
  • ¿Y dónde es mejor el soporte de herramientas (editores y/o bibliotecas)? Prog. Preocupado los idiomas son Java, Ruby, Scala.
+1

vamos muchachos, estoy seguro de que hay algunas exportaciones wiki aquí ;-) –

+4

Realmente necesitamos un estándar Wiki que finalmente los unifique a todos: http: // xkcd .com/927/ – Heinzi

Respuesta

12

Wikipedia says que no existe un lenguaje de wikitexto estándar comúnmente aceptado.

Creole es un esfuerzo para un "lenguaje de marcado wiki común que se utilizará en diferentes Wikis". Hay una versión 1.0 de la especificación y varios wikis and wiki engines implementarlo. MediaWiki no lo implementa.

tiene un gran número de implementaciones y parece que se usa bastante.

Como no hay una norma acordada, el idioma puede seleccionarse según features and available implementations dependiendo del caso de uso.

1

Por desgracia hay muy poca estandarización formato wiki en el mundo, aunque algunos wikis (en particular de Atlassian Confluence, un producto comercial) se están moviendo hacia XHTML.

El software de Wiki más usado es MediaWiki (de la fama de Wikipedia). El marcado de Mediawiki es famoso por ser difícil de analizar, pero ha existido y se ha usado lo suficiente como para que haya muchos existing tools para convertir al formato MediaWiki y para editarlo, así como para editar contenido con muchos editores diferentes en línea y fuera de línea.

MediaWiki también tiene una API con todas las funciones con muchas bibliotecas de clientes en varios lenguajes de programación (ver Client code), incluyendo, por ejemplo. MediaWiki::Gateway para Ruby.

+0

Entonces para un nuevo proyecto, eso usa la sintaxis Wiki por ejemplo plantillas o contenido, ¿recomendaría el formato MediaWiki? –

+1

¿Cuán grande es tu proyecto, y estás seguro de que necesitas una wiki en primer lugar? Para la mayoría de los proyectos de baja tecnología, algo como Google Docs con seguimiento de cambios activado realmente hará un trabajo mucho mejor. – jpatokal

+0

Quiero guardar documentos en un formato estándar, legible por máquina sería bueno, pero sigue siendo texto sin formato y muy legible en el editor de texto para el usuario. Esto es un descuento (es decir, sintaxis wiki). Debería ser la base de alguna herramienta de gestión del conocimiento (en desarrollo). –

2

(1) Si bien hay una gran cantidad de marcas wiki Sugiero que se adhieren a lenguaje de marcas bien definido.

Hay sólo el 3 de marcado de texto plano con especificaciones bien definidas:

  • CommonMark intento de definir la sintaxis fuerte y estandarizar las extensiones comunes de MarkDown popular. Todos lo aman Muy orientado a HTML
  • reStructuredText es un marco coherente para el marcado y el proyecto bien establecido (comenzó a partir de 2001 !!). Si necesita extensibilidad incorporada en las especificaciones principales, márgenes extranjeros en línea, generar HTML/PDF/docbook/etc. es su elección. Varios libros y muchos proyectos de software se documentaron a través de reStructuredText.Verifique https://readthedocs.org/ Con el software de publicación Sphinx, puede construir HTML con fuera de línea JS search !!
  • AsciiDoc es competitivo a reStructuredText pero falta de extensibilidad incorporada. Está muy orientado a DocBook. Varios libros fueron escritos en AsciiDoc.

Textile markup no obtuvo especificaciones bien definidas y tiene una comunidad débil. Recomiendo considerar las 3 opciones anteriores en su lugar.

(2) Definitivamente debe pegarse a los archivos de texto sin formato.

Software de soporte para todos los formatos anteriores capaz de producir resultados de alta calidad para impresión y publicación en línea.

me quedo con RST porque necesito extensibilidad y capacidad de inline de marcas extranjeras (matemáticas con LaTeX, gráfico con graphviz/punto, el trazado con ImageMagic, etc)

que busco sobre consejos personales dentro Emacs editor o dentro de bash/grep. Con fines publicitarios publico mis consejos en línea, por ejemplo: http://tips.defun.work/

Cuestiones relacionadas