Program Documentation

Hello together,
I've created a program documentation over SE38 and in SE38 in works fine
(GoTo->Documentation->View). If I start the program, an info button appears
on the statusbar of the selection screen, but if I press the button a window will
popop for a second an the it disappears instantly.
Can anyone help me?

hi thomas,
These two dont have any relation bw, that status bar might be other one, kinldy chcek your code once for this message type 'S' and modify then it works properly..
reward points if helpful.....

Similar Messages

Powerpoint in Program Documentation

Does anyone know if it is possible to embed a PowerPoint slide in program documentation? I have a user that is interested in this. Thanks in advance.
Regards,
Jason

Eddy,
I have gone through the steps that Andreas first mentioned in your link. However, I am not sure where to put the code:
Insert link
transaction link
with transaction : ZSDN01 and name = test website sdn.
I am working in SE38->Change Documentation. Inserting the above code in the documentation editor doesn't work.
Any suggestions on how to make this work?
Thanks again,
Jason
Message was edited by: Jason DeLuca

Specification documents o internal and external programs documentation

I have to make some changes in the specification documents o internal and external programs documentation. I want to know i there are defined some standard conventions about the technica objects name and the requirements documentation.
We have made some formats, but we have seen change resistance=2 The problem is the amount of information required in these ne formats that we think is important and will help to reduc ambiguity and to avoid backworks but it's going to ad activities to the developers.

. Ours is bit different to what she sampled but the standardization differ from the team implementing it. You must also come out with the pattern for program "pre" and "post" documentation.
1. Before the actual coding of the program, you have to specify the estimated number of mandays needed for the analysis, coding and documentation. Don't forget to add n% for the buffer. (In our case, we use 30% buffer). Then update the form by putting on the other column the actual mandays consumed. There should not be cases that estimated < actual mandays. If problem is encountered that may cause delay, inform team lead to adjust the estimated mandays.
2. Create a form that will specifically states the unit testing made (eg. Test case, test data, how the test is perform, outcome of testing, rating: pass or fail, etc.)
3. After coding, specific program specification (eg. logic of the program, tables created, function module used, authorization checking, etc). Please be reminded to put result of "program extended syntax check" (tcode: slin) and "run time analysis" (tcode: se30) if applicable.
4. And initial code review must made also. If proper ABAP coding is incorporated and obliged by the program. If the proper naming convention that you implemented is followed by the program...so on and so forth.
hope you'll get some ideas out of it.
cheers,

Link in ABAP program documentation

Hi !
Can anybody tell me how to insert link in ABAP program documentation.
e.g. i want to insert a link 'Information on the form layout' in documentation.
When some one click on this it opens the documentation for 'Form Layout' in same window
Regards,
-Harkamal

Hello Harkamal,
I doubt about getting the documentation of the form layout thourgh link. We can get link of tcode, abap syntex, etc.
eg.
Link to tcode:
<DS:TRAN.MM03>MM03</>.
To insert link,
GO to documenation ... Insert > Link ...
select the document class from the dropdown help, give the keyword and name in the document.
regards,
Naimesh

Abap Program Documentation's Translation

Hello, everybodey.
Does anyone how can I translate a documentation of an abap program ? I can't remember ...
The meaning is for the little "i" icon that is created by choosing "go to" --> Documentation.
Thanks in advance,
Rebeka

IN 4.7 VERSION
Goto transsaction SE63
In menu, goto Utilities -> Settings
In languages tab, choose the source and target languages, then click ok.
Now, in menu, chose Translation -> R3/Enterprise -> Long texts (documentation)
In the next screen find and double click the "RE" object type.
In next screen, in the object name: fill your report name. Then click edit.
Make your translation and "Save Active".
IN SAP 4.6C
Goto transsaction SE63
In menu, goto Utilities -> Settings
In languages tab, choose the source and target languages, then click ok.
Now, in menu, chose Translation -> Long texts -> Other documentation -> Program documentation.
In next screen, in the object name: fill your report name. Then click edit.
Make your translation and "Save Active".
That's it.

How to add program documentation icon on selection screen

Hi All,
Please let me know how to add program documentation icon on selection screen.
Thanks
Jog

THis is pretty straight forward, in se38, enter program name, click change. Now click Go To, Documentation. Enter the documentation on this screen, save and activate, now run the program, the icon will be there.
REgards,
Rich Heilman

