developer toolbox » javascript

https://github.com/jashkenas/docco

gledao sam docco stranicu itd...

instalirao sam docco sa npm

npm install -g docco

da se instalira u globalni path...

na kraju i njega dodao u .bashrc

Jedino što me buni je što na stranici nisam naišao ni na jedan primjer, a šta se to stavlja u kod ?!???

Skontao sam da se generisanje radi po principu

docco *.js 

i to će proizvesti

/doc/html fajlove

mislim, klasično, kao i doxy što radi

Ovo je primjer, pitao sam hernada:

https://github.com/jashkenas/docco/blob/master/src/docco.coffee

da bi docco radio potrebno je imati i

• coffee-script

bringouts-MacBook:~ bringout$ npm install -g coffee-script

/Users/bringout/node/0.4.12/bin/coffee -> /Users/bringout/node/0.4.12/lib/node_modules/coffee-script/bin/coffee
/Users/bringout/node/0.4.12/bin/cake -> /Users/bringout/node/0.4.12/lib/node_modules/coffee-script/bin/cake
coffee-script@1.1.2 /Users/bringout/node/0.4.12/lib/node_modules/coffee-script

• pygments

pronašao sam na ovom linku kako se instalira pygments na macosx http://stevelorek.com/installing-pygments-on-macosx.html

uradio download: http://pypi.python.org/pypi/setuptools#files

pokrenuo

bringouts-MacBook:Downloads bringout$ sudo sh setuptools-0.6c11-py2.6.egg

Password:
Processing setuptools-0.6c11-py2.6.egg
Copying setuptools-0.6c11-py2.6.egg to /Library/Python/2.6/site-packages
Adding setuptools 0.6c11 to easy-install.pth file
Installing easy_install script to /usr/local/bin
Installing easy_install-2.6 script to /usr/local/bin

Installed /Library/Python/2.6/site-packages/setuptools-0.6c11-py2.6.egg
Processing dependencies for setuptools==0.6c11
Finished processing dependencies for setuptools==0.6c11

sada sam dobio python tool easy-install

i sada mogu instalirati pygments

bringouts-MacBook:Downloads bringout$ sudo easy_install Pygments

Searching for Pygments
Reading http://pypi.python.org/simple/Pygments/
Reading http://pygments.org/
Reading http://pygments.pocoo.org/
Best match: Pygments 1.4
Downloading http://pypi.python.org/packages/2.6/P/Pygments/Pygments-1.4-py2.6.egg#md5=306241dd68799753cdb4a2c9ce8e883a
Processing Pygments-1.4-py2.6.egg
creating /Library/Python/2.6/site-packages/Pygments-1.4-py2.6.egg
Extracting Pygments-1.4-py2.6.egg to /Library/Python/2.6/site-packages
Adding Pygments 1.4 to easy-install.pth file
Installing pygmentize script to /usr/local/bin

Installed /Library/Python/2.6/site-packages/Pygments-1.4-py2.6.egg
Processing dependencies for Pygments
Finished processing dependencies for Pygments

to bi trebalo da radi sada.

Stranica Pygments http://pygments.org/docs/installation/

Međutim ja sam gledao ove upute za MacOSX

Test¶

unutar docco aplikacionog projekta postoji src folder i u njemu primjer koji koriste i na web stranici

bringouts-MacBook:docco bringout$ cd src

bringouts-MacBook:src bringout$ ls

docco.coffee

pokrećemo konverziju:

bringouts-MacBook:src bringout$ docco docco.coffee

docco: docco.coffee -> docs/docco.html

evo ga:

bringouts-MacBook:src bringout$ ls

docco.coffee    docs

bringouts-MacBook:src bringout$ cd docs

bringouts-MacBook:docs bringout$ ls

docco.css    docco.html

i kada pokrenem docco.html dobijem ispravno dokumentovan source

testirao sam i na m3 source-u, radi, unutar js fajlova on hvata komentare

// komentar xyx

i to radi

hernad, hvala na pomoći

možemo li odmah početi publikovati html unutar repozitorija ?

mislim da to nije neki veliki utrošak prostora na github-u

možemo, ja svakako treba da radim sada malo na čišćenju kod-a i naziva funkcija itd...

jer sam recimo koristio boRemote - ono kao bring.out, a treba prešaltati na m3Remote itd...

Ko "mlad" i neiskusan, nisam znao kako će nam se proj. zvati :)

Order() -> Purchase() itd...

drži se konvencija imenovanja koji je uobičajen vezano za velika i mala slova

