<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Bicosyes - since evermore... &#187; bdoc</title>
	<atom:link href="http://bicosyes.com/tag/bdoc/feed/" rel="self" type="application/rss+xml" />
	<link>http://bicosyes.com</link>
	<description></description>
	<lastBuildDate>Sat, 06 Mar 2010 20:03:06 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.8.6</generator>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
			<item>
		<title>Visualización de la documentación de todas las gemas instaladas</title>
		<link>http://bicosyes.com/visualizacion-de-la-documentacion-de-todas-las-gemas-instaladas/</link>
		<comments>http://bicosyes.com/visualizacion-de-la-documentacion-de-todas-las-gemas-instaladas/#comments</comments>
		<pubDate>Sun, 31 May 2009 12:55:10 +0000</pubDate>
		<dc:creator>blaxter</dc:creator>
				<category><![CDATA[Ruby]]></category>
		<category><![CDATA[bdoc]]></category>
		<category><![CDATA[gems]]></category>
		<category><![CDATA[rdoc]]></category>

		<guid isPermaLink="false">http://bicosyes.com/?p=835</guid>
		<description><![CDATA[La documentación de las gemas de ruby se genera a partir del código fuente mediante rdoc. Después de eso puedes optar por ver individualmente cada una o usar gem server.
Para poder mejorar todo esto podemos usar par de útiles herramientas: (1) la plantilla para rdoc, hanna; y (2)bdoc como alternativa a gem server para visualizar [...]]]></description>
			<content:encoded><![CDATA[<p>La documentación de las gemas de ruby se genera a partir del código fuente mediante rdoc. Después de eso puedes optar por ver individualmente cada una o usar <a href="http://rubygems.org/read/chapter/18">gem server</a>.</p>
<p>Para poder mejorar todo esto podemos usar par de útiles herramientas: (1) la plantilla para rdoc, <strong><a href="http://github.com/mislav/hanna/tree/master">hanna</a></strong>; y (2)<a href="http://manalang.com/archives/2009/03/29/introducing-bdoc-a-better-gem-doc-browser/"><strong>bdoc</strong></a> como alternativa a gem server para visualizar la documentación.</p>
<p><strong>Hanna</strong> es una plantilla para rdoc que mejora notablemente el formato por defecto. Podemos ver la diferencia fácilmente, por ejemplo, en la documentación de rspec con <a href="http://rspec.rubyforge.org/rspec/1.1.11/">el formato típico</a> <em>vs</em> <a href="http://rspec.rubyforge.org/rspec/1.2.6/">la documentación hecha con hanna</a>. La instalación es simple:</p>
<pre class="bash">$ <span style="color: #c20cb9; font-weight: bold;">sudo</span> gem sources -a http://gems.github.com
$ <span style="color: #c20cb9; font-weight: bold;">sudo</span> gem <span style="color: #c20cb9; font-weight: bold;">install</span> mislav-hanna</pre>
<p>Para que a partir de ahora se generar la documentación con esta plantilla, puede añadir a tu <em>.gemrc</em> la siguiente línea:</p>
<pre>rdoc: --inline-source --line-numbers --template=hanna</pre>
<p>Y para convertir la documentación de todas tus gemas instaladas, puedes hacer algo como esto:</p>
<pre class="bash">$ <span style="color: #c20cb9; font-weight: bold;">sudo</span> gem list | <span style="color: #c20cb9; font-weight: bold;">awk</span> <span style="color: #ff0000;">'{print $1}'</span> | <span style="color: #c20cb9; font-weight: bold;">xargs</span> <span style="color: #c20cb9; font-weight: bold;">sudo</span> hanna --gems</pre>
<p>Por otro lado, gracias a <strong>bdoc</strong> podremos navegar fácilmente entre todas las documentaciones.</p>
<pre class="bash">$ <span style="color: #c20cb9; font-weight: bold;">sudo</span> gem <span style="color: #c20cb9; font-weight: bold;">install</span> manalang-bdoc
$ bdoc</pre>
<p><a href="http://bicosyes.com/wp-content/uploads/2009/05/bdoc.jpg"><img src="http://bicosyes.com/wp-content/uploads/2009/05/bdoc-300x157.jpg" alt="bdoc" title="bdoc" width="300" height="157" class="aligncenter size-medium wp-image-836" /></a><br />
Ejecutando <em>bdoc</em> se nos abrirá en nuestro navegador por defecto listo para poder leer la documentación y poder movernos fácilmente entre las diferentes gemas (y versiones). Muy útil.</p>
<img src="http://bicosyes.com/?ak_action=api_record_view&id=835&type=feed" alt="" />]]></content:encoded>
			<wfw:commentRss>http://bicosyes.com/visualizacion-de-la-documentacion-de-todas-las-gemas-instaladas/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>

