aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeil Guzman2013-12-09 16:30:22 (EST)
committerNeil Guzman2013-12-09 16:49:38 (EST)
commit3bee93f9e2b6992bde8b5c215b013929ee60c3fb (patch)
treebf0a0795af87f0608786e3ed0ed2bdafa9263c6c
parent5cd7ff25fad5b9d9dc78e821daa25d7c09208df0 (diff)
downloadorg.eclipse.linuxtools-3bee93f9e2b6992bde8b5c215b013929ee60c3fb.zip
org.eclipse.linuxtools-3bee93f9e2b6992bde8b5c215b013929ee60c3fb.tar.gz
org.eclipse.linuxtools-3bee93f9e2b6992bde8b5c215b013929ee60c3fb.tar.bz2
RPM: updated docs for Specfile Editor User Guiderefs/changes/37/19537/2
Change-Id: Ia0d8b88b7d069c2267643f8ca4a06d7b8667fa34 Signed-off-by: Neil Guzman <nguzman@redhat.com> Reviewed-on: https://git.eclipse.org/r/19537
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html30
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html1
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_hyperlinksAfter.pngbin0 -> 15901 bytes
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_patchSourceImprovement.pngbin0 -> 11806 bytes
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml3
5 files changed, 33 insertions, 1 deletions
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html
index 5bd1271..fe2c1e4 100644
--- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html
@@ -164,6 +164,36 @@
</p>
<p>
<img border="0" src="images/Specfile_rpmlint_fix_after.png"/>
+ </p>
+ <h2 id="Hyperlink_Detection">Hyperlink Detection</h2>
+ <p>A common feature in most eclipse plugins is the ability to detect hyperlinks and to provide options for the user to handle the clicking of the hyperlink.</p>
+ <p>The SpecfileEditor handles the hyperlinks, often located in the
+ <i><code>SOURCE</code></i> and
+ <i><code>PATCH</code></i> defines, differently than regular hyperlinks.
+ </p>
+ <p>As shown below you are given the options to:</p>
+ <ul>
+ <li>Open the hyperlink in a browser</li>
+ <li>Open the file if it exists within the project (hidden if it doesn't)</li>
+ <li>Download the file from the browser</li>
+ </ul>
+ <p>In addition to these, if the user also happens to hover above a macro (e.g.
+ <i><code>%{name}</code></i> or
+ <i><code>%{version}</code></i>), it would show a "Go to ..." option to jump to where the macro is defined, if located in the
+ <i><code>.spec</code></i> file.
+ </p>
+ <p>
+ <img border="0" src="images/SpecfileEditor_hyperlinksAfter.png"/>
+ </p>
+ <h4 id="Patches">Patches</h4>
+ <p>Patches are also considered hyperlinks in the SpecfileEditor. Based on the link itself, patch options could show a combination of the following options:</p>
+ <ul>
+ <li>Open the patch file in a browser if it is a URL</li>
+ <li>Create the file if it doesn't exist (or Open it if it does)</li>
+ <li>Download the file if it is a URL</li>
+ </ul>
+ <p>
+ <img border="0" src="images/SpecfileEditor_patchSourceImprovement.png"/>
</p><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html
index 7809d0b..cb14cea 100644
--- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html
@@ -25,7 +25,6 @@
<td style="width: 20%" align="right" valign="top">Installing</td>
</tr>
</table><hr/>
- <p>{{#eclipseproject:tools.linuxtools}}</p>
<h1 id="Overview">Overview</h1>
<p>The Specfile Editor Plug-in for Eclipse provides useful features to help developers manage
<i><code>.spec</code></i> files. This plug-in allows users to leverage several Eclipse GUI features in editing
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_hyperlinksAfter.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_hyperlinksAfter.png
new file mode 100644
index 0000000..43025ee
--- /dev/null
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_hyperlinksAfter.png
Binary files differ
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_patchSourceImprovement.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_patchSourceImprovement.png
new file mode 100644
index 0000000..772b864
--- /dev/null
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_patchSourceImprovement.png
Binary files differ
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml
index 714ccca..12202ee 100644
--- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml
@@ -9,6 +9,9 @@
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#rpmlint" label="rpmlint">
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Quick_Fixes" label="Quick Fixes"></topic>
</topic>
+ <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Hyperlink_Detection" label="Hyperlink Detection">
+ <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Patches" label="Patches"></topic>
+ </topic>
</topic>
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm-and-export-rpm-and-src-rpm.html" label="Import src.rpm and export rpm and src.rpm">
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm-and-export-rpm-and-src-rpm.html#Invoking_the_Eclipse_SRPM_Import_Feature" label="Invoking the Eclipse SRPM Import Feature"></topic>