<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body dir="auto"><div style="-webkit-text-size-adjust: auto; ">Hi all,</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">The rst is a simple format as like as markdown. You can write your text in Japanese via UTF8.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">Sphinx can generate a PDF, HTML, ePub and man pages format.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">For the PDF, sphinx uses latex as a backend and latex can generate a document in Japanese.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">Sphinx can manage i18n it can extract the text and provides a directory for the others languages.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">About the anchors, there is no problem with sphinx and restructured text.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">I converted the original HTML file to the restructured text format with pandoc.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">After, I had to change the tables and the anchors because pandoc didn't correctly translate the tables and the anchors.</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">Please, I would like you to read two websites. </div><div style="-webkit-text-size-adjust: auto; "><a href="http://sphinx-doc.org">sphinx-doc.org</a></div><div style="-webkit-text-size-adjust: auto; ">And <span style="font-family: '.HelveticaNeueUI'; font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469); -webkit-text-size-adjust: none; "><a href="http://flask.pocoo.org/">http://flask.pocoo.org/</a></span></div><div style="-webkit-text-size-adjust: auto; "><span style="font-family: '.HelveticaNeueUI'; font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469); -webkit-text-size-adjust: none; "><br></span></div><div><font face=".HelveticaNeueUI"><span style="font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469);">The flask project uses the sphinx doc generator and</span></font></div><div><font face=".HelveticaNeueUI"><span style="font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469);">generates a PDF and HTML docs. There is a style</span></font></div><div><span style="font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469);">for the generated documentation.</span></div><div><span style="font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469);"><br></span></div><div><span style="font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469);">For the translation in Japanese, I think you can check</span></div><div><span style="font-size: 15px; line-height: 19px; white-space: nowrap; -webkit-tap-highlight-color: rgba(26, 26, 26, 0.292969); -webkit-composition-fill-color: rgba(175, 192, 227, 0.230469); -webkit-composition-frame-color: rgba(77, 128, 180, 0.230469);">this link.</span></div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; "><a href="http://sphinx-users.jp/doc10/">http://sphinx-users.jp/doc10/</a><br><br><br></div><div style="-webkit-text-size-adjust: auto; ">Best regards,</div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">Stephane </div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; "><br></div><div style="-webkit-text-size-adjust: auto; ">On 15 août 2013, at 02:39 AM, Tatsuo Ishii <<a href="mailto:ishii@postgresql.org">ishii@postgresql.org</a>> wrote:<br><br></div><blockquote type="cite" style="-webkit-text-size-adjust: auto; "><div><blockquote type="cite"><span>On 08/13, Tatsuo Ishii wrote:</span><br></blockquote><blockquote type="cite"><blockquote type="cite"><blockquote type="cite"><span>A markdown format or restructured text should be better for the documentation. Do you write the HTML file without a generator ? </span><br></blockquote></blockquote></blockquote><blockquote type="cite"><blockquote type="cite"><span></span><br></blockquote></blockquote><blockquote type="cite"><blockquote type="cite"><span>Right. Developers just don't have time to rewrite docs by using</span><br></blockquote></blockquote><blockquote type="cite"><blockquote type="cite"><span>markdown format or restructured text.</span><br></blockquote></blockquote><blockquote type="cite"><span>I converted the pgpool-en.html file in restructured text with pandoc and</span><br></blockquote><blockquote type="cite"><span>adjust some parts of the rst document. After I just created a sphinx</span><br></blockquote><blockquote type="cite"><span>doc and here is the result. This is a prototype of the documentation.</span><br></blockquote><blockquote type="cite"><span></span><br></blockquote><blockquote type="cite"><span>Please, give me your feedback </span><br></blockquote><span></span><br><span>I have briefly looked into this.</span><br><span></span><br><span>- It seems most of anchors are gone. For example:</span><br><span></span><br><span> p27 "Please refer to replicate_select as well. See also a flow</span><br><span> chart." In html file there are anchros for "replcate_select" and</span><br><span> "flow chart".</span><br><span></span><br><span>- Diagrams are gone. For example, </span><br><span></span><br><span> "20.2 Server composition</span><br><span> Figure below describes how pgpool-II and watchdog process is configured."</span><br><span></span><br><span> There's no figure in the pdf file.</span><br><span></span><br><span>BTW, Stephane kindly uploaded the rst file at: <a href="https://raw.github.com/matrixise/pgpool-doc/master/index.rst">https://raw.github.com/matrixise/pgpool-doc/master/index.rst</a></span><br><span></span><br><span>Here are some excerpt from the file. I am not familiar with rst but it</span><br><span>seems writing rst gives less pain than writing raw html.</span><br><span></span><br><span>-------------------------------------------------------------</span><br><span>####################</span><br><span>Welcome to pgpool II</span><br><span>####################</span><br><span></span><br><span>.. toctree::</span><br><span> :maxdepth: 2</span><br><span></span><br><span>What is pgpool-II?</span><br><span>==================</span><br><span></span><br><span>pgpool-II is a middle ware that sits between PostgreSQL servers and a</span><br><span>PostgreSQL database client. It provides the following features:</span><br><span></span><br><span>* Connection Pooling</span><br><span>* Replication</span><br><span>* Load Balance</span><br><span>* Limiting Exceeding Connections</span><br><span>* Parallel Query</span><br><span>-------------------------------------------------------------</span><br><span></span><br><span>What I am not sure is, the tool chain is available to Japanese and</span><br><span>Chinese as well. If not, there's 0 hope to use rst.</span><br><span></span><br><span>I think migrating from html to rst could be one of the candidates in</span><br><span>the long term in my opinion. I'd love to hear from Chinese document</span><br><span>maintainer Bambo Huang.</span><br><span>--</span><br><span>Tatsuo Ishii</span><br><span>SRA OSS, Inc. Japan</span><br><span>English: <a href="http://www.sraoss.co.jp/index_en.php">http://www.sraoss.co.jp/index_en.php</a></span><br><span>Japanese: <a href="http://www.sraoss.co.jp">http://www.sraoss.co.jp</a></span><br></div></blockquote></body></html>