ROBODocÀº ¹®¼¸¦ Á÷Á¢ »ý¼ºÇÑ´Ù. ÀϺΠDocumentation Tooló·³ Áß°£°úÁ¤¿¡¼ ÆÄÀÏÀ» »ý¼ºÇÏ°í ´Ù½Ã ±× ÆÄÀÏÀ» ´Ù¸¥ ¹®¼Çü½ÄÀ¸·Î º¯È¯ÇÏ´Â ¹æ½ÄÀÌ ¾Æ´Ï¶ó HTMLÀ̵ç LaTexµç »ó°ü ¾øÀÌ ¼Ò½ºÄڵ忡¼ ¹Ù·Î ¹®¼¸¦ »ý¼ºÇØÁØ´Ù.
ROBODoc ¹®¼È¿¡´Â ¼¼°¡Áö ¸ðµå°¡ ÀÖ´Ù.
singledoc ¸ðµå´Â Ãâ·ÂµÇ´Â ¹®¼¸¦ ÇϳªÀÇ ÆÄÀÏ·Î ÀúÀåÇÑ´Ù. ¹Ý¸é multidocÀº ¹®¼¸¦ ¿©·¯°³ÀÇ ÀÛÀº Á¶°¢À¸·Î ³ª´©¾î ÁØ´Ù. ÀÌ ¸ðµå´Â browser·Î º¸¾Æ¾ß ÇÏ´Â HTMLÇü½ÄÀÇ ¹®¼¸¦ Ãâ·ÂÇÒ ¶§ ¸Å¿ì ÁÁ´Ù. singlefile ¸ðµå´Â µð¹ö±ë ¸ñÀûÀ¸·Î Á¸ÀçÇÑ´Ù°í Çϴµ¥ Á¤È®È÷ ¹«½¼ ¶æÀÎÁö´Â Àß ¸ð¸£°Ú´Ù.
´ÙÀ½ 4°¡ÁöÀÇ Ãâ·Â Æ÷¸ËÀ» Áö¿øÇÑ´Ù. ¿·¿¡´Â °¢°¢ÀÇ Ãâ·ÂÆ÷¸Ë¿¡ µû¸¥ ¿É¼ÇÀ» Àû¾î³õ¾Ò´Ù.
RTF, --rtf HTML, --html LaTeX, --latex XML DocBook, --dbxml |
ROBODoc¿¡ »ç¿ëµÇ´Â ¸î°¡Áö Áß¿äÇÑ ¿É¼ÇµéÀÌ´Ù.
--doc ¹®¼°¡ Ãâ·ÂµÉ path¸¦ ÁöÁ¤ÇÑ´Ù. --index master index ÆÄÀÏÀ» »ý¼ºÇØÁØ´Ù. ½ÇÁ¦·Î ÇØº¸¸é multidoc ¸ðµå¿Í ÇÔ²² ¾²¿©Áú ¶§¿¡¸¸ »ý¼ºµÈ´Ù. html ÆÄÀÏÀ» »ý¼ºÇÒ °æ¿ì masterindex.htmlÆÄÀÏÀÌ »ý¼ºµÈ´Ù. --multidoc ÇϳªÀÇ ¼Ò½º´ç ÇϳªÀÇ ¹®¼¸¦ »ý¼ºÇÑ´Ù. µð·ºÅ丮 ±¸Á¶¸¦ °èÃþ±¸Á¶·Î »ç¿ëÇÑ´Ù. --nodesc subdirectory ¸¦ Á¦¿ÜÇϰí top directory¿¡ ´ëÇØ¼¸¸ ¹®¼È¸¦ ÇÑ´Ù. --src source ÆÄÀϰú µð·ºÅ丮¸¦ ÁöÁ¤ÇÑ´Ù. |
¾Õ¼ ¼¼úÇÑ ¸ðµå,Ãâ·ÂÆ÷¸ËÀº À̸§ ±×´ë·Î ¿É¼ÇÀ¸·Î »ç¿ëÇÑ´Ù. ¿¹¸¦ µé¾î multidoc¸ðµå´Â --multidoc ¿É¼ÇÀ¸·Î ³Ö¾îÁØ´Ù.
robodoc.rcÆÄÀÏÀº robodoc»ç¿ëÀ» ÃÖÀûÈ Çϱâ À§ÇÑ ¼³Á¤ ÆÄÀÏÀÌ´Ù. robodoc.rcÆÄÀÏ¿¡´Â itemÀÇ Ãß°¡, º¯È¯ ¿É¼ÇÀÇ ÁöÁ¤µîÀÌ °¡´ÉÇÏ´Ù. ´ÙÀ½Àº manual¿¡ ³ª¿Â robodoc.rcÆÄÀÏÀÇ ¿¹ÀÌ´Ù.
robodoc.rc
items: NAME SYNOPSIS INPUTS OUTPUTS HISTORY ignore items: HISTORY BUGS options: --src ./source --doc ./doc --html --multidoc --index extensions: .bak ~ |
ÀÌ ÆÄÀÏÀ» ¼öÁ¤ÇØ ÇöÀç ÀÛ¾÷ µð·ºÅ丮¿¡ ³Ö¾îµÎ°í robodocÀ» ½ÇÇà½ÃŰ¸é µÈ´Ù.
ÀÌÁ¦ ¸¸µé¾îÁø header¸¦ ÀÌ¿ëÇÏ¿© ½ÇÁ¦ ¹®¼¸¦ »ý¼ºÇÏ´Â ¿¹¸¦ º¸µµ·Ï ÇϰڴÙ. ¾Æ·¡ÀÇ ¿¹Á¦¿¡¼´Â source µð·ºÅ丮ÀÇ »óÀ§µð·ºÅ丮¿¡¼ ½ÇÇàÇÑ °ÍÀÌ´Ù. sourceÀÇ top directory¸¦ %source%¶ó ÇϰڴÙ.
HTML·Î Ãâ·Â½Ã
#robodoc --src ./%source% --doc ./docs --multidoc --index --html
%source% ¿¡ ÀÖ´Â ¼Ò½º¸¦ ÀÌ¿ëÇÏ¿© ./docs µð·ºÅ丮¿¡ ¹®¼¸¦ »ý¼ºÇÏ°Ô µÈ´Ù. htmlÇü½ÄÀ¸·Î Ãâ·ÂÇϰí multidoc ¸ðµåÀ̹ǷΠÆÄÀÏÀ» ³ª´©°Ô µÈ´Ù. --index ¿É¼Ç¿¡ ÀÇÇØ masterindex.htmlÆÄÀÏÀ» »ý¼ºÇÑ´Ù. ÁÖÀÇÇÒ °ÍÀº --src³ª --doc ¿É¼Ç ´ÙÀ½¿¡ µð·ºÅ丮°¡ ¿Ã °æ¿ì ¹Ýµå½Ã ./ ³ª / ·Î ½ÃÀÛÇØ¾ß ÇÑ´Ù´Â °ÍÀÌ´Ù. À̸¦ ÁöŰÁö ¾ÊÀ¸¸é ¿¡·¯ ¸Þ¼¼Áö¸¦ º¸°Ô µÈ´Ù.
RTF·Î Ãâ·Â½Ã
#robodoc --src ./%source% --doc docu --singledoc --rtf --sections
rtf´Â browse ÇÒ ¼ö ÀÖ´Â ÆÄÀÏÀÌ ¾Æ´Ï¹Ç·Î --singledoc ¿É¼ÇÀ¸·Î º¯È¯ÇÑ´Ù. À§ ¸í·ÉÀÇ °á°ú·Î docu.rtf ÆÄÀÏÀÌ »ý¼ºµÈ´Ù.
LaTex·Î Ãâ·Â½Ã
#robodoc --src ./%source% --doc docu --singledoc --latex --sections
°á°ú·Î docu.texÆÄÀÏÀÌ »ý¼ºµÈ´Ù. »ý¼ºµÈ texÆÄÀÏÀ» ps,dviµîÀ¸·Î º¯È¯ÇÏ´Â °ÍÀº ´Ù¸¥ ¹®¼¸¦ Âü°íÇ϶ó. ¾ÆÁ÷ Çѱ۷δ ½ÇÇèÇØº¸Áö ¾Ê¾Ò±â ¶§¹®¿¡ ÇѱÛÀÌ Àß Ãâ·ÂµÇ´ÂÁö´Â Àå´ãÇÒ ¼ö°¡ ¾ø´Ù.