Reg. Translation of Program Documentation from German to English

Dear Experts,
Kindly help me in translating the Program Documentation from German to English version. I have searched the Previous Posts in Forum but still i am not able to find the right post.
Regards,
Ramesh Manoharan

Hi Ramesh,
To change the original language of an ABAP you need to copy it from the original into one development class - perhaps local - and then change the development class. When you go into edit the ABAP, you have the option of changing the original language. However, I can't find anything similar for the program documentation! As a workaround, you can use SE63 to modify the translation of the documentation for your copy.
Reddy

ABAP Program documentation -- calling web document

I would like to be able to have my ABAP Program call documentation from the Web when the user presses Shift/F1 or clicks on the Little Blue Information Icon. This is just a basic ABAP - no screen programming. I know how to call my documentation from the Web (see code below). I just don't know how to trigger it to happen. I'm sure it is simple ... can anyone help?
call function 'CALL_BROWSER'
       exporting
            url                                  = http://iww.myweb.com/myhelpdoc.htm'
       exceptions
            frontend_not_supported   = 1
            frontend_error                 = 2
            prog_not_found              = 3
            no_batch                       = 4
            unspecified_error            = 5
            others                           = 6.

I found the answer to my question ...
- Create a New Gui Status called main with Icons for help any whatever else. Call Help one INST
- In the Initialization section of your program code - set pf-status 'MAIN.
- In at selection screen section
case sscrfields-ucomm.
    when 'INST'. "User instructions
      call function 'CALL_BROWSER'
      exporting
      url = http://iww.myweb.com/myhelpdoc.htm'
      exceptions
      frontend_not_supported = 1
      frontend_error = 2
      prog_not_found = 3
      no_batch = 4
      unspecified_error = 5
      others = 6.
      clear sscrfields-ucomm.
endcase.

Program documentation(SAPScript): parameters for DSYS-Links

Dear experts,
in the documentation of ABAP programs (SAPScript-Editor) I can mark-up
so-called "DSYS/so70"-links, for example by entering the following under
"Links" in the appropriate "additional informations" - Popup:
Format : DS
Key : TRAS.SE16
Text : SE16
This results in a highlighted text "SE16" in my document which is mouse-over
sensitive in display mode, and clicking onto it leads to a direct call of transaction
SE16 (as specified in the "Key").
Does anyone know where I can find an overview of the "keys" possible there ?
I know that there must be some more. The SAP library does not offer one word
on this topic, neither does the SAP help portal and even in SDN apparently no
one ever seemed to struggle with that question.
Thanks in advance
Andreas Flügel

This is a very basic question. F1 help on statement form will do.

How to change Program Documentation ?

Hi ,
I have copied a SAP Progtram and modified it.
The SAP Programs was in Language DE and I have translated it to EN.
However,when I try to change the documentation of my Z-program,
it says 'Maintain the document in language German' and does not
allow me to make any changes in the Documentation.
Any clues ?
Thanks in advance,
Sandip.

HI
GOOD.
DO LIKE THIS
ENTER THE NAME OF THE REPORT RASIMU02 IN SE38 INITIAL SCREEN
SELECT DOCUMENTATION RADIO BUTTON
SELECT DISPLAY
IT WILL DISPLAY THE DOCUMENTATION IN ENGLISH
SELECT ALL THE THINGS AND COPY THEM
NOW
GO TO PROGRAM->COPY
GIVE YOUR Z PROGRAM NAME
CLICK ON COPY
IT WILL ASK TO SELECT THE REQUIRED CHECK BOXES
DONT SELECT ANYTHING
SELECT ON COPY
AND SAVE IT AS PER YOUR REQUIREMENT
NOT OPEN THAT Z REPORT IN CHANGE MODE
NOW
SELECT GOTO->DOCUMENTATION
IT WILL SHOW YOU ONE SCREEN WITH SOME TEXT ELEMENTS
IN THE END YOU PASTE THE DETAIL DOCUMENTATION THAT YOU COPIED.
SAVE AND ACTIVE BOTH THE DOCUMENTATION SCREEN AND PROGRAM
NOW YOU SELECT THE GOTO->DOCUMENTATION
IT WILL SHOW YOU THE DOCUMENTATION WITH THE TEXT ELEMENTS
IF YOU COME TO THE INITIAL SCREEN AND GIVE THE REPORT NAME AND SELECT THE DOCUMENTATION CHECK BOX AND DISPLAY BUTTON IT WILL DISPLAY ONLY THE DOCUMENTATION OF THAT REPORT.
I HOPE THIS WILL HELP YOU TO SOLVE YOUR PROBLEM
THANKS
MRUTYUNJAYA TRIPATHY

