Yii Framework Forum: Yii API docs in vim help file format - Yii Framework Forum

Jump to content

  • (3 Pages)
  • +
  • 1
  • 2
  • 3
  • You cannot start a new topic
  • You cannot reply to this topic

Yii API docs in vim help file format Vim users, fight for your rights now! Rate Topic: ***** 4 Votes

Poll: Yii API reference for vim (71 member(s) have cast votes)

Would Yii API manual in vim help file format be useful for you?

  1. Yes, i use vim a lot to develop yii apps (41 votes [57.75%])

    Percentage of vote: 57.75%

  2. No. Even though i use vim, i see no point in these help files (7 votes [9.86%])

    Percentage of vote: 9.86%

  3. No, i don't use vim (19 votes [26.76%])

    Percentage of vote: 26.76%

  4. What is vim? (4 votes [5.63%])

    Percentage of vote: 5.63%

Vote Guests cannot vote

#21 User is offline   RusAlex 

  • Junior Member
  • Pip
  • Yii
  • Group: Members
  • Posts: 54
  • Joined: 23-August 10

Posted 17 February 2011 - 03:32 PM

awesome plugin!!!
0

#22 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 29 March 2011 - 02:51 PM

Updated help files to Yii 1.1.7 (see top post). Have fun!
0

#23 User is offline   Muaid 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 111
  • Joined: 25-October 10
  • Location:Saudi Arabia

Posted 15 May 2011 - 12:36 PM

thanks Mike for this great vim helper

BUT unfortunately i couldn't accomplish it

i follow up with your post, and i get tags file inside ~/yiiapi/doc .. BUT << i hate this word man !! <_<

when i try to write:

:h CWe <TAB>

nothing to be completed !!

only i get <cweb.vim> and <ft-cweb-synatx>

Note: i get a lot of errors when typing:
:helptags ~/yiiap/doc/

i don't pay attention to these error like you said.

then i specify the path :
:set runtimepath+=~/yiiapi/doc/

with no succeed

is there any thing i missing here !!

0

#24 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 16 May 2011 - 02:16 AM

View PostMuaid, on 15 May 2011 - 12:36 PM, said:

Note: i get a lot of errors when typing:
:helptags ~/yiiap/doc/

i don't pay attention to these error like you said.


Hmm, it should only be about a dozen of errors. I get mine in german, but they basically only say, that there where some duplicate tags. So

1. What errors do you get?
2. Do you see a file ~/yiiapi/docs/tags? It should be around 250KB and contain a lot of meta information about the help tags.
0

#25 User is offline   Muaid 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 111
  • Joined: 25-October 10
  • Location:Saudi Arabia

Posted 16 May 2011 - 08:41 AM

all errors is a duplication problem and here is the list of the errors (just in case):

E154: Duplicate tag "CActiveRecord::primaryKey" in file /home/muaid/yiiapi/doc//CActiveRecord.txt
E154: Duplicate tag "CDbCommand::from" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::group" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::having" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::join" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::limit" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::offset" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::order" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::select" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::union" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CDbCommand::where" in file /home/muaid/yiiapi/doc//CDbCommand.txt
E154: Duplicate tag "CHttpSession::count" in file /home/muaid/yiiapi/doc//CHttpSession.txt
E154: Duplicate tag "CList::count" in file /home/muaid/yiiapi/doc//CList.txt
E154: Duplicate tag "CMap::count" in file /home/muaid/yiiapi/doc//CMap.txt
E154: Duplicate tag "CQueue::count" in file /home/muaid/yiiapi/doc//CQueue.txt
E154: Duplicate tag "CStack::count" in file /home/muaid/yiiapi/doc//CStack.txt


yes i checked for tags yesterday and the file is exactly 251.7 KB

and here is a quick snippet of the tags file :