pogledaj u postojećoj literaturi za node development i javascript .. sigurno ćeš uhvatiti zajednički "štih"

ovo m3Remote šta je ? objekat varijabla ?

nešto mi logičnije M3Remote ali ne znam o čemu se radi

na javascript projektu otvori ticket konvencije imenovanja pa stavi tu template-ove za uobičajene situacije tako da se držimo određenih konvencija.

Saša Vranić je napisao/la:

Order() -> Purchase() itd...

misliš PurchaseOrder => SaleOrder :)

puchase je segment nabavke, a sale prodaje.

Za ovu terminologiju ti preporučujem da prosurfaš po xtuple reference guide-u. Neka to bude osnova i za knowhow terminologiju, kada pričamo o source kodu koji treba forsirati sa engleskim terminima.

hm, ma da, već evo koliko radim sa Titaniumom i js recimo konvencija je uvijek za bilo koju funkciju ili metodu da počinje sa malim slovima, recimo

setParams()

setRemoteData()

itd...

a objekti su negdje ovako, negdje onako

recimo negdje Ti.App.Filesystem, a negdje Ti.App.properties, ali to je sigurno već njihova fula

a namespace je uvijek sa velikim slovima

Ti.App = {}

itd...

docco html čitvljiv¶

vsasa je objavio ovo:

https://github.com/knowhow/M3_knowhow/tree/master/docs

ali to vidimo kao html source kod. github međutim omogućava da mi hostiramo ovakve stvari nekako ... sa github vako nako ... upravo tako je publikovan source samog docco-a

mislim da je ta opcija svima dostupna.

De vidi kako to hoda.

prema ovome: http://jashkenas.github.com/docco/

mi možemo pripremiti

http://knowhow.github.com/M3/

kako ne znam ali sve kaže da možemo. Iz ovog se očigledno rađa novi ticket na git/github projektu :)

aaaa, preduhitrio si me, sad sam objavio tu info http://redmine.bring.out.ba/issues/24493#note-17

gledam docco project, to je ovo https://github.com/jashkenas/docco

a onda postoji link ispod http://jashkenas.github.com/docco/ to je web page

e sada da vidim kakve su šanse i mogućnosti

a ha, svaki github repos može biti i webpage

http://blog.envylabs.com/2009/08/publishing-a-blog-with-github-pages-and-jekyll/

evo info sa github-a

http://pages.github.com/

imamo mogućnost dodavnja stranica po

• username : http://username.github.com
• project : http://username.github.com/project

u drugoj varijanti se mora praviti branch gh-pages

međutim uvijek je vezan za username

što znači ako je moj username vsasa i kreiram git repos vsasa.github.com i stavim na njega index.html u root automatski dobijam page http://vsasa.github.com sa sadržajem tog index.html-a

kod projektnih stranica stvar je drugačija, tu moram dodati novi branch u projektno stablo ph-pages i u njega puširati index.html i onda imam mogućnost da dobijem

http://vsasa.github.com/M3-knowhow

sadržaj tog direktorija

A ha, evo ga testirao sam na svom testnom projektu

potrebno je neko vrijeme da se ovo aktivira

http://vsasa.github.com/TestUIControlsTitanium/

a odradio sam ovo:

 
  cd /path/to/repo-name
  git symbolic-ref HEAD refs/heads/gh-pages
  rm .git/index
  git clean -fdx
  echo "My GitHub Page" > index.html
  git add .
  git commit -a -m "First pages commit" 
  git push origin gh-pages

dobio sam info na email

[TestUIControlsTitanium] Page build successful
From :     GitHub <noreply@github.com>
Subject :     [TestUIControlsTitanium] Page build successful
To :     vsasa <sasa.vranic@bring.out.ba>

Mon, Oct 03, 2011 11:55 AM
Your page has been built. If this is the first time you've pushed, it may take a few minutes to appear, otherwise your changes should appear immediately.

ok ovo sada znamo i možemo koristiti, otvorit ću tiket vezan za ovo #24669

jedina stvar koju ja još nisam skontao kako da dobijem te simbolički povezane html fajlove sa docco-om, znači ja dobijam samo html za svaki js fajl, nemam neki index ili slično

Saša Vranić je napisao/la:

kod projektnih stranica stvar je drugačija, tu moram dodati novi branch u projektno stablo ph-pages i u njega puširati index.html i onda imam mogućnost da dobijem

gh-pages (od github)

aaa, to sam ja ofulao :)