Change default program documentation headings

Hi,
When you create online documention for a program (SE38 > Documentation > Change), you get standard headings appearing automatically, like:
&INTEGRATION&
&PREREQUISITES&
etc.
Is it possible to change this pattern to get other headings to appear automatically? So for example creating new documentation displays:
&INTEGRATION&
&PREREQUISITES&
&ZAUTHOR&
etc.
Thanks.

Hi,
better don´t do it. I tried it once and does not work easily since there´s a function which reads what sections (the ones among &) have text for displaying it in in a help window. If you create your own &section&, this will not be read by the function.
The form for documentation is a SAPscript form and the texts are saved as standard texts:
Text Name       your programme
Language        EN
Text ID         RE   Program/module pool
Text object     DOKU       Online Documentation
Style           S_DOCUS1
Form            S_DOCU_SHOW
So, there´s much to create as Z-development. Moreover, I haven´t found a place in customizing where to assign the new form to the ABAP editor.

How to show program documentation in the dynpro?

hi everyone
i just wrote a short documentation for the abap programm and now i want to make a button in the menubar in my dynpro to show the documentation... how can i do this?

The function DSYS_SHOW_FOR_F1HELP will do the job I think - here's some sample code that should point you in the right direction:
report zlocal_jc_sdn_show_doco.
start-of-selection.
perform show_my_doco.
*&      Form show_my_doco
form show_my_doco.
* Popup doco for sy-repid
data:
    l_dokclass          like dsysh-dokclass,
    l_docu_object       like sy-repid,
    l_title             like dsyat-child_titl.
l_title       = 'Report documentation'.
l_dokclass    = 'RE'.
l_docu_object = sy-repid.
call function 'DSYS_SHOW_FOR_F1HELP'
    exporting
      dokclass         = l_dokclass
      dokname          = l_docu_object
      doktitle         = l_title
      short_text       = 'X'
      appendix         = 'X'
    exceptions
      class_unknown    = 1
      object_not_found = 2
      others           = 3.
endform.                    "show_my_doco
Jonathan

Change program documentation!

Hi,
I have copied standard program RPTBAL00 to a Z program.
Standard program has original language german. I copied it in english language.
Now when i am trying to change the documantation of Z program in EN language, i am getting error- 'Maintain the document in language German'.
Please suggest how to change/modify documantation in EN language.
Thanka!

Hi Rahul,
Refer the link below:
[SAP Language Configuration|http://www.geocities.com/SiliconValley/Grid/4858/sap/Basis/language.htm]
Regards,
Swapna.

ABAP program(SE38) documentation

Dear all,
I've save/create the abap program documentation via SE38, radiobutton "Documentation".
Right now, i need to know where does the text being stored. I did try on the STXH (FM READ_TEXT) but not success.
Please comment.
Thanks in advance.

Hi,
You can use the FM: 'RS_TOOL_ACCESS' to call the documentation in your program.
If you really want to know where the doc. is stored, you can use ST05 to find it out yourself!
Here is a helpful sample of this FM.
call function ''RS_TOOL_ACCESS'
exporting
OPERATION                 =      'DOCS'
OBJECT_NAME            =         'ZHCHTEST'
OBJECT_TYPE             =        'PROG'
Try it yourself!
Best regards!
David Hu

Need upload program for Vendor master partners (XK02)

Hello Experts,
I need to write data uplaod program for XK02 for vendor master Partner functions. ( Basically we created some custom partner functions and attach it to many existing vendors ).
So kindly advice me which is the suitable upload method for this.
1) There is no BAPI available for editing vendors.
2) BDC is not possible because the Vendor partner screen is having table control and some records are already filled. (No of row not fixed).
Is there any IDOC available or any standard input pgm?
Please give suggestion.
Thanks and rgds,
Anand

Hi,
You can use LSMW --> Vendor Master which supports bothe XK01 and XK02.
This is a standard Batch input program (RFBIKR00). Look at this program documentation for more info.
Regards
Sudhir Atluru

Program Documentation

Similar Messages

Maybe you are looking for