RD (Ruby Document) es un lenguaje de marcado ligero para escribir documentos relacionados con Ruby . Se puede incrustar en el código fuente de Ruby.
RD es un formato tradicional. En Ruby moderno, los desarrolladores tienden a escribir documentos en RDoc en lugar de RD.
Usar
Originalmente, la mayor parte de la documentación en el mundo de Ruby, incluido el propio Ruby, se había escrito en RD. Luego, en 2002, gran parte se convirtió al formato RDoc. Aunque, la versión japonesa del Ruby Reference Manual aún permanece en formato RD.
RD está diseñado para escribirse a mano y leerse fácilmente en su forma original. Sin embargo, la mayoría de los usuarios finales lo experimentan después de que se haya convertido a HTML o páginas de manual .
RD se puede incrustar en código Ruby, y los archivos RD puros generalmente tienen la extensión .rd
.
Ejemplo de documento RD
Este documento es RD sintácticamente correcto, que también intenta seguir las principales convenciones sobre la denominación de secciones.
Fuente | Resultado HTML |
---|---|
= comenzar= NOMBREMuestra de RD: un documento de RD de muestra= SINOPSIS here.is_a? (Pieza :: De :: Código) print << "FIN" Este bloque sangrado no se escaneará para formatear códigos o directivas, y se conservarán los espacios. FINAL= DESCRIPCIONAquí hay un texto normal. Incluye texto que es((* enfatizado *)), ((% keyboard%)), (({code})) - formateado,((| parte variable |)), ((: indexado :)) y (('tal cual')) ((- nota al pie-)).== Una lista de ejemplo* Esta es una lista con viñetas.* Aquí hay otro artículo. * Elemento de lista anidado.== Una lista ordenada(1) Este es el primer elemento(2 segundos * Lista desordenada anidada.(3) tercero (1) Lista ordenada anidada (2) su segundo elemento= fin= comenzar html/> Aquí hay algo de HTML incrustado. En este bloque puedo incluir imágenes, aplicar estilos , o hacer cualquier otra cosa que pueda hacer con HTML. Los procesadores RD que no generan HTML ignóralo por completo.= fin= comenzar= DERECHOS DE AUTORCopyright 2005 J. Random Hacker | NOMBREMuestra de RD: un documento de RD de muestra SINOPSIShere.is_a? (Pieza :: De :: Código)print << "FIN"Este bloque sangrado no se escaneará para formatearcódigos o directivas, y se conservarán los espacios.FINAL DESCRIPCIÓNAquí hay un texto normal. Incluye texto enfatizado , teclado , Una lista de ejemplo
Una lista ordenada
DERECHOS DE AUTORCopyright 2005 J. Random Hacker |
Ver también
enlaces externos
- RDtool - Framework para traducir documentos RD a otros formatos.
- rd-draft.rd : descripción completa del lenguaje de marcado RD (en formato RD)
- rd-draft.html : descripción completa del lenguaje de marcado RD (convertido a HTML)