CISCO Document: Formatting Guidelines for Creating Technical Publications, Lecture notes of Engineering Science and Technology

Download CISCO Document: Formatting Guidelines for Creating Technical Publications and more Lecture notes Engineering Science and Technology in PDF only on Docsity! REVIEW DRAFT—CISCO CONF IDENT IAL OL-xxxxx-xxC H A P T E R 1 Chapter 1 Revised: Month Day, Year, OL-xxxxx-xx This Is 1H_Head1 This is B1_Body1. It is the same size as cell text, which reduces the number of tags needed, and simplifies formatting tasks. Activation AK1_ActivationKey1. This paragraph tag is used to identify features that are locked and require a Cisco software license key to unlock them. The Style Team agreed to allow footnotes in text, but only for citations, not discussions or explanations.1 Note N1_Note1 can be used under body text. The icon appears automatically. If you have more than one paragraph in a note, please use a shift return between paragraphs. A line below will automatically appear at the end of the Note. • This is Bu1_Bullet1_w/Next. It is the same as Bu1_Bullet1 but with a keep with next. • This is Bu1_Bullet1. • This is Bu1_Bullet1. Note • This is N1B_Note1Bullet. It is followed by a Bu1_Bullet1. • This is Bu1_Bullet. Writers would add the bottom rule with a paragraph tag called Rule. Note • This is N1B_Note1Bullet_w/Next. It is followed by a Bu1_Bullet1. • This is Bu1_Bullet. Writers would add the bottom rule with a paragraph tag called Rule. 1. This footnote was referenced in the paragraph following the 1H_Head1 above. To insert a footnote in text, click in the text area, go to the Special menu, click on Footnote, and type the footnote. The Style Team agreed to allow footnotes in text, but only for citations, not discussions or explanations.1-1 Book Title REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 This Is 1H_Head1Note This is N1P_Note1Para. It is followed by a Bu1_Bullet1. • This is Bu1_Bullet. Writers would add the bottom rule with a paragraph tag called Rule. Note This is N1P_Note1Para_w/Next. It is followed by a Bu1_Bullet1. • This is Bu1_Bullet. Writers would add the bottom rule with a paragraph tag called Rule. • Bu1_Bullet1 B2_Body2 Note N3_Note3 can be used as a BulletNote. – Bu2_Bullet2 Note N4_Note4 can be used as a Note to Bu2_Bullet2. B3_Body3 This Is 2H_Head2 This is B1_Body1. This is BL_BlockLabel. It is used for non-heirarchical block labels. The above label, BL_BlockLabel is non-heirarchical. It is used to label a block of text without interrupting the heirarchical heads, and can be used under any level of head, but should not immediately follow a heirarchical head. This Is 3H_Head3 This is B1_Body1. This Is 4H_Head4 This is B1_Body1. Q. This is Question. A. This is Answer. Problem This is Problem. Solution This is Solution.1-2 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Description of Step Lists and Num ListsSsB_StepsubBody. SsBuB_StepsubBulletBody. B1_Body1 1. NF_NumFirst should not be used as a step. Notice that the numbers right align to the decimal point, and there is room for double-digit numbers. This is B2_Body2. This is Ex2_Example2. Use this para. tag for numbered list or step sublist Examples. This is Ex2_Example2 with an arrow indicator (Arrow4.tif, Anchored Frame Anchoring Position=Outside Text Frame). Examples lines should not wrap beyond one line of text. Place an extra return at the end of Examples. This is B2_Body2. 2. NN_NumNext should not be used as a step. This is B2_Body2. Note N3_Note3 can be used under a numbered list. 3. NN_NumNext a. NsF_NumsubFirst This is B3_Body3. This is Ex3_Example3. Use this para. tag for numbered sublist Examples. This is Ex3_Example3 with an arrow indicator (Arrow4.tif, Anchored Frame Anchoring Position=Outside Text Frame). Examples lines should not wrap beyond one line of text. Place an extra return at the end of the Examples. b. NsN_NumsubNext Below is a numbering scheme to express enumeration values for an xml schema, which always start with zero. 0. This is NF0_NumFirstZero. 1. This is NN_NumNext. Use with NF0_NumFirstZero and NF_NumFirst. Below is a series of steps that ends with a note. Step 1 Action for step 1. Step 2 Action for step 2. Step 3 Action for step 3.1-5 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Description of Graphic IconsNote This Note is related to step 3. This Note is related to step 3. This Note is related to step 3. This Note is related to step 3. The double line above occurs when a series of steps has ended with a note (or any icon-related text, such as caution, tip, or timesaver.). Step 1 This is SF_StepFirst. Step 1 This is SF_StepFirst_w/Next a. This is NsF_NumsubFirst a. This is NsF_NumsubFirst_w/Next Description of Graphic Icons All icons will appear automatically, as they are attached to the paragraph tags. There are two special cases of formatting required: with translated warnings, and with tip bullets. Warning This is Warn. Text is specially emphasized. The icon and lines appear automatically, and are resident on the reference page. A list of translated warnings are formatted slightly differently than English language warnings. The next three warnings, formatted in a standard table F, would be typical of a translated list, with the first warning in English using the Warn paragraph tag and WarnTransTextFirst. It is followed by each translation; the translated warning word in the left column uses the WarnTrans para. tag, and the translated warning text in the right column uses the WarnTransText para. tag. The last translated warning text uses WarnTransTextLast. Warning This warning paragraph tag (WarnNonsafety) should only be used for EMC and Telecom warnings. The following formats have automatic text, icons, and lines above and below. Caution This is Cautn. The icon and lines appear automatically, and are resident on the reference page. Warning Do not work on the system or connect or disconnect cables during periods of lightning activity. Attention Ne pas travailler sur le système ni brancher ou débrancher les câbles pendant un orage.1-6 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Captions with ExamplesThis is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. Timesaver This is Timesave. The icon and lines appear automatically, and are resident on the reference page. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. Tip This is Tip. The icon and lines appear automatically, and are resident on the reference page. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. Tip • This is TipBullet. It is followed by a Bu1_Bullet1. • This is Bu1_Bullet. • This is Bu1_Bullet. Writers would add the bottom rule with a new paragraph tag called Rule. Tip This is TipPara. It is followed by a Bu1_Bullet1. • This is Bu1_Bullet. • This is Bu1_Bullet. Writers would add the bottom rule with a new paragraph tag called Rule. Captions with Examples Example 1-1 ExC_ExampleCap This is Ex1_Example1. For new Example text that must be indented, use n/b space chars. for indentations. For new Example text that must be indented, use n/b space chars. for indentations. Examples lines should not wrap beyond one line of text. Place an extra return at the end of Examples. Example 1-2 ExCW_ExampleCapW This is ExW1_ExampleWide1. For new Example text that must be indented, use non-breaking space characters for the indentations. For new Example text that must be indented, use non-breaking space characters for the indentations. Examples lines should not wrap beyond one line of text. Place an extra return at the end of Examples.1-7 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Table Formats with Samples of Cell Paragraph TagsThe following shows table C. It has no caption, and no lines. 2. This is TF_TableFootnote. This is TF_TableFootnote. This is TF_TableFootnote. This is B1_Body1 in a table C, anchored to a blank Anchor para. line. This is B1_Body1 in a table C, anchored to a blank Anchor para. line. This is B1_Body1. • This is Bu1_Bullet1. This is Bu1_Bullet1. • This is Bu1_Bullet1. This is Bu1_Bullet1. This is B1_Body1. • This is Bu1_Bullet1. This is Bu1_Bullet1. • This is Bu1_Bullet1. This is Bu1_Bullet1. Table 1-1 This is TC_TableCap in a Table D with a Table Continuation variable following. This is CH1_CellHead1 This is CH1_CellHead1 This is CH1_CellHead1 This table includes a table title within the table, and is anchored to a blank Anchor para. line. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. Table 1-2 This is a TCW_TableCapW in a Table E with a Table Continuation variable following. This is CH1_CellHead1 This is CH1_CellHead1 This is CH1_CellHead1 This table includes a table title within the table, and is anchored to a blank Anchor para. line. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. This is B1_Body1. Table 1-3, Part 1 This is an optional TCF_TableCapPartFirst. It can be used in a table that contains a table title. Table 1-3, Part 2 This is an optional TCN_TableCapPartNext. It can be used in a table that contains a table title. Table 1-4, Part 1 This is an optional TCWF_TableCapWPartFirst. It can be used in a table that contains a table title.1-10 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Step TablesStep Tables The following shows table format STEP. All steps which are used in tables are to be formatted in this table, or in the wide version. Writers may copy a preformatted STEP table from the reference page. Please do not insert a new table, as there are custom table settings applied to STEP tables. There should be a reason for putting steps into tables, such as needing to describe a Step with a Command and its Purpose or Description. There are examples included in this table to show you what formats can be used in a table. Do not use Step* paragraph tags in STEP tables. The following shows table format STEPWIDE. All steps which are used in tables are to be formatted this way. Writers may copy a preformatted STEPWIDE table from the reference page. Please do not insert a new table, as there are custom table settings applied to STEPWIDE tables. There should be a reason for putting steps into tables, such as needing to describe a Step with a Command and its Purpose or Description. Please see the table above for examples showing what formats can be used in a table. Do not use Step* paragraph tags in STEPWIDE tables. Table 1-4, Part 2 This is an optional TCWN_TableCapWPartNext. It can be used in a table that contains a table title. Command (CH1_CellHead1) Purpose (CH1_CellHead1) Step 1 CSF_CellStepFirst for “Step 1”. This is B1_Body1. The numbered Steps reside in their own column, which hangs into the sidehead column, and aligns with the main body steps.1 This is B1_Body1. • This is Bu1_Bullet1. Step 2 CSN_CellStepNext increments the step numbers. This is B1_Body1. This is B1_Body1. This is B1_Body1. Step 3 This is B1_Body1. • This is Bu1_Bullet1. – This is Bu2_Bullet2. This is B1_Body1. This is ExT_ExampleTable. It will automatically wrap in the table cell on HTML output. This is B1_Body1. 1. NF_NumFirst B2_Body2 2. NN_NumNext 1. Command (CH1_CellHead1) Description (CH1_CellHead1) Step 1 This is B1_Body1 with B_Bold applied. The numbered steps reside in their own column, in a table format called STEPWIDE.1 Step 2 This is B1_Body1 with B_Bold applied. This is B1_Body1.21-11 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Step TablesThe following shows table format STEPWIDE with a figure inside a table cell. All figures which are paired with steps are to be formatted this way. The step and the explanation should stay together, with the figures appearing in the right column. Note that the figure within the table cell is attached to an Anchor paragraph. Use this example for formatting. Figures could also be used in a table format B without steps, with the figures in the right column. Use this example for formatting. 1. TFi_TableFootnoteIndent. 2. TFi_TableFootnoteIndent. To do this Use this display Step 1 Action performed for step 1. • The anchored frame is attached to an Anchor paragraph. • The illustration is aligned Top and Left Sides inside the anchored frame. • Pull the bottom of the anchored frame down .25’ from the bottom of the illustration. • A figure in a table should not have a figure caption. Step 2 Action performed for step 2. This is B1_Body1. CellHead1 CellHead1 If this type of table were used, an Anchor paragraph is placed at the top of this cell, to align the text with the figure. This type of table would not contain steps. If this type of table were used, an Anchor paragraph is placed at the top of this cell, to align the text with the figure.1-12 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 Error MessagesError Message EM_ErrMsg error message error message error message error message error message error message error message Explanation EE_ErrExp Explanation explanation explanation explanation explanation explanation explanation explanation explanation explanation 1. This is NF2_NumFirst2 2. This is NF2_NumNext2 1. This is NF2_NumFirst2_w/Next 2. This is NF2_NumNext2 Recommended Action EA_ErrAct error action error action error action error action error action error action error action error action error action error action error action Symptom Sy_Symptom symptom symptom symptom symptom symptom symptom symptom symptom symptom symptom symptom symptom symptom Possible Cause SyC_SymptomCaus symptom cause symptom cause symptom cause symptom cause symptom cause symptom cause symptom cause symptom cause symptom cause Recommended Action EA_ErrAct error action error action error action error action error action error action error action error action error action error action error action This is Comment. It is used for editorial comments during draft stages, and should be removed before production. On color monitors, it appears as red text.1-15 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 accept dialin (CRC_CmdRefCommand)accept dialin (CRC_CmdRefCommand) This command reference format is to be used for all new IOS command documentation. The head above is CRC_CmdRefCommand, and will always start at the top of the page. It also appears in the headers. There are 3 tables on the following pages. The Syntax Description is shown in a table format CMDREF_SYNTAX. Both the Command History and the Related Commands are shown in a table format CMDREF. Each section below has a unique name and are all formatted as side heads. The three tables are anchored to the side heads. CE_CmdEnv. deny tcp source source-wildcard [operator port [port]] destination destination-wildcard [operator port [port]] [established] [precedence precedence] [tos tos] [log] Syntax Description load-interval seconds Length of time (in 30-second increments) during which the average trigger-threshold and teardown threshold are calculated before an SVC setup or teardown action is taken. (These thresholds are configured in the ip nhrp trigger-svc command.) The load-interval range is 30 seconds to 300 seconds, in 30-second increments. The default value is 30 seconds. l2f | l2tp | any (Optional) Indicates which Layer 2 tunnel protocol to use for a dialin tunnel. • l2f—Layer 2 forwarding protocol. • l2tp—Layer 2 tunnel protocol. • any—VPDN will use autodetect to determine which tunnel type to use, either l2f or l2tp. virtual-template number The virtual template interface that the new virtual access interface cloned from. remote-peer-name (Optional) Case-sensitive name that the remote peer will use for identification and tunnel authentication. load-interval seconds Length of time (in 30-second increments) during which the average trigger-threshold and teardown threshold are calculated before an SVC setup or teardown action is taken. (These thresholds are configured in the ip nhrp trigger-svc command.) The load-interval range is 30 seconds to 300 seconds, in 30-second increments. The default value is 30 seconds. l2f | l2tp | any (Optional) Indicates which Layer 2 tunnel protocol to use for a dialin tunnel. • l2f—Layer 2 forwarding protocol. • l2tp—Layer 2 tunnel protocol. • any—VPDN will use autodetect to determine which tunnel type to use, either l2f or l2tp. virtual-template number The virtual template interface that the new virtual access interface cloned from. remote-peer-name (Optional) Case-sensitive name that the remote peer will use for identification and tunnel authentication. load-interval seconds Length of time (in 30-second increments) during which the average trigger-threshold and teardown threshold are calculated before an SVC setup or teardown action is taken. (These thresholds are configured in the ip nhrp trigger-svc command.) The load-interval range is 30 seconds to 300 seconds, in 30-second increments. The default value is 30 seconds.1-16 Book Title OL-xxxxx-xx REVIEW DRAFT—CISCO CONF IDENT IAL Chapter 1 Chapter 1 accept dialin (CRC_CmdRefCommand)Defaults load-interval: 30 seconds. B1_Body1 with B_Bold character tags applied. update-rate: 30-seconds. B1_Body1 with B_Bold character tags applied. Command Default load-interval: 30 seconds. B1_Body1 with B_Bold character tags applied. update-rate: 30-seconds. B1_Body1 with B_Bold character tags applied. Command Modes Global configuration. Supported User Roles Administrator Command Types Use the following command syntax to enable a default VPDN group configuration: accept dialin l2tp virtual-template 1 Typically, you need one VPDN group for each LAC. For an LNS that services many LACs, the configuration can become cumbersome; however, you can use the default VPDN group configuration if all the LACs will share the same tunnel attributes. Note The vpdn group command must be configured with the accept dialin or request dialin command to be functional. The requester initiates a dial in tunnel. The acceptor accepts a request for a dial in tunnel. Command History l2f | l2tp | any (Optional) Indicates which Layer 2 tunnel protocol to use for a dialin tunnel. • l2f—Layer 2 forwarding protocol. • l2tp—Layer 2 tunnel protocol. • any—VPDN will use autodetect to determine which tunnel type to use, either l2f or l2tp. virtual-template number The virtual template interface that the new virtual access interface cloned from. remote-peer-name (Optional) Case-sensitive name that the remote peer will use for identification and tunnel authentication. Release Modification 10.0 This command was first introduced. 11.3(3)T The log keyword was added1-17 Book Title OL-xxxxx-xx