Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

File structure/naming

Developers
olbeggaols
2004-11-22
2013-04-24
  • olbeggaols
    olbeggaols
    2004-11-22

    John (primarily),

    I know you just went through this and would probably have great reluctance to make any further changes so soon, but I forsee a problem with the AN and SN come the time when more of the suttas from these Nikayas are available. Also this is aimed towards the time when it may be desirable to integrate the suttas from ATI and elsewhere into a single what...? database...or at least searchable CD or website (of course I am thinking of my master plan for BuddhaDust).

    I am thinking that those who would offer suttas organize their file structure and file naming convention along these lines:

    -- F:\Root\dhamma-vinaya\ati
    -- F:\Root\dhamma-vinaya\pali
    -- F:\Root\dhamma-vinaya\language
    -- F:\Root\dhamma-vinaya\commentaries

    Then, the subdirectories containing the suttas would look this way (this is already largely modeled after your setup, with additions only for the AN and SN, and with provision for a source id [_bd, _ati, _german] at the end of the file name.

    This is how I am currently setting up. I am having second thoughts about naming the directories for the SN and AN as \kv...  \eights etc. as opposed to "08" so the file structure will reflect the order. I am a believer that even the file structure should be 'readable'...an aid for those who are familiarizing themselves with the structure of the Canon.

    I have one other addition, which is a volume number following the Nikaya Name abbreviation for the PTS works only [e.g. \an\ones\an01_01_001_pts.htm] because people are used to looking up things in the PTS works by volume number.

    |-- F:\Root\dhamma-vinaya\bd
    |
    |  |-- F:\Root\dhamma-vinaya\bd\an
    |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\eights (or 08?)
    |  |  |  |-- an08_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\elevens
    |  |  |  |-- an11_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\fives
    |  |  |  |-- an05_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\fours
    |  |  |  |-- an04_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\nines
    |  |  |  |-- an09_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\ones
    |  |  |  |-- an01_001-097_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\sevens
    |  |  |  |-- an07_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\sixes
    |  |  |  |-- an06_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\tens
    |  |  |  |-- an10_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\threes
    |  |  |  |-- an03_000_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\an\twos
    |  |  |  |-- an02_000_bd.htm
    |  |  |
    |  |-- F:\Root\dhamma-vinaya\bd\dn
    |  |  |-- dn_01.01_bd.htm (".01" accommodates multi-part/page/file suttas)
    |  |
    |  |-- F:\Root\dhamma-vinaya\bd\mn
    |  |  |-- mn_101_bd.htm
    |  |
    |  |-- F:\Root\dhamma-vinaya\bd\sn
    |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\sn\kv
    |  |  |  |-- sn_kv_01_001_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\sn\mv
    |  |  |  |-- sn_mv_01_001_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\sn\nv
    |  |  |  |-- sn_nv_01_001_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\sn\sagv
    |  |  |  |-- sn_sag_01_001_bd.htm
    |  |  |
    |  |  |-- F:\Root\dhamma-vinaya\bd\sn\salv
    |  |  |  |-- sn_sal_01_001_bd.htm
    |  |  |
    |  |-- F:\Root\dhamma-vinaya\bd\vp
    |    |    |    |-- vp??_??_bd.htm
    |  |

    Submitted for comments / suggestions

     
    • olbeggaols
      olbeggaols
      2004-11-22

      OK, this already needs a couple of changes. I dropped the idea of a special volume number at the front of PTS files ... too confusing; and I have used the form: 01_ones for the directory names for the AN and SN so they will appear in order yet retain some readability. I have also needed to add "_000" to the file names for the AN as there are chapters. The revised setup looks like this:

      -- F:\Root\dhamma-vinaya\ati
      -- F:\Root\dhamma-vinaya\pali
      -- F:\Root\dhamma-vinaya\language
      -- F:\Root\dhamma-vinaya\commentaries

      |-- F:\Root\dhamma-vinaya\bd
      |
      |  |-- F:\Root\dhamma-vinaya\bd\an
      |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\08_eights
      |  |  |  |-- an08_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\11_elevens
      |  |  |  |-- an11_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\05_fives
      |  |  |  |-- an05_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\04_fours
      |  |  |  |-- an04_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\09_nines
      |  |  |  |-- an09_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\01_ones
      |  |  |  |-- an01_001-097_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\07_sevens
      |  |  |  |-- an07_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\06_sixes
      |  |  |  |-- an06_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\10_tens
      |  |  |  |-- an10_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\03_threes
      |  |  |  |-- an03_000_000_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\an\02_twos
      |  |  |  |-- an02_000_000_bd.htm
      |  |  |
      |  |-- F:\Root\dhamma-vinaya\bd\dn
      |  |  |-- dn_01.01_bd.htm (".01" accommodates multi-part/page/file suttas)
      |  |
      |  |-- F:\Root\dhamma-vinaya\bd\mn
      |  |  |-- mn_101_bd.htm
      |  |
      |  |-- F:\Root\dhamma-vinaya\bd\sn
      |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\sn\03_kv
      |  |  |  |-- sn_kv_01_001_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\sn\05_mv
      |  |  |  |-- sn_mv_01_001_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\sn\02_nv
      |  |  |  |-- sn_nv_01_001_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\sn\01_sagv
      |  |  |  |-- sn_sag_01_001_bd.htm
      |  |  |
      |  |  |-- F:\Root\dhamma-vinaya\bd\sn\04_salv
      |  |  |  |-- sn_sal_01_001_bd.htm
      |  |  |
      |  |-- F:\Root\dhamma-vinaya\bd\vp
      |    |    |    |-- vp??_??_bd.htm
      |  |

       
    • Alex
      Alex
      2004-11-23

      While a well-planned common directory structure
      can be quite convenient, I strongly suggest
      focusing on sematic/meta data rather than file
      naming convensions. This can provide much
      richer information without constraining you to
      a fixed heirarchy.

      An SGML/HTML/XML/TEXT file might contain all of these references internally:

      PTS Reference SN45 page 53 volume 12 edition 3rd

      Thai Cannon Reference palm leaf 3 section 29

      Space Alien Reference Page 12, Galaxy 0as3, star 982

      Alex Scraps second napkin in underwear draw next to lamp

      Google, for example, doesn't care what it is named, nor where it is located.