CViewRenderer::fileExtension	CViewRenderer.txt	/*CViewRenderer::fileExtension*
CViewRenderer::filePermission	CViewRenderer.txt	/*CViewRenderer::filePermission*
CViewRenderer::generateViewFile	CViewRenderer.txt	/*CViewRenderer::generateViewFile*
CViewRenderer::getViewFile	CViewRenderer.txt	/*CViewRenderer::getViewFile*
CViewRenderer::renderFile	CViewRenderer.txt	/*CViewRenderer::renderFile*
CViewRenderer::useRuntimePath	CViewRenderer.txt	/*CViewRenderer::useRuntimePath*
CWebApplication	CWebApplication.txt	/*CWebApplication*
CWebApplication::afterControllerAction	CWebApplication.txt	/*CWebApplication::afterControllerAction*
CWebApplication::assetManager	CWebApplication.txt	/*CWebApplication::assetManager*
CWebApplication::authManager	CWebApplication.txt	/*CWebApplication::authManager*
CWebApplication::baseUrl	CWebApplication.txt	/*CWebApplication::baseUrl*


i also dbl checked my configuration file for any settings or key mapping may conflict but still no progress.

i am using gvim and also tried vim but with same the result.

thanks for help ::)
0

#26 User is offline   Muaid 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 111
  • Joined: 25-October 10
  • Location:Saudi Arabia

Posted 16 May 2011 - 10:18 AM

it works finally !!!

Mike there is tow problem with it not one :P

first one:
set runtimepath+=/path/to/yiiapi/doc


shouldn't point to doc dir directly:

/path/to/yiiapi  not /path/to/yiiapi/doc

the second is:

we shouldn't open .vimrc file to add

set runtimepath+=/path/to/yiiapi


since it is already exists in our plugin/yiiapi.vim !! so we have to edit the path in yiiapi.vim only

i am not an expert in Vim so is the above correction is correct !!

and thanks again for this great help :rolleyes:
0

#27 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 17 May 2011 - 02:23 AM

Oops, thanks for pointing that out. I've fixe the typo and made it more clear in step 3 now (either use step 3a or 3b).
0

#28 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 30 June 2011 - 02:36 AM

Updated to Version 1.1.8. See top post.
1

#29 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 28 December 2011 - 08:43 AM

Update: I've created a github project now, see top post. So if you use a plugin manager like Vundle for VIM, you now can install the plugin with a single line from your .vimrc.
0

#30 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 01 January 2012 - 06:52 AM

Updated to 1.1.9.
1

#31 User is offline   imehesz 

  • Master Member
  • PipPipPipPip
  • Yii
  • Group: Members
  • Posts: 705
  • Joined: 13-June 09
  • Location:Jacksonville, FL

Posted 02 January 2012 - 09:28 AM

View PostMike, on 01 January 2012 - 06:52 AM, said:

Updated to 1.1.9.


wow, that was quick :)

thank you!

--iM
It’s done, the great act of creation.
The maker rests. The wheel’s in motion.
-- Imre Madách

check out Yii Theme Factory at http://yii.themefactory.net
0

#32 User is offline   Seal 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 126
  • Joined: 02-February 10

Posted 02 January 2012 - 11:29 AM

Great job Mike. Thanks
Sylvester La-Tunje

Posted Image
0

#33 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 18 February 2012 - 04:28 AM

Updated to 1.1.10.
1

#34 User is offline   Farhan Ghazali 

  • Newbie
  • Yii
  • Group: Members
  • Posts: 2
  • Joined: 28-February 12

Posted 28 February 2012 - 06:59 PM

hihih
0

#35 User is offline   Autobrokar 

  • Newbie
  • Yii
  • Group: Members
  • Posts: 1
  • Joined: 13-February 12

Posted 15 March 2012 - 12:42 PM

I apologise, but this variant does not approach me. Perhaps there are still variants?
0

#36 User is offline   imehesz 

  • Master Member
  • PipPipPipPip
  • Yii
  • Group: Members
  • Posts: 705
  • Joined: 13-June 09
  • Location:Jacksonville, FL

Posted 16 March 2012 - 07:03 AM

Are these spam?

--iM
It’s done, the great act of creation.
The maker rests. The wheel’s in motion.
-- Imre Madách

check out Yii Theme Factory at http://yii.themefactory.net
0

#37 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 16 March 2012 - 07:15 AM

View PostAutobrokar, on 15 March 2012 - 12:42 PM, said:

I apologise, but this variant does not approach me. Perhaps there are still variants?


The package also contains the command i used to build the manual. If you don't like the output format, feel free to tweak it.
0

#38 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 20 June 2012 - 09:35 AM

As inherited properties and methods are not included in the help pages you have to jump through the inheritance chain, linked on top of each help file. To make this more convenient i consider listing all of them on top of the file. I'd not add the full description to not bloat the help files. But it could still be useful, as you would see the full list of properties/methods of a class. The list would also be linked to the full documentation of the parent class.

This would make the help files bigger and maybe also a bit "noisy" as a lot of base properties would always be listed. Unfortunately we can't have the "Hide inherited properties/methods" :)

So what do you think? Would you find this useful? Or do you have a better idea?
0

#39 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 18 October 2012 - 08:58 AM

Update: Created the files for Yii 1.1.11 and 1.1.12. The helpfiles now also include inherited properties and methods. They link to the class where it was defined.
0

#40 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,016
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 04 January 2013 - 04:57 AM

Updated files for Yii 1.1.13 available now: https://github.com/m...ii-api-vim/tags
0

Share this topic:


  • (3 Pages)
  • +
  • 1
  • 2
  • 3
  • You cannot start a new topic
  • You cannot reply to this topic

1 User(s) are reading this topic
0 members, 1 guests, 0 anonymous users